CIcircleci
Pipeline

Get a pipeline's configuration

Returns a pipeline's configuration by ID.

get/pipeline/{pipeline-id}/config

Request

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

Path parameters

pipeline-idstring uuid required

The unique ID of the pipeline.

Response

The configuration strings for the pipeline.

sourcestring required

The source configuration for the pipeline, before any config compilation has been performed. If there is no config, then this field will be empty.

compiledstring required

The compiled configuration for the pipeline, after all orb expansion has been performed. If there were errors processing the pipeline's configuration, then this field may be empty.

setup-configstring

The setup configuration for the pipeline used for Setup Workflows. If there were errors processing the pipeline's configuration or if setup workflows are not enabled, then this field should not exist

compiled-setup-configstring

The compiled setup configuration for the pipeline, after all orb expansion has been performed. If there were errors processing the pipeline's setup workflows, then this field may be empty.

Changes

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