CircleCI API V3
API by CircleCI · rest
CircleCI's V3 API. Every route is served under /api/v3 on https://circleci.com. No standard is implemented. V3 takes the ideas that work from established API designs and combines them into one coherent whole, but it is not JSON:API, not problem+json, and not HAL. Familiar names like data, attributes, source.pointer and filter[...] carry no behaviour from those specs. Take everything from this document, and do not use a standard-conformant client library. Conventions Auth Authorization: Bearer <token>. A token in a query parameter is rejected. Ids Ids are UUIDs, never slugs or names. Some collections resolve a slug via filter[slug]. One resource {"data": {"id", "attributes", "references"}}. Each entry in references is an id, or an array of them, sometimes carrying a nested attributes object of denormalised fields from the referenced resource. Read the operation's schema for which fields those are, and fetch the resource itself for…
Endpoint: https://circleci.com/
Verification: observed. Source: crawl.
Capabilities (252)
- Returns entities ranked by what they were charged.
- Returns aggregated job results across runs read from per-run test data.
- Returns aggregated test results across runs.
- Returns entities ranked by the resources they consumed.
- Approves a pending approval job.
- Rejects a pending approval by cancelling its approval job.
- Reports whether the org is entitled to audit-log delivery.
- Serves the V3 audit-log destination collection for one org.
- Creates an audit-log destination for the referenced org.
- Verifies a storage configuration without persisting it.
- Returns a single audit-log destination addressed by its id.
- Deletes the audit-log destination addressed by id.
- Applies a partial update to the audit-log destination.
- Lists the images each resource class accepts grouped by executor.
- Lists the resource classes for each executor with their size and images.
- Compiles the supplied pipeline config expanding orbs and resolving parameters.
- Returns a prompt for a coding agent to write or improve a CircleCI config.
- Lists every restriction applied to a context.
- Creates a restriction for the context referenced in the request body.
- Deletes a context restriction by id.
- Lists the contexts owned by an organization.
- Creates a context owned by an organization.
- Returns a single context by id.
- Deletes a context by id.
- Lists the environment variables of a context.