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

List API Versions

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

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

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 version specification documents.

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

Summary of an API version.

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
application/json

Get API Version Spec

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

get
/api/v3/apis/{apiIdOrSlug}/versions/{versionId}

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

versionIdstring(uuid)required

Contains a unique identifier for this resource.

Response

application/json

API version specification document.

ApiVersion

Singular version of an API

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

versionstringrequired

The version string of the API version .

Example:v1.0.0

specobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
application/json