Continuous Delivery Foundation

Screwdriver

Screwdriver is an open-source build platform designed for Continuous Delivery, originally built at Yahoo. It provides a REST API for managing pipelines, builds, jobs, and webhooks and is designed to coordinate complex CD workflows across multiple repositories.

Documentation GitHub OpenAPI

Operations 152

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 #

GET /v4/commands/{namespace}/{name} Get all command versions for a given command namespace/name with pagination #

DELETE /v4/commands/{namespace}/{name} Delete a command #

GET /v4/events/{id}/metrics Get metrics for this event #

GET /v4/events/{id}/builds Get builds for a given event #

GET /v4/events/{id}/stageBuilds Get stage builds for a given event #

GET /v4/jobs/{id}/metrics Get build metrics for this job #

GET /v4/jobs/{id}/builds Get builds for a given job #

GET /v4/jobs/{id}/lastSuccessfulMeta Get the last successful metadata for a given job #

GET /v4/jobs/{id}/latestBuild Get latest build for a given job #

GET /v4/pipeline/template/{id} Get a single template #

GET /v4/pipelines/{id}/admins Get all admin users for a given pipeline #

GET /v4/pipelines/{id}/latestCommitEvent Get latest commit event for a given pipeline #

GET /v4/pipelines/{id}/tokens List tokens for pipeline #

POST /v4/pipelines/{id}/tokens Create a new token for pipeline #

DELETE /v4/pipelines/{id}/tokens Remove all tokens for a specific pipeline #

GET /v4/pipelines/{id}/events Get pipeline type events for this pipeline #

GET /v4/pipelines/{id}/triggers Get all triggers for a given pipeline #

GET /v4/pipelines/{id}/jobs Get all jobs for a given pipeline #

GET /v4/pipelines/{id}/badge Get a badge for the pipeline #

GET /v4/pipelines/{id}/stages Get all stages for a given pipeline #

GET /v4/pipelines/{id}/secrets Get all secrets secrets for a given pipelines #

GET /v4/pipelines/{id}/builds Get builds for this pipeline #

GET /v4/pipelines/{id}/metrics Get metrics for this pipeline #

GET /v4/pipelines/{id}/lastSuccessfulEvent Get last successful event for a given pipeline #

GET /v4/pipelines/{id}/admin Get the pipeline admin #

GET /v4/stages/{id}/stageBuilds Get stage builds for a stage #

GET /v4/templates/{name}/{versionOrTag} Get a single template given template name and version or tag #

GET /v4/templates/{name}/tags Get all template tags for a given template name #

GET /v4/templates/{name}/metrics Get all template versions and metrics for a template name with pagination #

GET /v4/auth/login/github:github.com/{web} Login using oauth #

POST /v4/auth/login/github:github.com/{web} Login using oauth #

GET /v4/auth/login/guest/{web} Login as an guest user #

GET /v4/builds/{id}/steps/{name} Get a step for a build #

PUT /v4/builds/{id}/steps/{name} Update a step for a build #

GET /v4/builds/{id}/artifacts/{name*} Get a single build artifact #

GET /v4/commands/{namespace}/{name}/tags Get all command tags for a given command namespace and name #

GET /v4/commands/{namespace}/{name}/{versionOrTag} Get a single command given command namespace, name and version or tag #

GET /v4/pipeline/template/{namespace}/{name} Get a specific template by namespace and name #

GET /v4/pipelines/{id}/{jobName}/badge Get a badge for a job #

GET /v4/builds/{id}/steps/{name}/logs Get the logs for a build step #

GET /v4/pipeline/template/{namespace}/{name}/{versionOrTag} Get a specific template version details by version number or tag #

GET /v4/pipeline/templates/{namespace}/{name}/versions Get all template versions for a given template name with pagination #

GET /v4/pipeline/templates/{namespace}/{name}/tags Get all pipeline template tags for a given template name and namespace #

GET /v4/pipelines/{id}/jobs/{jobName}/latestBuild Get latest build for a given job #

GET /v4/templates/{name}/{versionOrTag}/usage/pipelines Get information for the pipelines that are being used by a specific template version. #

POST /v4/builds Create and start a build #

POST /v4/events Create and start a event #

POST /v4/processHooks Handle process hook events #

POST /v4/secrets Create a new secret #

POST /v4/validator Validate a given screwdriver.yaml #

POST /v4/webhooks Handle webhook events #

POST /v4/auth/logout Logout of screwdriver #

POST /v4/pipeline/template Create a new pipeline template #

POST /v4/validator/command Validate a given sd-command.yaml #

POST /v4/validator/template Validate a given sd-template.yaml #

