Admiral

Sources

List sources

GET
/v1/sources

Scope: source:read

Authorization

bearerAuth
AuthorizationBearer <token>

An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...

In: header

Query Parameters

filter?filter

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

Filterable fields:

  • name: filter by source name.
  • kind: filter by kind.
  • trigger: filter by trigger.
  • status: filter by status.
  • integration_id: sources reached through one integration.
  • credential_id: sources reached through one credential.

Example: field['trigger'] = 'TRIGGER_PUSH' AND field['status'] = 'STATUS_READY'

Lengthlength <= 1024
page_size?page_size

The page_size query parameter.

Formatint32
Range0 <= value <= 100
page_token?page_token

The page_token query parameter.

Response Body

application/json

curl -X GET "https://example.com/v1/sources"
{  "sources": [    {      "id": "string",      "name": "string",      "description": "string",      "kind": "KIND_UNSPECIFIED",      "location": "string",      "trigger": "TRIGGER_UNSPECIFIED",      "allows": [        "string"      ],      "settings": {        "git": {          "branches": [            "string"          ],          "pull_request_comment": "PULL_REQUEST_COMMENT_UNSPECIFIED"        }      },      "status": "STATUS_UNSPECIFIED",      "status_reason": "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",      "credential_id": "string"    }  ],  "next_page_token": "string"}