API docs by Redocly

Portal Registrations (3.0.1)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

N/A (this description is removed during bundling)

Registrations

The API for Konnect Portal application registrations. If the portal is public all of the described endpoints will return a 404 error

List Registrations for App

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Lists API registrations for an application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

filter[id][eq]
string
Example: filter[id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by direct equality comparison of the id property with a supplied value.

filter[id]
string
Example: filter[id]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by direct equality comparison (short-hand) of the id property with a supplied value.

filter[status][eq]
string
Enum: "approved" "pending" "rejected" "revoked"
Example: filter[status][eq]=approved

Filter by direct equality comparison of the status property with a supplied value.

filter[status]
string
Enum: "approved" "pending" "rejected" "revoked"
Example: filter[status]=approved

Filter by direct equality comparison (short-hand) of the status property with a supplied value.

filter[api_name][eq]
string
Example: filter[api_name][eq]=good service

Filter by direct equality comparison of the api_name property with a supplied value.

filter[api_name]
string
Example: filter[api_name]=good service

Filter by direct equality comparison (short-hand) of the api_name property with a supplied value.

filter[api_name][contains]
string
Example: filter[api_name][contains]=good service

Filter by contains comparison of the api_name property with a supplied substring

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Register App for API

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Registers an application for an API.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

Request Body schema: application/json

Create an application registration.

api_id
required
string <uuid>

The API id required for registration.

Responses

Request samples

Content type
application/json
{
  • "api_id": "51de7316-a84e-40be-a199-c8c021beb909"
}

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "status": "approved",
  • "api_name": "string",
  • "api_id": "51de7316-a84e-40be-a199-c8c021beb909",
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c"
}

Fetch App Registration

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Retrieves the specified API registration for an application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

registrationId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "status": "approved",
  • "api_name": "string",
  • "api_id": "51de7316-a84e-40be-a199-c8c021beb909",
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c"
}

Delete App Registration

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Unregister an application for an API.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

registrationId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}