Catalog items
List catalog items
Scope: catalog: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 catalog item name.type: filter by item type (TERRAFORM, HELM, KUSTOMIZE, MANIFEST).source_id: filter by source reference.
Example: field['type'] = 'TERRAFORM'
Length
length <= 1024page_size?page_size
Maximum number of catalog items 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://api.admiral.io/api/v1/catalog-items"{ "catalog_items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "type": "CATALOG_ITEM_TYPE_UNSPECIFIED", "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81", "ref": "string", "root": "string", "path": "string", "labels": { "property1": "string", "property2": "string" }, "source_name": "string", "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"}