CircleCI
Purpose
Ingests CircleCI organizations, projects, pipelines, contexts, environment variable metadata, checkout keys, webhooks, triggers, OIDC configuration, policies, groups, environments, and components.
tip
Secret fields below accept either an AWS Secrets Manager ARN or a value pasted directly into SubImage's managed vault. See Secrets for details.
Required Fields
| Field | Secret? | Description |
|---|---|---|
circleci_token |
Yes | CircleCI personal API token |
Optional Fields
| Field | Secret? | Description |
|---|---|---|
circleci_base_url |
No | CircleCI API v2 base URL (default https://circleci.com/api/v2) |
circleci_project_slugs |
No | Extra project slugs to sync, such as gh/my-org/my-repo. Use this for projects with no recent pipelines. |
Setup Steps
- In CircleCI, open User Settings → Personal API Tokens.
- Create a new token, name it
subimage, and copy the value. - In SubImage, set
circleci_tokento the token or its AWS Secret ARN. - Leave
circleci_base_urlat the default unless you use a different CircleCI API endpoint. - Optionally add
circleci_project_slugsfor projects that may not appear in CircleCI's recent pipeline feed. - Save the module.
Notes
- SubImage is read-only and stores only the secret metadata CircleCI returns. CircleCI does not expose context environment variable values and only returns masked project environment variable values.
- CircleCI API v2 does not provide an endpoint to list every project in an organization. SubImage discovers projects from each organization's recent pipeline feed, then adds any configured
circleci_project_slugs.