List API Applications
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).
Query Parameters
Return applications that do not have a registration for the API (regardless of registration status).
Filters Applications to retrieve.
Show Child Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
Paginated list of applications either registered or not registered for an API
ApiListApplicationsPage
returns the pagination information
Show Child Parameters
Show Child Parameters
API Docs
Endpoints for viewing API documentation published to the portal.
List API Specs
DEPRECATEDReturns the API specification documents (OpenAPI or AsyncAPI) attached to the API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
List of API specification documents.
Info about an API specification document.
Show Child Parameters
returns the pagination information
Show Child Parameters
Get API Spec
DEPRECATEDReturns an API specification document (OpenAPI or AsyncAPI) for an API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Contains a unique identifier for this resource.
Response
application/json
Response
API specification document.
ApiSpecDocument
API specification document.
The type of specification being stored. This allows us to render the specification correctly.
Allowed values:oas2oas3asyncapi
Example:oas3
Get Raw API Spec
DEPRECATEDReturns an API specification content (OpenAPI or AsyncAPI) for an API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Contains a unique identifier for this resource.
Response
application/json
Response
API specification content.