Get API Specification
DEPRECATEDFetches the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API specification identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
API specification (OpenAPI or AsyncAPI)
API Specification
The API specification identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
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"}}}}}}
The errors that occurred while parsing the API specification.
Show Child Parameters
The type of specification being stored. This allows us to render the specification correctly.
Allowed values:oas2oas3asyncapi
Example:oas3
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update API Specification
DEPRECATEDUpdates the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API specification identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
API Specification
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"}}}}}}
The type of specification being stored. This allows us to render the specification correctly.
Allowed values:oas2oas3asyncapi
Example:oas3
Response
application/json
Response
API specification (OpenAPI or AsyncAPI)
API Specification
The API specification identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
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"}}}}}}
The errors that occurred while parsing the API specification.
Show Child Parameters
The type of specification being stored. This allows us to render the specification correctly.
Allowed values:oas2oas3asyncapi
Example:oas3
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete API Specification
DEPRECATEDDeletes the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API specification identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
API Specification was deleted successfully.
Authentication
Path Parameters
API Publication
Publish API
Publish an API to a portal.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The Portal identifier
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
API Publication
An API publication in a portal
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.
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
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
Response
An API publication in a portal
API Publication
An API publication in a portal
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.
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
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
Informational warnings (e.g. incompatible fields stripped for ACE). Empty if none.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z