Get an API Version
Fetches the version (OpenAPI or AsyncAPI) of an API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API version identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
API version (OpenAPI or AsyncAPI)
API Version
The API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of the api.
Example:1.0.0
Show Child Parameters
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 Version
Updates the version (OpenAPI or AsyncAPI) of an API.
Query Parameters
If true, allows operations to be removed from the current version when using access control enforcement.
If false, operations removal will be rejected with a 409 error.
Omitting the value (i.e., setting ?force) means true.
Allowed values:truefalse
Default:false
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API version identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
API Version
The version of the api.
Example:1.0.0
Show Child Parameters
Response
application/json
Response
API version (OpenAPI or AsyncAPI)
API Version
The API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of the api.
Example:1.0.0
Show Child Parameters
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
Query Parameters
Body
Delete API Version
Deletes the version (OpenAPI or AsyncAPI) of an API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API version identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
API Version was deleted successfully.
Authentication
Path Parameters
Update API package current specification
Updates the current specification of an API package.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
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
Get the API package current specification
Fetches the current specification of an API Package.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
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