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

Delete an API Image

Delete an API Image.

delete

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

API Image was deleted successfully.

delete/apis/{apiId}/images/{imageType}
 

Get an API Raw Image

Retrieves the raw image of an API. Only the currently applied image (status: valid) can be retrieved.

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

Redirect to the image URL.

get/apis/{apiId}/images/{imageType}/raw
 

Create or Replace an API Package Image

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

put

Path Parameters

imageTypestringrequired

The type of the image.

Allowed values:icon

Example:icon

packageIdstring(uuid)required

The UUID API Package identifier

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

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

ApiPackageImageResponse

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_package_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/api-packages/{packageId}/images/{imageType}

Body

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