List Quotas

Returns a paginated collection of quotas for the current organization.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

A paginated list response for a collection of organization quotas.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Organization-specific quota overrides linked to a default quota.

Show Child Parameters
get/catalog-quotas
 
application/json

Create Quota

Creates an organization quota override for a default quota. Each organization may have at most one quota row per default quota.

post

Body

application/json

CreateQuota

Payload to create an organization override for a default quota.

* Additional properties are NOT allowed.
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

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

post/catalog-quotas

Body

{ "qualifier": "scorecard_evaluation_usage_1h", "value": 2 }
 
application/json

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