Get API Specification

DEPRECATED

Fetches the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.

get

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

specIdstring(uuid)required

The API specification identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

API specification (OpenAPI or AsyncAPI)

API Specification

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

The API specification identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

contentstringrequired

The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).

Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}

validation_messagesarray[object]requiredread-only

The errors that occurred while parsing the API specification.

* Additional properties are NOT allowed.
Show Child Parameters
typestringrequired

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

Allowed values:oas2oas3asyncapi

Example:oas3

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/apis/{apiId}/specifications/{specId}
 
application/json

Update API Specification

DEPRECATED

Updates the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.

patch

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

specIdstring(uuid)required

The API specification identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

API Specification

* Additional properties are NOT allowed.
contentstring

The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).

Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}

typestring

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

Allowed values:oas2oas3asyncapi

Example:oas3

Response

application/json

API specification (OpenAPI or AsyncAPI)

API Specification

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

The API specification identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

contentstringrequired

The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).

Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}

validation_messagesarray[object]requiredread-only

The errors that occurred while parsing the API specification.

* Additional properties are NOT allowed.
Show Child Parameters
typestringrequired

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

Allowed values:oas2oas3asyncapi

Example:oas3

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/apis/{apiId}/specifications/{specId}

Body

{ "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.1\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}" }
 
application/json

Delete API Specification

DEPRECATED

Deletes the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.

delete

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

specIdstring(uuid)required

The API specification identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

API Specification was deleted successfully.

delete/apis/{apiId}/specifications/{specId}
 

API Publication

Publish API

Publish an API to a portal.

put

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

portalIdstring(uuid)required

The Portal identifier

Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

API Publication

An API publication in a portal

* Additional properties are NOT allowed.
auto_approve_registrationsboolean

Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal’s auto_approve_applications value.

auth_strategy_idsarray | null[string](uuid)

The auth strategy the API enforces for applications in the portal.
Omitting this property means the portal’s default application auth strategy will be used.
Setting to null means the API will not require application authentication.
DCR support for application registration is currently in development.

>= 1 items<= 1 items

visibilitystring

The visibility of the API in the portal.
Public API publications do not require authentication to view and retrieve information about them.
Private API publications require authentication to retrieve information about them.

Allowed values:publicprivate

Default:private

Response

application/json

An API publication in a portal

API Publication

An API publication in a portal

* Additional properties are NOT allowed.
auto_approve_registrationsboolean

Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal’s auto_approve_applications value.

auth_strategy_idsarray | null[string](uuid)required

The auth strategy the API enforces for applications in the portal.
Omitting this property means the portal’s default application auth strategy will be used.
Setting to null means the API will not require application authentication.
DCR support for application registration is currently in development.

>= 1 items<= 1 items

visibilitystringrequired

The visibility of the API in the portal.
Public API publications do not require authentication to view and retrieve information about them.
Private API publications require authentication to retrieve information about them.

Allowed values:publicprivate

Default:private

warningsarray[string]read-only

Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/apis/{apiId}/publications/{portalId}

Body

{}
 
application/json