Resource Configuration

object

Object containing information about a resource configuration.

idstring(uuid)requiredread-only

Example:9678f205-49a1-47bb-82d9-d01cafa42a0d

qualifierstringrequired

Enumeration of configuration qualifiers available for organization-wide configuration.

Allowed values:data-plane-group-idle-timeout-minutesauto-pilot-base-rps-max-value

valueintegerrequired

The value of this resource configuration.

Example:45

Example

Default Resource Configuration

object

Object containing information about a default resource configurations, and any organizational overrides.

idstring(uuid)requiredread-only

Example:cc504063-f3bb-4e09-8e32-bbcdbc5cd618

qualifierstringrequired

Enumeration of configuration qualifiers available for organization-wide configuration.

Allowed values:data-plane-group-idle-timeout-minutesauto-pilot-base-rps-max-value

namestringrequiredread-only

The human-readable name of this resource configuration.

Example:Data Plane Group Idle Timeout Minutes

descriptionstringrequiredread-only

A more verbose description of what this resource configuration enforces.

Example:The number of minutes that a data plane group can be idle before it is automatically scaled down to zero instances.

valueintegerrequired

The value of this resource configuration.

Example:45

overridesarray[object]required

Object containing information about a resource configuration.

Show Child Parameters
created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of default resource configuration creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of default resource configuration update date.

Example:2022-11-04T20:10:06.927Z

Example

PageMeta

object

Contains pagination query parameters and the total number of objects returned.

numbernumberrequired

Example:1

sizenumberrequired

Example:10

totalnumberrequired

Example:100

Example

PaginatedMeta

object

returns the pagination information

pageobjectrequired

Contains pagination query parameters and the total number of objects returned.

Show Child Parameters
Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example