POST /v4/builds/{id}/token Generate a JWT for use throughout a given build #

POST /v4/jobs/{id}/notify Notify user about job status #

POST /v4/pipeline/template/validate Validate a given sd-template.yaml #

POST /v4/pipelines/{id}/openPr Open pull request for repository #

POST /v4/pipelines/{id}/startall Start all child pipelines given a specific pipeline #

POST /v4/pipelines/{id}/sync Sync a pipeline #

POST /v4/builds/{id}/artifacts/unzip Extract a ZIP for build artifacts #

POST /v4/pipelines/{id}/sync/webhooks Add webhooks or update webhooks if already exists #

POST /v4/pipelines/{id}/sync/pullrequests Add or update pull request of a pipeline #

PUT /v4/pipelines/updateAdmins Update admins for a collection of pipelines #

PUT /v4/tokens/{id} Update a token #

DELETE /v4/tokens/{id} Remove a single token #

PUT /v4/collections/{id}/pipelines Add one or more pipelines to the collection #

DELETE /v4/collections/{id}/pipelines Delete one or more pipelines from a collection #

PUT /v4/events/{id}/stop Stop all builds in an event #

PUT /v4/jobs/{id}/buildCluster Update the buildCluster of a job #

DELETE /v4/jobs/{id}/buildCluster Delete the buildCluster override of a job #

PUT /v4/pipelines/{id}/buildCluster Update the buildCluster of a pipeline #

PUT /v4/pipelines/{id}/updateAdmins Update admins of a pipeline #

PUT /v4/templates/{name}/trusted Update a template's trusted property #

PUT /v4/tokens/{id}/refresh Refresh a token #

PUT /v4/commands/{namespace}/{name}/trusted Update a command's trusted property #

PUT /v4/pipelines/{pipelineId}/tokens/{tokenId} Update a token for pipeline #

DELETE /v4/pipelines/{pipelineId}/tokens/{tokenId} Remove a single token for a specific pipeline #

PUT /v4/templates/{templateName}/tags/{tagName} Add or update a template tag #

DELETE /v4/templates/{templateName}/tags/{tagName} Delete a template tag #

PUT /v4/commands/{namespace}/{name}/tags/{tagName} Add or update a command tag #

DELETE /v4/commands/{namespace}/{name}/tags/{tagName} Delete a command tag #

PUT /v4/pipeline/templates/{namespace}/{name}/trusted Update a pipeline template's trusted property #

PUT /v4/pipelines/{pipelineId}/tokens/{tokenId}/refresh Refresh a pipeline token #

PUT /v4/pipeline/template/{namespace}/{name}/tags/{tag} Add or update a pipeline template tag #

DELETE /v4/pipelines/{id}/caches API to delete cache using scope and id #

DELETE /v4/pipeline/templates/{namespace}/{name} Delete a pipeline template and its related versions and tags #

DELETE /v4/templates/{name}/versions/{version} Delete the specified version of template and the tags associated with it #

DELETE /v4/commands/{namespace}/{name}/versions/{version} Delete the specified version of commands and the tags associated with it #

DELETE /v4/pipeline/templates/{namespace}/{name}/versions/{version} Delete the specified version of a pipeline template and the tags associated with it #

DELETE /v4/pipeline/templates/{namespace}/{name}/tags/{tag} Delete a pipeline template tag #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/screwdriver"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

