CIcircleci
Deploy

List Components

Allows for listing of components for a given organization ID.

get/deploy/components

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/deploy/components
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Query parameters

org-idstring uuid required

An opaque identifier of an organization used in query parameters.

project-idstring uuid

An opaque identifier of an project used in query parameters.

page-sizeinteger required

The number of results per page.

page-tokenstring

A token to specify which page of results to fetch.

Response

Paginated components list

next_page_tokenstring nullable

The pagination token to use when fetching the next page in this result set.

Example response

{
  "items": [
    {
      "id": "123e4127-e89b-12d3-a456-426123417400",
      "name": "service-a",
      "project_id": "123e4127-e89b-12d3-a456-426123417400",
      "labels": [
        {
          "key": "env",
          "value": "prod"
        }
      ],
      "release_count": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.