Admiral
Sources

List sources

GET
/api/v1/sources

Scope: source:read

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer adm_pat_...

In: header

Query Parameters

filter?filter

Filter expression to narrow results. Uses the Admiral filter DSL.

Syntax: field['name'] = 'value' with AND/OR/NOT, comparison operators (=, !=, <, >, <=, >=, ~=), and predicates (IN, BETWEEN, CONTAINS, STARTS_WITH, ENDS_WITH, IS NULL, EXISTS).

Filterable fields:

  • name -- filter by source name.
  • type -- filter by source type (TERRAFORM_REGISTRY, HELM_OCI, etc.).
  • catalog -- filter by catalog status (true/false).
  • labels.key -- filter by label key.

Example: field['type'] = 'TERRAFORM_REGISTRY' AND field['catalog'] = 'true'

Lengthlength <= 1024
page_size?page_size

Maximum number of sources to return per page.

Formatint32
Range0 <= value <= 100
page_token?page_token

Opaque pagination token from a previous response.

Response Body

application/json

curl -X GET "https://admiral.example.com/api/v1/sources"
{  "sources": [    {      "id": "f6a7b8c9-0123-4def-5678-901234567890",      "name": "nginx-ingress",      "description": "NGINX Ingress Controller Helm chart from the official repository.",      "type": "SOURCE_TYPE_HELM_REPOSITORY",      "url": "https://kubernetes.github.io/ingress-nginx",      "catalog": true,      "labels": {        "category": "networking",        "team": "platform"      },      "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",      "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",      "created_at": "2025-08-01T12:00:00Z",      "updated_at": "2025-10-20T09:00:00Z"    }  ],  "next_page_token": "string"}

Retrieve source outputs GET

Only meaningful for Terraform modules, which declare formal output blocks. Helm charts, Kustomize, and raw manifests do not have formal outputs -- workload component outputs are user-declared, not discovered. This operation queries the external system in real time and may take several seconds. Scope: `source:read`

List source versions GET

For Terraform registry sources, this calls the Module Registry Protocol's version listing endpoint. For Helm repositories, it parses the index.yaml. For OCI sources, it lists tags. For Git sources, it lists tags via ls-remote. This operation queries the external system in real time and may take several seconds. Scope: `source:read`