{"info":{"title":"Screwdriver API Documentation","version":"3"},"security":[{"jwt":[]}],"openapi":"3.0.0","servers":[{"url":"https://api.screwdriver.cd/"}],"components":{"securitySchemes":{"jwt":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"type":{"type":"string","description":"Type/Severity of the banner message","example":"info","enum":["info","warn"],"maxLength":32},"scope":{"type":"string","description":"Scope of the banner","example":"GLOBAL","default":"GLOBAL","enum":["GLOBAL","PIPELINE","BUILD"],"maxLength":16},"Model1":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"message":{"type":"string","description":"Body of banner to display","example":"Due to planned upgrade of Kubernetes, Screwdriver will be down","maxLength":512},"isActive":{"type":"boolean","description":"Flag if the banner is active","example":true},"createTime":{"type":"string","description":"When this banner was created","example":"2017-01-06T01:49:50.384359267Z","maxLength":32,"x-format":{"isoDate":true}},"createdBy":{"type":"string","description":"Username of user creating the banner","example":"batman123","maxLength":128},"type":{"$ref":"#/components/schemas/type"},"scope":{"$ref":"#/components/schemas/scope"},"scopeId":{"type":"integer","description":"Identifier to pipelineId for PIPELINE, buildId for BUILD, or null for GLOBAL","example":1234,"x-constraint":{"sign":"positive"}}},"required":["id","message","isActive","createTime","createdBy","type","scope","scopeId"]},"List Banners":{"type":"array","items":{"$ref":"#/components/schemas/Model1"}},"scmOrganizations":{"type":"array","items":{"type":"string","description":"SCM organization name","example":"screwdriver-cd","maxLength":100}},"Get BuildCluster":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the build cluster","example":"iOS","maxLength":50,"pattern":"^[\\w.-]+$"},"description":{"type":"string","description":"Description of the build cluster","example":"Build cluster for iOS team","maxLength":100},"scmContext":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"scmOrganizations":{"$ref":"#/components/schemas/scmOrganizations"},"isActive":{"type":"boolean","description":"Flag if the the build cluster is active","example":true},"managedByScrewdriver":{"type":"boolean","description":"Flag if the cluster is managed by screwdriver team","example":true},"maintainer":{"type":"string","description":"Maintainer of the Command","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"weightage":{"type":"number","description":"Weight percentage for build cluster","example":20,"minimum":0,"maximum":100},"group":{"type":"string","description":"Group of the build cluster","example":"default","default":"default"}},"required":["id","name","scmContext","scmOrganizations","isActive","managedByScrewdriver","maintainer","weightage"]},"List of build clusters":{"type":"array","items":{"$ref":"#/components/schemas/Get%20BuildCluster"}},"pipelineIds":{"type":"array","items":{"type":"integer","x-constraint":{"sign":"positive"}}},"Model2":{"type":"string","description":"Collection type","example":"default","enum":["default","normal"],"maxLength":32},"Model3":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"userId":{"type":"integer","description":"User ID","x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Collection name","example":"Favorites","maxLength":128},"description":{"type":"string","description":"Collection description","example":"List of my favorite pipelines","maxLength":256},"pipelineIds":{"$ref":"#/components/schemas/pipelineIds"},"type":{"$ref":"#/components/schemas/Model2"}},"required":["id","userId","name","pipelineIds"]},"List collections for requesting user":{"type":"array","items":{"$ref":"#/components/schemas/Model3"}},"SCM Repository":{"type":"object","properties":{"name":{"type":"string","example":"screwdriver-cd/screwdriver"},"branch":{"type":"string","example":"master"},"url":{"type":"string","example":"https://github.com/screwdriver-cd/screwdriver/tree/master","x-format":{"uri":true}},"private":{"type":"boolean"},"rootDir":{"type":"string","description":"Root directory (relative to checkoutUrl)","example":"src/app/component","maxLength":100}},"required":["name","branch","url"]},"admins":{"type":"object","description":"Admins of this Pipeline","example":{"myself":true}},"adminUserIds":{"type":"array","description":"IDs of the users who have admin privileges for this pipeline","example":"[12345, 6789]","items":{"type":"integer","description":"Identifier of the user","example":12345,"x-constraint":{"sign":"positive"}}},"Model4":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]},"virtual":{"type":"boolean","description":"Flag to indicate if the node is a virtual job","example":true}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/Model4"}},"Model5":{"type":"object","properties":{"src":{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]},"dest":{"anyOf":[{"type":"string","example":"~sd@1234:component","pattern":"^~?sd@(\\d+):(([\\w-]+)|(stage@([\\w-]+):setup))$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"}]}}},"edges":{"type":"array","items":{"$ref":"#/components/schemas/Model5"}},"workflowGraph":{"type":"object","description":"Graph representation of the workflow","properties":{"nodes":{"$ref":"#/components/schemas/nodes"},"edges":{"$ref":"#/components/schemas/edges"}}},"annotations":{"type":"object","description":"Pipeline-level annotations"},"scmUrls":{"type":"array","minItems":1,"items":{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}},"childPipelines":{"type":"object","description":"Configuration of child pipelines","properties":{"scmUrls":{"$ref":"#/components/schemas/scmUrls"},"startAll":{"type":"boolean"}},"required":["scmUrls"]},"metricsDowntimeJobs":{"type":"array","description":"Job IDs to watch for downtime","items":{"type":"integer","description":"Identifier for this job","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}},"metricsDowntimeStatuses":{"type":"array","description":"Build statuses to watch for downtime","items":{"type":"string"}},"settings":{"type":"object","default":{},"properties":{"metricsDowntimeJobs":{"$ref":"#/components/schemas/metricsDowntimeJobs"},"metricsDowntimeStatuses":{"$ref":"#/components/schemas/metricsDowntimeStatuses"},"public":{"type":"boolean"},"groupedEvents":{"type":"boolean"},"showEventTriggers":{"type":"boolean"},"filterEventsForNoBuilds":{"type":"boolean"},"filterSchedulerEvents":{"type":"boolean"},"aliasName":{"type":"string","description":"A customizable alias for pipeline name","example":"scwdvr-cd","maxLength":32}}},"state":{"type":"string","description":"Current state of the pipeline","example":"ACTIVE","default":"ACTIVE","enum":["ACTIVE","INACTIVE","DELETING","DISABLED"],"maxLength":10},"actions":{"type":"array","items":{"type":"string"}},"Model6":{"type":"object","properties":{"scmUri":{"type":"string","pattern":"^([^:]+):([^:]+):([^:]+)(?::(.*))?$"},"actions":{"$ref":"#/components/schemas/actions"}}},"subscribedScmUrlsWithActions":{"type":"array","description":"List of subscribed scm urls paired with actions","items":{"$ref":"#/components/schemas/Model6"}},"sonar":{"type":"object","properties":{"defaultName":{"type":"string","description":"Auto populated dashboard name for a badge","example":"screwdriver/ui","maxLength":128},"defaultUri":{"type":"string","description":"Auto populated url for the badge application dashboard","example":"https://sonar.screwdriver.cd/dashboard?id=112233","maxLength":500},"name":{"type":"string","description":"The dashboard name for a badge","example":"my-screwdriver/ui","maxLength":128},"uri":{"type":"string","description":"The url the badge application dashboard","example":"https://my-sonar.screwdriver.cd/dashboard?id=112233","maxLength":500}}},"badges":{"type":"object","description":"A list of badges that pipline has","example":"{ sonar: { name: 'dashboard', uri: 'http://sonar.com/sample1' } }","properties":{"sonar":{"$ref":"#/components/schemas/sonar"}}},"Get Pipeline":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","example":"screwdriver-cd/screwdriver"},"scmUri":{"type":"string","description":"Unique identifier for the application","example":"github.com:123456:master","maxLength":500,"pattern":"^([^:]+):([^:]+):([^:]+)(?::(.*))?$"},"scmContext":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"scmRepo":{"$ref":"#/components/schemas/SCM%20Repository"},"createTime":{"type":"string","description":"When this pipeline was created","x-format":{"isoDate":true}},"admins":{"$ref":"#/components/schemas/admins"},"adminUserIds":{"$ref":"#/components/schemas/adminUserIds"},"workflowGraph":{"$ref":"#/components/schemas/workflowGraph"},"annotations":{"$ref":"#/components/schemas/annotations"},"lastEventId":{"type":"integer","description":"Identifier of last event","example":123345,"x-constraint":{"sign":"positive"}},"configPipelineId":{"type":"integer","description":"Identifier of pipeline containing external configuration","example":123,"x-constraint":{"sign":"positive"}},"childPipelines":{"$ref":"#/components/schemas/childPipelines"},"prChain":{"type":"boolean","description":"Configuration of chainPR","default":false},"parameters":{"type":"object","default":{},"properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"settings":{"$ref":"#/components/schemas/settings"},"state":{"$ref":"#/components/schemas/state"},"stateChanger":{"type":"string","description":"Username for who changed the state","maxLength":128},"stateChangeTime":{"type":"string","description":"When the state of the pipeline was changed","x-format":{"isoDate":true}},"stateChangeMessage":{"type":"string","description":"Reason why disabling or enabling pipeline","example":"Disabling pipeline for maintenance","maxLength":512},"subscribedScmUrlsWithActions":{"$ref":"#/components/schemas/subscribedScmUrlsWithActions"},"badges":{"$ref":"#/components/schemas/badges"},"templateVersionId":{"type":"integer","description":"Identifier for this pipeline's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}},"required":["id","scmUri","scmContext","createTime","admins","state"]},"List of Pipelines":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Pipeline"}},"Requests Object":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of requests","example":100},"timeouts":{"type":"integer","description":"Number of timeouts","example":0},"success":{"type":"integer","description":"Number of successes","example":95},"failure":{"type":"integer","description":"Number of failures","example":"5"},"concurrent":{"type":"integer","description":"Number of concurrent requests","example":0},"averageTime":{"type":"number","example":5.3134}}},"Breaker Object":{"type":"object","properties":{"isClosed":{"type":"boolean"}}},"Executor Object":{"type":"object","properties":{"requests":{"$ref":"#/components/schemas/Requests%20Object"},"breaker":{"$ref":"#/components/schemas/Breaker%20Object"}}},"Stats Object":{"type":"object","properties":{"executor":{"$ref":"#/components/schemas/Executor%20Object"},"scm":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Executor%20Object"}}}}},"permission":{"type":"string","description":"Token permission","enum":["read","execute","write","all"],"maxLength":16},"pipelines":{"type":"array","items":{"type":"integer","x-constraint":{"sign":"positive"}}},"organizations":{"type":"array","items":{"type":"string"}},"jobs":{"type":"array","items":{"type":"integer","x-constraint":{"sign":"positive"}}},"resources":{"type":"object","default":{},"properties":{"pipelines":{"$ref":"#/components/schemas/pipelines"},"privatePipeline":{"type":"boolean"},"organizations":{"$ref":"#/components/schemas/organizations"},"jobs":{"$ref":"#/components/schemas/jobs"}}},"options":{"type":"object","default":{},"properties":{"permission":{"$ref":"#/components/schemas/permission"},"resources":{"$ref":"#/components/schemas/resources"}}},"Get tokens":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Token name","example":"Mobile token","maxLength":128},"description":{"type":"string","description":"Token description","example":"Used to authenticate the mobile app","maxLength":256},"lastUsed":{"type":"string","description":"Last used","x-format":{"isoDate":true}},"issuerId":{"type":"integer","description":"Issuer ID","nullable":true,"x-constraint":{"sign":"positive"}},"expiresAt":{"type":"string","description":"Expires Date","example":"2030-01-30T09:15:40.000Z","x-format":{"isoDate":true}},"options":{"$ref":"#/components/schemas/options"}},"required":["id","name","lastUsed"]},"Model7":{"type":"array","items":{"$ref":"#/components/schemas/Get%20tokens"}},"List of package versions":{"type":"array","items":{"type":"string","description":"Package and its version"}},"License Object":{"type":"object","properties":{"name":{"type":"string"},"repository":{"type":"string"},"licenses":{"type":"string"}}},"List of Licenses":{"type":"array","items":{"$ref":"#/components/schemas/License%20Object"}},"Versions Object":{"type":"object","properties":{"versions":{"$ref":"#/components/schemas/List%20of%20package%20versions"},"licenses":{"$ref":"#/components/schemas/List%20of%20Licenses"}}},"Context Object":{"type":"object","properties":{"context":{"type":"string"},"displayName":{"type":"string"},"autoDeployKeyGeneration":{"type":"boolean"},"readOnly":{"type":"boolean"}}},"Array of Contexts":{"type":"array","items":{"$ref":"#/components/schemas/Context%20Object"}},"Crumb to prevent CSRF Object":{"type":"object","properties":{"crumb":{"type":"string"}}},"Public Key for Verifying JWTs Object":{"type":"object","properties":{"key":{"type":"string"}}},"Get Banner":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"message":{"type":"string","description":"Body of banner to display","example":"Due to planned upgrade of Kubernetes, Screwdriver will be down","maxLength":512},"isActive":{"type":"boolean","description":"Flag if the banner is active","example":true},"createTime":{"type":"string","description":"When this banner was created","example":"2017-01-06T01:49:50.384359267Z","maxLength":32,"x-format":{"isoDate":true}},"createdBy":{"type":"string","description":"Username of user creating the banner","example":"batman123","maxLength":128},"type":{"$ref":"#/components/schemas/type"},"scope":{"$ref":"#/components/schemas/scope"},"scopeId":{"type":"integer","description":"Identifier to pipelineId for PIPELINE, buildId for BUILD, or null for GLOBAL","example":1234,"x-constraint":{"sign":"positive"}}},"required":["id","message","isActive","createTime","createdBy","type","scope","scopeId"]},"Model8":{"type":"array","items":{"type":"string"}},"string":{"type":"object","properties":{"eventId":{"anyOf":[{"type":"integer","x-constraint":{"sign":"positive"}},{"type":"string","nullable":true}]},"jobs":{"type":"object","properties":{"string":{"anyOf":[{"type":"integer","x-constraint":{"sign":"positive"}},{"type":"string","nullable":true}]}}}}},"parameters":{"type":"object","description":"Input parameters that defined this build"},"meta":{"type":"object","description":"Key=>Value information from the build itself","default":{}},"status":{"type":"string","description":"Current status of the build","example":"SUCCESS","enum":["ABORTED","CREATED","FAILURE","QUEUED","RUNNING","SUCCESS","BLOCKED","UNSTABLE","COLLAPSED","FROZEN"]},"statusMessageType":{"type":"string","description":"Severity of the status message","example":"WARN","enum":["ERROR","WARN","INFO"],"maxLength":10},"stats":{"type":"object","description":"Stats for this build","properties":{"queueEnterTime":{"type":"string","description":"When this build enters queue","x-format":{"isoDate":true}},"blockedStartTime":{"type":"string","description":"When this build is blocked","x-format":{"isoDate":true}},"imagePullStartTime":{"type":"string","description":"When this build starts pulling image","x-format":{"isoDate":true}},"hostname":{"type":"string","description":"Where this build is run"}}},"Get Step metadata":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this Step","example":123345,"x-constraint":{"sign":"positive"}},"buildId":{"type":"integer","description":"Identifier of the parent Build","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the Step","example":"install","maxLength":64},"command":{"type":"string","description":"Command of the Step to execute","example":"npm install"},"code":{"type":"integer","description":"Exit code","example":1},"startTime":{"type":"string","description":"When this Step started","example":"2017-01-06T01:49:50.384359267Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"When this Step stopped running","example":"2017-01-06T01:49:51.676057192Z","x-format":{"isoDate":true}},"lines":{"type":"integer","description":"Number of Step log lines","example":100}},"required":["name"]},"steps":{"type":"array","description":"List of steps","items":{"$ref":"#/components/schemas/Get%20Step%20metadata"}},"Get Build":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"environment":{"anyOf":[{"$ref":"#/x-alt-definitions/environment"},{"type":"object","properties":{"string":{"type":"string"}}}]},"eventId":{"type":"integer","description":"Identifier of the parent event","example":123345,"x-constraint":{"sign":"positive"}},"jobId":{"type":"integer","description":"Identifier of the parent job","example":123345,"x-constraint":{"sign":"positive"}},"parentBuildId":{"description":"Identifier(s) of this parent build","anyOf":[{"$ref":"#/x-alt-definitions/parentBuildId"},{"type":"integer","x-constraint":{"sign":"positive"}}]},"parentBuilds":{"type":"object","example":{"111":{"eventId":2,"jobs":{"jobA":333,"jobB":null}},"222":{"eventId":3,"jobs":{"jobC":555}}},"properties":{"string":{"$ref":"#/components/schemas/string"}}},"number":{"type":"number","description":"Timestamp of create time","example":1473900790309,"x-constraint":{"sign":"positive"}},"container":{"type":"string","description":"Container this build is running in","example":"node:4"},"cause":{"type":"string","description":"Reason why this build started","example":"pull request opened"},"sha":{"type":"string","description":"SHA this project was built on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-format":{"hex":{"byteAligned":false,"prefix":false}}},"subscribedConfigSha":{"type":"string","description":"SHA this project was built on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-format":{"hex":{"byteAligned":false,"prefix":false}}},"createTime":{"type":"string","description":"When this build was created","maxLength":32,"x-format":{"isoDate":true}},"startTime":{"type":"string","description":"When this build started on a build machine","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"When this build stopped running","x-format":{"isoDate":true}},"parameters":{"$ref":"#/components/schemas/parameters"},"meta":{"$ref":"#/components/schemas/meta"},"status":{"$ref":"#/components/schemas/status"},"statusMessage":{"type":"string","description":"Status message to describe status of the build","example":"Build failed due to infrastructure error"},"statusMessageType":{"$ref":"#/components/schemas/statusMessageType"},"stats":{"$ref":"#/components/schemas/stats"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"x-constraint":{"sign":"positive"}},"buildClusterName":{"type":"string","description":"Name of the build cluster","example":"iOS","maxLength":50,"pattern":"^[\\w.-]+$"},"steps":{"$ref":"#/components/schemas/steps"}},"required":["id","jobId","number","cause","createTime","status"]},"Model9":{"type":"string","description":"Collection type","example":"default","enum":["default","normal","shared"],"maxLength":32},"Model10":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Pipeline"}},"Get collection":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"userId":{"type":"integer","description":"User ID","x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Collection name","example":"Favorites","maxLength":128},"description":{"type":"string","description":"Collection description","example":"List of my favorite pipelines","maxLength":256},"pipelineIds":{"$ref":"#/components/schemas/pipelineIds"},"type":{"$ref":"#/components/schemas/Model9"},"pipelines":{"$ref":"#/components/schemas/Model10"}},"required":["id","name","pipelineIds","pipelines"]},"Author of the commit":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string","example":"https://github.com/stjohnjohnson","x-format":{"uri":true}},"name":{"type":"string","example":"Dao Lam"},"username":{"type":"string","example":"d2lam"},"avatar":{"type":"string","example":"https://avatars.githubusercontent.com/u/622065?v=3","x-format":{"uri":true}}},"required":["name","username"]},"Committer of the commit":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string","example":"https://github.com/stjohnjohnson","x-format":{"uri":true}},"name":{"type":"string","example":"Dao Lam"},"username":{"type":"string","example":"d2lam"},"avatar":{"type":"string","example":"https://avatars.githubusercontent.com/u/622065?v=3","x-format":{"uri":true}}},"required":["name","username"]},"SCM Commit":{"type":"object","description":"Commit related to the event","properties":{"message":{"type":"string","example":"Fixing a bug with signing"},"author":{"$ref":"#/components/schemas/Author%20of%20the%20commit"},"committer":{"$ref":"#/components/schemas/Committer%20of%20the%20commit"},"url":{"type":"string","example":"https://github.com/screwdriver-cd/screwdriver/commit/8843d7f92416211de","x-format":{"uri":true}}},"required":["message","author","url"]},"SCM User":{"type":"object","description":"Creator of the event","properties":{"id":{"type":"string"},"url":{"type":"string","example":"https://github.com/stjohnjohnson","x-format":{"uri":true}},"name":{"type":"string","example":"Dao Lam"},"username":{"type":"string","example":"d2lam"},"avatar":{"type":"string","example":"https://avatars.githubusercontent.com/u/622065?v=3","x-format":{"uri":true}}},"required":["name","username"]},"Model11":{"type":"object","description":"Key=>Value information from the event itself","example":{"parameters":{"nameA":"value1","jobA":{"nameB":"value2"}}},"default":{}},"Model12":{"type":"string","description":"Type of the event","example":"pr","enum":["pr","pipeline"],"maxLength":10},"Model13":{"type":"object","description":"Graph representation of the workflow","example":{"nodes":[{"name":"~commit"},{"name":"main","id":12345678},{"name":"publish","id":23456789}],"edges":[{"src":"~commit","dest":"main"},{"src":"main","dest":"publish"}]},"properties":{"nodes":{"$ref":"#/components/schemas/nodes"},"edges":{"$ref":"#/components/schemas/edges"}}},"SCM Pull Request":{"type":"object","description":"Pull request object that holds information about the pull request","properties":{"url":{"type":"string","example":"https://github.com/screwdriver-cd/screwdriver/pull/1","x-format":{"uri":true}},"title":{"type":"string","maxLength":512},"ref":{"type":"string"},"prSource":{"type":"string"},"prBranchName":{"type":"string"},"createTime":{"type":"string","format":"date-time","example":"2018-10-10T21:35:31Z"},"username":{"type":"string","example":"d2lam"},"userProfile":{"type":"string","example":"https://github.com/anonymous","x-format":{"uri":true}},"baseBranch":{"type":"string","example":"master"}}},"Model14":{"type":"string","description":"Current status of the event","example":"SUCCESS","default":"UNKNOWN","enum":["UNKNOWN","ABORTED","CREATED","FAILURE","IN_PROGRESS","SUCCESS"],"maxLength":15},"Get Event":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this event","example":123345,"x-constraint":{"sign":"positive"}},"parentEventId":{"type":"integer","description":"Identifier of the direct parent event","example":123344,"x-constraint":{"sign":"positive"}},"groupEventId":{"type":"integer","description":"Identifier of the group parent event","example":123344,"x-constraint":{"sign":"positive"}},"causeMessage":{"type":"string","description":"Message that describes why the event was created","example":"Merge pull request #26 from screwdriver-cd/data-schema","maxLength":512},"commit":{"$ref":"#/components/schemas/SCM%20Commit"},"createTime":{"type":"string","description":"When this event was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"creator":{"$ref":"#/components/schemas/SCM%20User"},"meta":{"$ref":"#/components/schemas/Model11"},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"sha":{"type":"string","description":"SHA this project was built on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-constraint":{"length":40},"x-format":{"hex":{"byteAligned":false,"prefix":false}}},"configPipelineSha":{"type":"string","description":"SHA of the configuration pipeline this project depends on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-constraint":{"length":40},"x-format":{"hex":{"byteAligned":false,"prefix":false}}},"startFrom":{"description":"Event start point - a job name or trigger name (~commit/~pr)","example":"~commit","anyOf":[{"type":"string"},{"type":"string","description":"Name of the Job","example":"main","maxLength":110,"pattern":"^(PR-[0-9]+:)?(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string","pattern":"^(?:PR-\\d+:)?stage@([\\w-]+)$"}]},"type":{"$ref":"#/components/schemas/Model12"},"workflowGraph":{"$ref":"#/components/schemas/Model13"},"pr":{"$ref":"#/components/schemas/SCM%20Pull%20Request"},"prNum":{"type":"integer","description":"Pull request number if it is a PR event","x-constraint":{"sign":"positive"}},"baseBranch":{"type":"string","description":"build base branch","example":"develop"},"status":{"$ref":"#/components/schemas/Model14"}},"required":["id","commit","createTime","creator","pipelineId","sha","type","status"]},"Model15":{"type":"object"},"event":{"type":"array","items":{"type":"string","x-format":{"uri":{"relativeOnly":true}}}},"pipeline":{"type":"array","items":{"type":"string","x-format":{"uri":{"relativeOnly":true}}}},"job":{"type":"array","items":{"type":"string","x-format":{"uri":{"relativeOnly":true}}}},"cache":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/event"},"pipeline":{"$ref":"#/components/schemas/pipeline"},"job":{"$ref":"#/components/schemas/job"}}},"Named command to execute":{"type":"object","properties":{"name":{"type":"string"},"command":{"type":"string"},"locked":{"type":"boolean"}}},"List of named commands to execute":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Named%20command%20to%20execute"}},"order":{"type":"array","minItems":0,"items":{"type":"string","pattern":"^[\\w-]+$"}},"secrets":{"type":"array","minItems":0,"items":{"type":"string","maxLength":64,"pattern":"^[A-Z_][A-Z0-9_]*$"}},"Model16":{"type":"object"},"stage":{"type":"object","properties":{"name":{"type":"string","pattern":"^[\\w-]+$"}},"required":["name"]},"Model17":{"type":"array","items":{"type":"string","pattern":"^~([\\w-]+)$"}},"Model18":{"type":"array","items":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model17"}}}},"subscribe":{"type":"object","properties":{"scmUrls":{"$ref":"#/components/schemas/Model18"}}},"Job permutation":{"type":"object","properties":{"annotations":{"$ref":"#/components/schemas/Model15"},"blockedBy":{"anyOf":[{"$ref":"#/x-alt-definitions/blockedBy"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}]},"cache":{"$ref":"#/components/schemas/cache"},"commands":{"$ref":"#/components/schemas/List%20of%20named%20commands%20to%20execute"},"description":{"type":"string","maxLength":100},"environment":{"type":"object","properties":{"string":{"type":"string"}}},"freezeWindows":{"anyOf":[{"$ref":"#/x-alt-definitions/freezeWindows"},{"type":"string"}]},"image":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"},"order":{"$ref":"#/components/schemas/order"},"parameters":{"type":"object","properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"provider":{"anyOf":[{"$ref":"#/x-alt-definitions/provider"},{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}]},"requires":{"anyOf":[{"$ref":"#/x-alt-definitions/requires"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]}]},"secrets":{"$ref":"#/components/schemas/secrets"},"settings":{"$ref":"#/components/schemas/Model16"},"sourcePaths":{"anyOf":[{"$ref":"#/x-alt-definitions/sourcePaths"},{"type":"string","maxLength":1024}]},"stage":{"$ref":"#/components/schemas/stage"},"subscribe":{"$ref":"#/components/schemas/subscribe"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}}},"List of job permutations":{"type":"array","items":{"$ref":"#/components/schemas/Job%20permutation"}},"Model19":{"type":"string","description":"Current state of the Job","example":"ENABLED","default":"ENABLED","enum":["ENABLED","DISABLED"],"maxLength":10},"Get Job":{"type":"object","properties":{"title":{"type":"string","maxLength":512},"createTime":{"type":"string","format":"date-time","example":"2018-10-10T21:35:31Z"},"username":{"type":"string","example":"d2lam"},"userProfile":{"type":"string","example":"https://github.com/anonymous","x-format":{"uri":true}},"url":{"type":"string","example":"https://github.com/screwdriver-cd/screwdriver/pull/1","x-format":{"uri":true}},"id":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the Job","example":"main","maxLength":110,"pattern":"^(PR-[0-9]+:)?(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},"prParentJobId":{"type":"integer","description":"Identifier of the parent job for this pr job","example":98765,"x-constraint":{"sign":"positive"}},"permutations":{"$ref":"#/components/schemas/List%20of%20job%20permutations"},"description":{"type":"string","description":"Description of the Job","example":"builds and tests the code","maxLength":100},"pipelineId":{"type":"integer","description":"Identifier of this Pipeline","example":123345,"x-constraint":{"sign":"positive"}},"state":{"$ref":"#/components/schemas/Model19"},"stateChan

# --- truncated at 32 KB (197 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/continuous-delivery-foundation/refs/heads/main/openapi/continuous-delivery-foundation-screwdriver-openapi.json