Get a Quota

Fetches a single quota for the current organization.

get

Path Parameters

quotaIdstring(uuid)required

The id of the quota.

Example:f3704e4c-104d-4f21-998a-20d4364c893f

Response

application/json

A response containing a single organization quota.

Quota

Organization-specific quota overrides linked to a default quota.

idstring(uuid)requiredread-only

Example:f3704e4c-104d-4f21-998a-20d4364c893f

qualifierstringrequired

Identifies the kind of quota. The API may return additional qualifier values over time as new quota types are introduced.

Allowed values:scorecard_evaluation_usage_1h

Example:scorecard_evaluation_usage_1h

namestringrequired

Human-readable name of the default quota.

descriptionstringrequired

Longer description of what the quota limits.

valueintegerrequired

The value of a quota. Must be a non-negative integer. The interpretation of the value depends on the quota qualifier.

>= 0

Example:2

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

get/catalog-quotas/{quotaId}
 
application/json

Update Quota

Updates the effective limit value for an organization quota.

patch

Path Parameters

quotaIdstring(uuid)required

The id of the quota.

Example:f3704e4c-104d-4f21-998a-20d4364c893f

Body

application/json

UpdateQuota

Payload to update an organization override value.

* Additional properties are NOT allowed.
valueintegerrequired

The value of a quota. Must be a non-negative integer. The interpretation of the value depends on the quota qualifier.

>= 0

Example:2

Response

application/json

A response containing a single organization quota.

Quota

Organization-specific quota overrides linked to a default quota.

idstring(uuid)requiredread-only

Example:f3704e4c-104d-4f21-998a-20d4364c893f

qualifierstringrequired

Identifies the kind of quota. The API may return additional qualifier values over time as new quota types are introduced.

Allowed values:scorecard_evaluation_usage_1h

Example:scorecard_evaluation_usage_1h

namestringrequired

Human-readable name of the default quota.

descriptionstringrequired

Longer description of what the quota limits.

valueintegerrequired

The value of a quota. Must be a non-negative integer. The interpretation of the value depends on the quota qualifier.

>= 0

Example:2

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

patch/catalog-quotas/{quotaId}

Body

{ "value": 2 }
 
application/json

Preview API Spec

Previews the contents of an API spec as JSON or YAML string.
Specify Accept: application/json to retrieve the contents as JSON string.
Specify Accept: application/yaml to retrieve the contents as YAML string.
Defaults to JSON string format.

post

Body

application/json

PreviewCatalogServiceApiSpec

* Additional properties are NOT allowed.
providerOne Of
required

Represents the provider, or source, of an API spec

UrlApiSpecProviderobject
Show Child Parameters

Response

Response object containing raw API spec string contents

ApiSpecContentsPreview

ApiSpecContentsPreviewstring

Represents raw API spec contents in JSON format

post/api-specs/preview

Body

{ "provider": { "type": "url", "config": { "url": "https://my-company.com/api-specs/openapi.yaml" } } }
 

CreateCatalogService

object
* Additional properties are NOT allowed.
namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Match pattern:^[0-9a-z.-]+$

>= 1 characters<= 120 characters

Example:user-svc

display_namestringrequired

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstring

Optionally provide a description of the Service.

<= 2048 characters

labelsobject

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"}

custom_fieldsobject

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

Example

CatalogServiceSuggestion

object
* Additional properties are NOT allowed.
namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Example:user-svc

display_namestringrequired

The display name of the Service.

Example:User Service

descriptionstring

Optionally provide a description of the Service.

labelsobject

Labels to facilitate grouping and tagged search.
Resolved keys must be of length 1-63 characters, and cannot start with ‘‘kong’’, ‘‘konnect’’, ‘‘mesh’’, ‘‘kic’’, or ‘’_‘’.’
Label key and value supports JQ expression syntax on discovered entity’s integration_record property.

Example:{"env":"test"}

metadataobject

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

Example