Skip to navigation

Get all versions of this configuration.

Listing, Sorting and Filtering Configurations

This endpoint returns the list of configurations in the specified project.

Sorting

The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas where each one can optionally specify asc or desc.

Sorting is valid on the following fields: created, hash, id, labels, name, updated, updatedBy

Filtering

There are two ways to filter the set of returned configurations from this endpoint - the first is to use the $filter query parameter, the second is to use the $label_key and $label query parameters.

The $filter query parameter allows for configurations to be filtered on the basis of fields in the schema using OData query syntax. See this document for more details on the syntax used.

Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, hash, id, labels, name, tag, updated, updatedBy, updatedByEmail, updatedByName

$label_key and $label are specific to querying configurations based on their labels. Labels are a set of key-value pairs that can be used to identify configurations with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of configurations.

Examples:

?$top=10 - Returns only the first 10 configurations from the list.

?$orderby=name desc - Sorts configurations by name in descending order.

?$filter=name eq 'descriptive name' - Returns configurations that match the provided name.

?$orderby=created desc - Sorts configurations by creation date in descending order.

?$filter=created ge 2021-01-01T00:00:00Z - Returns configurations created after January 1, 2021.

?$label=studio=paravalley - Returns configurations with the label studio set to paravalley.

?$label=release-date~2023 - Returns configurations with the label release-date set to a value that contains 2023.

?$label_key=studio&label_key=release-date - Returns configurations with any value set for the studio label and the release-date label.

RBAC Capability Required: templating.configs.get

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_namestringRequired
config_typestringRequired
namestringRequired

Query parameters

$orderbystringOptional
Specifies the key by which the result collection should be ordered.
$filterstringOptional
Restricts the set of items returned.
$topstringOptional

Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

$skiptokenstringOptional

Specifies a start offset to support paginated results. Use @odata.nextLink in the result object to enumerate the collection - it will be present only if there's more than one page of entities.

$label_keystringOptional

Filters the set to the specified label key. If multiple $label_keys are specified, matching items must have all labels.

$labelstringOptional

Filters the set to the specified label key/value pair. Supports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.

Response

A list of objects
supplementalobject
Supplemental info
valuelist of objectsRead-only
A list of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error