List API Versions

Returns a list of versions for an API. The version can be of type OpenAPI or AsyncAPI.
Note: You can only have one version for an API.

get

Query 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

filterobject

Filters API Version in the response.

Show Child Parameters
sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

Response

application/json

List of API specifications (OpenAPI or AsyncAPI)

ListApiSpecResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]requiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
get/apis/{apiId}/versions
 
application/json

Get an API Version

Fetches the version (OpenAPI or AsyncAPI) of an API.

get

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

versionIdstring(uuid)required

The API version identifier

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

Response

application/json

API version (OpenAPI or AsyncAPI)

API Version

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

The API version identifier.

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

versionstringrequired

The version of the api.

Example:1.0.0

specobject
* Additional properties are NOT allowed.
Show Child Parameters
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}/versions/{versionId}
 
application/json

Update API Version

Updates the version (OpenAPI or AsyncAPI) of an API.

patch

Query Parameters

forcestring

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

apiIdstring(uuid)required

The UUID API identifier

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

versionIdstring(uuid)required

The API version identifier

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

Body

application/json

API Version

* Additional properties are NOT allowed.
versionstring

The version of the api.

Example:1.0.0

specobject
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

API version (OpenAPI or AsyncAPI)

API Version

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

The API version identifier.

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

versionstringrequired

The version of the api.

Example:1.0.0

specobject
* Additional properties are NOT allowed.
Show Child Parameters
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}/versions/{versionId}

Body

{ "version": "1.0.1", "spec": { "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

Create or Replace an API Image

Create or Replace an API Image. The replacement image is not applied to the API until asynchronous validation completes successfully.

put

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

imageTypestringrequired

The type of the image.

Allowed values:icon

Example:icon

Body

application/json

Request body to upload an image base64 dataURI for API.

Replace Image Payload

* Additional properties are NOT allowed.
dataOne Of
required

Example:data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA

ImagePNGDataUristring(uri)

must be a data URL with base64 PNG image data, e.g., data:image/png;base64,<BASE64_IMAGE_DATA>

Match pattern:^data:image/png(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Example:data:image/png,YW5faW1hZ2VfZmlsZQ==

Response

application/json

ApiImageResponse

Image Status

* Additional properties are NOT allowed.
errorstring | nullrequiredread-only

An error related to the image invalid status.

Example:null

statusstringrequiredread-only

The status of the image.

Allowed values:uploadingvalidatingvalidinvalid

Example:valid

api_idstring(uuid)requiredread-only

The API identifier which the image belongs to.

Example:123e4567-e89b-12d3-a456-426614174000

image_typestringrequiredread-only

The type of the image.

Allowed values:icon

Example:icon

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}/images/{imageType}

Body

{ "data": "data:image/png,YW5faW1hZ2VfZmlsZQ==" }
 
application/json

Get an API Image Status

Retrieves the image status of an API. Returns the latest image if it has not yet been applied (status: uploading, validating, or invalid), otherwise returns the currently applied image (status: valid).

get

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

imageTypestringrequired

The type of the image.

Allowed values:icon

Example:icon

Response

application/json

ApiImageResponse

Image Status

* Additional properties are NOT allowed.
errorstring | nullrequiredread-only

An error related to the image invalid status.

Example:null

statusstringrequiredread-only

The status of the image.

Allowed values:uploadingvalidatingvalidinvalid

Example:valid

api_idstring(uuid)requiredread-only

The API identifier which the image belongs to.

Example:123e4567-e89b-12d3-a456-426614174000

image_typestringrequiredread-only

The type of the image.

Allowed values:icon

Example:icon

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}/images/{imageType}
 
application/json