# Continuous Delivery Foundation V4 API

**Canonical:** https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-v4-api/  
**Provider:** Continuous Delivery Foundation — https://apis.io/providers/continuous-delivery-foundation/  
**Base URL:** https://api.screwdriver.cd/  
**Documentation:** https://cdevents.dev/

Continuous Delivery Foundation V4 API is one of 78 APIs that [Continuous Delivery Foundation](https://apis.io/providers/continuous-delivery-foundation/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include V4. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and a changelog.

The v4 API from Continuous Delivery Foundation — 119 operation(s) for v4.

## Operations (60 of 152)

| Method | Path | Summary |
|---|---|---|
| GET | `/v4/banners` | Get banners |
| POST | `/v4/banners` | Create a new banner |
| GET | `/v4/buildclusters` | Get build clusters |
| POST | `/v4/buildclusters` | Create a build cluster |
| GET | `/v4/collections` | Get collections for requesting user |
| POST | `/v4/collections` | Create a new collection |
| GET | `/v4/commands` | Get commands with pagination |
| POST | `/v4/commands` | Create a new command |
| GET | `/v4/isAdmin` | Check if a user is admin of a pipeline, event, or job |
| GET | `/v4/metrics` | application metrics |
| GET | `/v4/pipelines` | Get pipelines with pagination |
| POST | `/v4/pipelines` | Create a new pipeline |
| GET | `/v4/release` | API Release information |
| GET | `/v4/stats` | API stats |
| GET | `/v4/status` | API status |
| GET | `/v4/templates` | Get templates with pagination |
| POST | `/v4/templates` | Create a new template |
| GET | `/v4/tokens` | Get tokens with pagination |
| POST | `/v4/tokens` | Create a new token |
| GET | `/v4/versions` | API Package Versions |
| GET | `/v4/auth/contexts` | Get all auth contexts |
| GET | `/v4/auth/crumb` | Generate crumb |
| GET | `/v4/auth/key` | Get jwt public key |
| GET | `/v4/banners/{id}` | Get a single banner |
| PUT | `/v4/banners/{id}` | Update a banner |
| DELETE | `/v4/banners/{id}` | Delete a banner |
| GET | `/v4/buildclusters/{name}` | Get a single build cluster |
| PUT | `/v4/buildclusters/{name}` | Update a build cluster |
| DELETE | `/v4/buildclusters/{name}` | Delete a single build cluster |
| GET | `/v4/builds/statuses` | Get build statuses for jobs |
| GET | `/v4/builds/{id}` | Get a single build |
| PUT | `/v4/builds/{id}` | Update a build |
| GET | `/v4/collections/{id}` | Get a single collection |
| PUT | `/v4/collections/{id}` | Update a collection |
| DELETE | `/v4/collections/{id}` | Delete a single collection |
| GET | `/v4/coverage/info` | Get coverage metadata |
| GET | `/v4/coverage/token` | Get an access token to talk to coverage server |
| GET | `/v4/events/{id}` | Get a single event |
| GET | `/v4/jobs/{id}` | Get a single job |
| PUT | `/v4/jobs/{id}` | Update a job |
| GET | `/v4/pipeline/templates` | List all the pipeline templates |
| GET | `/v4/pipelines/{id}` | Get a single pipeline |
| PUT | `/v4/pipelines/{id}` | Update a pipeline |
| DELETE | `/v4/pipelines/{id}` | Delete a single pipeline |
| GET | `/v4/secrets/{id}` | Get a single secret |
| PUT | `/v4/secrets/{id}` | Update a secret |
| DELETE | `/v4/secrets/{id}` | Remove a single secret |
| GET | `/v4/stages/{id}` | Get a single stage |
| GET | `/v4/template/{id}` | Get a single template |
| GET | `/v4/templates/{name}` | Get all template versions for a given template name with pagination |
| DELETE | `/v4/templates/{name}` | Delete a template |
| GET | `/v4/users/settings` | Get user settings |
| PUT | `/v4/users/settings` | Update user settings |
| DELETE | `/v4/users/settings` | Reset user settings |
| GET | `/v4/users/{username}` | Get an user by SCM username and SCM context |
| GET | `/v4/auth/token/{buildId}` | Generate jwt |
| GET | `/v4/builds/{id}/artifacts` | Get a zipped file including all build artifacts |
| GET | `/v4/builds/{id}/metrics` | Get metrics for this build |
| GET | `/v4/builds/{id}/steps` | Get a step for a build |
| GET | `/v4/builds/{id}/secrets` | Get all secrets for a given build |

…and 92 more operations. They are listed in full on the page.

## Machine-readable artifacts (23)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/continuous-delivery-foundation/refs/heads/main/openapi/continuous-delivery-foundation-v4-api-openapi.yml
- **Documentation** — https://www.jenkins.io/doc/
- **APIDocumentation** — https://www.jenkins.io/doc/book/using/remote-access-api/
- **GettingStarted** — https://www.jenkins.io/doc/pipeline/tour/getting-started/
- **GitHubOrg** — https://github.com/jenkinsci
- **ToolCrosswalk** — https://raw.githubusercontent.com/api-evangelist/continuous-delivery-foundation/refs/heads/main/mcp/continuous-delivery-foundation-tool-crosswalk.yml
- **StatusPage** — https://status.jenkins.io/
- **Security** — https://www.jenkins.io/security/reporting/
- **ChangeLog** — https://www.jenkins.io/changelog/
- **Documentation** — https://spinnaker.io/docs/
- **APIDocumentation** — https://spinnaker.io/docs/reference/api/
- **Community** — https://spinnaker.io/docs/community/
- **GitHubOrg** — https://github.com/spinnaker
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/continuous-delivery-foundation/refs/heads/main/asyncapi/continuous-delivery-foundation-cdevents-events.yml
- **ChangeLog** — https://spinnaker.io/docs/releases/versions/
- **CLI** — https://spinnaker.io/docs/setup/other_config/spin/
- **Documentation** — https://docs.screwdriver.cd/
- **APIDocumentation** — https://docs.screwdriver.cd/user-guide/api
- **GettingStarted** — https://docs.screwdriver.cd/user-guide/quickstart
- **GitHubOrg** — https://github.com/screwdriver-cd
- **Documentation** — https://jayex.io/v3/
- **Community** — https://jayex.io/community/
- **CLI** — https://jayex.io/v3/develop/reference/jx/

## Other Continuous Delivery Foundation APIs (12)

- [CDEvents Specification](https://apis.io/apis/continuous-delivery-foundation/cdevents/)
- [Ortelius](https://apis.io/apis/continuous-delivery-foundation/ortelius/)
- [Continuous Delivery Foundation Website (WordPress REST)](https://apis.io/apis/continuous-delivery-foundation/cd-foundation-website-wordpress-rest/)
- [Tekton](https://apis.io/apis/continuous-delivery-foundation/tekton/)
- [Continuous Delivery Foundation Admin Controller API](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-admin-controller-api/)
- [Continuous Delivery Foundation Amazon Infrastructure Controller API](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-amazon-infrastructure-controller-api/)
- [Continuous Delivery Foundation API Extension Controller API](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-api-extension-controller-api/)
- [Continuous Delivery Foundation Application Controller API](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-application-controller-api/)
- [Continuous Delivery Foundation Artifact Controller API](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-artifact-controller-api/)
- [Continuous Delivery Foundation Artifactory Controller API](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-artifactory-controller-api/)
- [Continuous Delivery Foundation Auth Controller API](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-auth-controller-api/)
- [Continuous Delivery Foundation Bake Controller API](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-bake-controller-api/)

## Tags

V4

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/continuous-delivery-foundation/continuous-delivery-foundation-v4-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/continuous-delivery-foundation/.
