ImageTypeSchema
stringThe type of the image.
Allowed values:icon
Replace Image Payload
objectOne 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==
API
objectThe API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The name of your API. The name + version combination must be unique for each API you publish.
>= 1 characters<= 255 characters
Example:MyAPI
A description of your API. Will be visible on your live Portal.
An optional version for your API. Leave this empty if your API is unversioned.
>= 1 characters<= 255 characters
Show Child Parameters
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Match pattern:^[\w-]+$
Example:my-api-v1
The id of the API specification.
Example:123e4567-e89b-12d3-a456-426614174000
The list of portals which this API is published to.
Show Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement
A set of attributes that describe the API
Default:{}
Example:{"env":["production"],"domains":["web","mobile"]}
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
Example:{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}}
Show Child Parameters
Image Status
objectAn error related to the image invalid status.
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
ApiComputedSchema
objectThe API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The number of validation messages for the API specification attached to the API. If there are no validation messages, the value will be 0, or if there are no API specifications, the value will be 0.
Example:1