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.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The type of the image.
Allowed values:icon
Example:icon
Body
application/json
Body
Request body to upload an image base64 dataURI for API.
Replace Image Payload
One OfExample:data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA
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
Response
ApiImageResponse
Image Status
An error related to the image invalid status.
Example:null
The status of the image.
Allowed values:uploadingvalidatingvalidinvalid
Example:valid
The API identifier which the image belongs to.
Example:123e4567-e89b-12d3-a456-426614174000
The type of the image.
Allowed values:icon
Example:icon
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 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).
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The type of the image.
Allowed values:icon
Example:icon
Response
application/json
Response
ApiImageResponse
Image Status
An error related to the image invalid status.
Example:null
The status of the image.
Allowed values:uploadingvalidatingvalidinvalid
Example:valid
The API identifier which the image belongs to.
Example:123e4567-e89b-12d3-a456-426614174000
The type of the image.
Allowed values:icon
Example:icon
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
Delete an API Image
Delete an API Image.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The type of the image.
Allowed values:icon
Example:icon
Response
Response
API Image was deleted successfully.
Authentication
Path Parameters
Get an API Raw Image
Retrieves the raw image of an API. Only the currently applied image (status: valid) can be retrieved.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The type of the image.
Allowed values:icon
Example:icon
Response
Response
Redirect to the image URL.
Authentication
Path Parameters
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.
Path Parameters
The type of the image.
Allowed values:icon
Example:icon
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
Request body to upload an image base64 dataURI for API.
Replace Image Payload
One OfExample:data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA
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
Response
ApiPackageImageResponse
Image Status
An error related to the image invalid status.
Example:null
The status of the image.
Allowed values:uploadingvalidatingvalidinvalid
Example:valid
The API identifier which the image belongs to.
Example:123e4567-e89b-12d3-a456-426614174000
The type of the image.
Allowed values:icon
Example:icon
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