CIcircleci
Deploy

Get Component

Get the details of a component by ID.

get/deploy/components/{component_id}

Request

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

Path parameters

component_idstring required

An opaque identifier of a component.

Response

Successful response.

idstring uuid

The component ID

namestring

The component name

project_idstring uuid

The project ID of the component

release_countinteger

The number of releases for this component

created_atstring date-time

The time when the component was created

updated_atstring date-time

The time when the component was updated

Example response

{
  "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.