Rate Limiting configuration

object

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
limitintegerrequired

The amount of requests allowed for each operation within the specified duration.

>= 0

durationstringrequired

The timeframe to ensure that an application does not exceed the request limit.

Allowed values:secondsminuteshours

Example

Image Status

object
* Additional properties are NOT allowed.
errorstringrequiredread-only

An error related to the image invalid status.

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

Example

ApiRegistrationsListResponse

object

The response for a list of API registrations.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

An API registration.

* Additional properties are NOT allowed.
Show Child Parameters
Example

ApiRegistration

object

An API registration.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

statusstringrequired

Allowed values:approvedpendingrejectedrevoked

portalobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
applicationobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

UuidFieldFilter

object

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example