Get an API Package Image Status

Retrieves the image status of an API package. 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

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

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

get/api-packages/{packageId}/images/{imageType}
 
application/json

Delete an API Package Image

Delete an API Package Image.

delete

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

Response

API Package Image was deleted successfully.

delete/api-packages/{packageId}/images/{imageType}
 

Get an API Package Raw Image

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

get

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

Response

Redirect to the image URL.

get/api-packages/{packageId}/images/{imageType}/raw
 

ImageDataUri

One Of
Example

ImageTypeSchema

string

The type of the image.

Allowed values:icon

Example