Portal API Catalog (3.0.2)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

N/A (this description is removed during bundling)

APIs

Endpoints for viewing APIs published to the portal.

Fetch API

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

Gets the details for an existing published API.

Authorizations:

portalAccessTokenNone

path Parameters

required

ApiId (string) or ApiSlug (string)

The API identifier, either ApiId or Api Slug

Responses

Response samples

200
400
401
404

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",
"name": "Billing",
"version": "v1",
"description": "V1 API for billing functions",
"deprecated": true,
"visibility": "public",
"slug": "my-api-v1",
"public_labels": {"env": "test"
},
"auth_strategies": [{"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["string"
]
}
],
"specifications": [{"id": "7710d5c4-d902-410b-992f-18b814155b53",
"type": "oas3"
}
]
}

List APIs

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

Returns a paginated list of published APIs.

Authorizations:

portalAccessTokenNone

query Parameters

	object (ApiFilterParameters) Filters APIs in the response.
sort	string (SortQuery) Example: sort=name,created_at desc Sorts a collection of APIs. Supported sort attributes are: name version created_at updated_at
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.

Responses

Response samples

200
400
401

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"name": "Billing",
"version": "v1",
"description": "V1 API for billing functions",
"deprecated": true,
"visibility": "public",
"slug": "my-api-v1",
"public_labels": {"env": "test"
},
"auth_strategies": [{"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["string"
]
}
],
"specifications": [{"id": "7710d5c4-d902-410b-992f-18b814155b53",
"type": "oas3"
}
]
}
]
}

Fetch API Actions

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

Get a set of actions that the current developer is allowed to perform on an API.

path Parameters

required

ApiId (string) or ApiSlug (string)

The API identifier, either ApiId or Api Slug

Responses

Response samples

200
401
404
503

Content type

application/json

{"actions": {"register": false,
"view": true,
"view_documentation": true
}
}

List API Applications

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

Get applications that have a registration for a given API.
Any registration will count, regardless of status (i.e. even if it is pending, rejected, or revoked).
Use the unregistered query param to return the inverse, only including applicatons that do not have a registration (regardless of status).

path Parameters

required

ApiId (string) or ApiSlug (string)

The API identifier, either ApiId or Api Slug

query Parameters

unregistered	boolean Return applications that do not have a registration for the API (regardless of registration status).
	object (ApplicationFilterParameter) Filters Applications to retrieve.
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.

Responses

Response samples

200
400
401
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "string",
"registration_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"registration_status": "approved",
"auth_strategy": {"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["string"
]
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

API Docs

Endpoints for viewing API documentation published to the portal.

List API Specs

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

Returns the API specification documents attached to the API. Currently only OpenAPI is supported.

Authorizations:

portalAccessTokenNone

path Parameters

required

ApiId (string) or ApiSlug (string)

The API identifier, either ApiId or Api Slug

Responses

Response samples

200
400
401
404

Content type

application/json

{"data": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"api_type": "oas3"
}
],
"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
}
}

Fetch API Spec

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

Returns an API specification document for an API. Currently only OpenAPI is supported.

Authorizations:

portalAccessTokenNone

path Parameters

required	ApiId (string) or ApiSlug (string) The API identifier, either ApiId or Api Slug
specId required	string <uuid> Contains a unique identifier for this resource.

Responses

Response samples

200
401
404

Content type

application/json

{"api_type": "oas3",
"content": "string"
}

List API Docs

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

Returns a list of documents that are associated with an API. The list is paginated, and is in either a list or tree format (based on the Accept header).

Authorizations:

portalAccessTokenNone

path Parameters

required

ApiId (string) or ApiSlug (string)

The API identifier, either ApiId or Api Slug

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.

Responses

Response samples

200
400
401
404

Content type

application/json

{"data": [{"id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
"parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
"title": "Getting Started",
"slug": "getting-started",
"children": [{ }
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
}
}

Fetch API Doc

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

Returns the specified document from the API's document tree.

Authorizations:

portalAccessTokenNone

path Parameters

required	ApiId (string) or ApiSlug (string) The API identifier, either ApiId or Api Slug
required	DocumentId (string) or DocumentSlug (string) The document identifier, either DocumentId or Document Slug

header Parameters

Accept

string (DocumentFormatContentTypeEnum)

Default: application/json

Enum: "text/markdown" "application/json" "application/vnd.konnect.document-nodes+json"

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
"slug": "getting-started",
"content": "# My Kong api\n\nThis api is powered by Konnect\n",
"title": "Hello World"
}