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).

get
/api/v3/apis/{apiIdOrSlug}/applications

Query Parameters

unregisteredboolean

Return applications that do not have a registration for the API (regardless of registration status).

applicationfilterobject

Filters Applications to retrieve.

Show Child Parameters
page[size]integer

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

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

Paginated list of applications either registered or not registered for an API

ApiListApplicationsPage

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
application/json

API Docs

Endpoints for viewing API documentation published to the portal.

List API Specs

DEPRECATED

Returns the API specification documents (OpenAPI or AsyncAPI) attached to the API.

get
/api/v3/apis/{apiIdOrSlug}/specifications

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

List of API specification documents.

* Additional properties are NOT allowed.
dataarray[object]required

Info about an API specification document.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
application/json

Get API Spec

DEPRECATED

Returns an API specification document (OpenAPI or AsyncAPI) for an API.

get
/api/v3/apis/{apiIdOrSlug}/specifications/{specId}

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

specIdstring(uuid)required

Contains a unique identifier for this resource.

Response

application/json

API specification document.

ApiSpecDocument

API specification document.

api_typestringrequired

The type of specification being stored. This allows us to render the specification correctly.

Allowed values:oas2oas3asyncapi

Example:oas3

contentstringrequired
application/json

Get Raw API Spec

DEPRECATED

Returns an API specification content (OpenAPI or AsyncAPI) for an API.

get
/api/v3/apis/{apiIdOrSlug}/specifications/{specId}/raw

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

specIdstring(uuid)required

Contains a unique identifier for this resource.

Response

application/json

API specification content.

string
application/json