Components
List components
Scope: component:read
Authorization
bearerAuth AuthorizationBearer <token>
Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...
In: header
Query Parameters
filter?filter
Filter expression to narrow results. Uses the Admiral filter DSL (see the API documentation for the full operator and predicate reference).
Filterable fields:
name: filter by name.description: filter by description.labels: filter by label key/value.
Example: field['labels']['team'] = 'payments'
Length
length <= 1024page_size?page_size
Maximum number of components to return per page. Defaults to 50 when omitted or 0; must not exceed 100.
Format
int32Range
0 <= value <= 100page_token?page_token
Opaque pagination token from a previous response.
Response Body
application/json
curl -X GET "https://example.com/v1/components"{ "components": [ { "id": "string", "name": "string", "description": "string", "labels": { "property1": "string", "property2": "string" }, "tags": [ { "name": "string", "digest": "string", "immutable": true, "created_at": "2023-01-15T01:30:15.01Z", "updated_at": "2023-01-15T01:30:15.01Z" } ], "created_by": { "id": "string", "display_name": "string", "email": "string" }, "created_at": "2023-01-15T01:30:15.01Z", "updated_at": "2023-01-15T01:30:15.01Z" } ], "next_page_token": "string"}