v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB

API Image

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

Request body

Example request

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

Response

ApiImageResponse

errorstring nullable required

An error related to the image invalid status.

status'uploading' | 'validating' | 'valid' | 'invalid' required

The status of the image.

api_idstring uuid required

The API identifier which the image belongs to.

image_type'icon' required

The type of the image.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "status": "valid",
  "api_id": "123e4567-e89b-12d3-a456-426614174000",
  "image_type": "icon",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}