Skip to content

Latest commit

 

History

History
129 lines (129 loc) · 31.9 KB

ROUTES.md

File metadata and controls

129 lines (129 loc) · 31.9 KB
Raw
Name Method Path Status Added Removed Notes
SaveConfig PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/config Done < 1.0.0 - Team name prefix added in v1.3.0
GetConfig GET /api/v1/teams/:team_name/pipelines/:pipeline_name/config Later < 1.0.0 - Team name prefix added in v1.3.0
CreateBuild POST /api/v1/teams/:team_name/builds Now < 1.0.0 - Renamed from /api/v1/builds in v3.10.0
ListBuilds GET /api/v1/builds Done < 1.0.0 -
GetBuild GET /api/v1/builds/:build_id Done < 1.0.0 -
GetBuildPlan GET /api/v1/builds/:build_id/plan Later < 1.0.0 -
SendInputToBuildPlan PUT /api/v1/builds/:build_id/plan/:plan_id/input Later 3.10.0 5.1.0
ReadOutputFromBuildPlan GET /api/v1/builds/:build_id/plan/:plan_id/output Later 3.10.0 5.1.0
BuildEvents GET /api/v1/builds/:build_id/events Later < 1.0.0 -
BuildResources GET /api/v1/builds/:build_id/resources Done < 1.0.0 -
AbortBuild PUT /api/v1/builds/:build_id/abort Later < 1.0.0 - Changed from POST to PUT in v2.7.2
GetBuildPreparation GET /api/v1/builds/:build_id/preparation Later < 1.0.0 -
ListBuildArtifacts GET /api/v1/builds/:build_id/artifacts Later 5.1.0 -
GetCheck GET /api/v1/checks/:check_id Later 5.6.0 master
ListAllJobs GET /api/v1/jobs Done 3.13.0 -
ListJobs GET /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs Done < 1.0.0 - Team name prefix added in v1.3.0
GetJob GET /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name Done < 1.0.0 - Team name prefix added in v1.3.0
ListJobBuilds GET /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/builds Done < 1.0.0 - Team name prefix added in v1.3.0
CreateJobBuild POST /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/builds Done < 1.0.0 - Team name prefix added in v1.3.0
RerunJobBuild POST /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/builds/:build_name Later 6.0.0 -
ListJobInputs GET /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/inputs Done < 1.0.0 - Team name prefix added in v1.3.0
GetJobBuild GET /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/builds/:build_name Done < 1.0.0 - Team name prefix added in v1.3.0
PauseJob PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/pause Done < 1.0.0 - Team name prefix added in v1.3.0
UnpauseJob PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/unpause Done < 1.0.0 - Team name prefix added in v1.3.0
ScheduleJob PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/schedule Later 6.0.0 -
JobBadge GET /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/badge Later < 1.0.0 - Team name prefix added in v1.3.0
MainJobBadge GET /api/v1/pipelines/:pipeline_name/jobs/:job_name/badge Later 1.3.0 -
ClearTaskCache DELETE /api/v1/teams/:team_name/pipelines/:pipeline_name/jobs/:job_name/tasks/:step_name/cache Later 4.1.0 -
ListAllPipelines GET /api/v1/pipelines Done 1.3.1 -
ListPipelines GET /api/v1/teams/:team_name/pipelines Done < 1.0.0 - Team name prefix added in v1.3.0
GetPipeline GET /api/v1/teams/:team_name/pipelines/:pipeline_name Done < 1.0.0 - Team name prefix added in v1.3.0
DeletePipeline DELETE /api/v1/teams/:team_name/pipelines/:pipeline_name Done < 1.0.0 - Team name prefix added in v1.3.0
OrderPipelines PUT /api/v1/teams/:team_name/pipelines/ordering Later < 1.0.0 - Team name prefix added in v1.3.0
PausePipeline PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/pause Done < 1.0.0 - Team name prefix added in v1.3.0
ArchivePipeline PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/archive Now 6.1.0 -
UnpausePipeline PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/unpause Done < 1.0.0 - Team name prefix added in v1.3.0
ExposePipeline PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/expose Later 1.3.1 - Renamed from /.../reveal in v2.0.0
HidePipeline PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/hide Later 1.3.1 - Renamed from /.../conceal in v2.0.0
GetVersionsDB GET /api/v1/teams/:team_name/pipelines/:pipeline_name/versions-db Later < 1.0.0 - Team name prefix added in v1.3.0
RenamePipeline PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/rename Done 0.76.0 - Team name prefix added in v1.3.0
ListPipelineBuilds GET /api/v1/teams/:team_name/pipelines/:pipeline_name/builds Done 3.12.0 -
CreatePipelineBuild POST /api/v1/teams/:team_name/pipelines/:pipeline_name/builds Now 3.3.3 -
PipelineBadge GET /api/v1/teams/:team_name/pipelines/:pipeline_name/badge Later 3.7.0 -
ListAllResources GET /api/v1/resources Done 3.14.0 -
ListResources GET /api/v1/teams/:team_name/pipelines/:pipeline_name/resources Done < 1.0.0 - Team name prefix added in v1.3.0
ListResourceTypes GET /api/v1/teams/:team_name/pipelines/:pipeline_name/resource-types Done 3.14.0 -
GetResource GET /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name Done < 1.0.0 - Team name prefix added in v1.3.0
PauseResource PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/pause Done < 1.0.0 5.2.0 Team name prefix added in v1.3.0
UnpauseResource PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/unpause Done < 1.0.0 5.2.0 Team name prefix added in v1.3.0
CheckResource POST /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/check Later 1.2.0 - Team name prefix added in v1.3.0
CheckResourceWebHook POST /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/check/webhook Later 2.7.4 -
CheckResourceType POST /api/v1/teams/:team_name/pipelines/:pipeline_name/resource-types/:resource_type_name/check Later 4.2.0 -
ListResourceVersions GET /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/versions Done < 1.0.0 - Team name prefix added in v1.3.0
GetResourceVersion GET /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/versions/:resource_config_version_id Done 3.7.0 -
EnableResourceVersion PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/versions/:resource_config_version_id/enable Later < 1.0.0 - Team name prefix added in v1.3.0
DisableResourceVersion PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/versions/:resource_config_version_id/disable Later < 1.0.0 - Team name prefix added in v1.3.0
PinResourceVersion PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/versions/:resource_config_version_id/pin Later 5.0.0 -
UnpinResource PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/unpin Later 5.0.0 -
SetPinCommentOnResource PUT /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/pin_comment Later 5.0.0 -
ListBuildsWithVersionAsInput GET /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/versions/:resource_config_version_id/input_to Done < 1.0.0 - Team name prefix added in v1.3.0
ListBuildsWithVersionAsOutput GET /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/versions/:resource_config_version_id/output_of Done < 1.0.0 - Team name prefix added in v1.3.0
GetResourceCausality GET /api/v1/teams/:team_name/pipelines/:pipeline_name/resources/:resource_name/versions/:resource_version_id/causality Done 3.7.0 -
CreatePipe POST /api/v1/teams/:team_name/pipes Later < 1.0.0 3.10.0
WritePipe PUT /api/v1/teams/:team_name/pipes/:pipe_id Later < 1.0.0 3.10.0
ReadPipe GET /api/v1/teams/:team_name/pipes/:pipe_id Later < 1.0.0 3.10.0
GetCC GET /api/v1/teams/:team_name/cc.xml Later 5.0.0 -
ListWorkers GET /api/v1/workers Done < 1.0.0 -
RegisterWorker POST /api/v1/workers Later < 1.0.0 -
LandWorker PUT /api/v1/workers/:worker_name/land Later 2.7.0 -
RetireWorker PUT /api/v1/workers/:worker_name/retire Later 2.6.0 -
PruneWorker PUT /api/v1/workers/:worker_name/prune Done 2.7.0 -
HeartbeatWorker PUT /api/v1/workers/:worker_name/heartbeat Later 2.7.0 -
DeleteWorker DELETE /api/v1/workers/:worker_name Later 2.6.0 -
GetLogLevel GET /api/v1/log-level Later < 1.0.0 -
SetLogLevel PUT /api/v1/log-level Later < 1.0.0 -
DownloadCLI GET /api/v1/cli Later < 1.0.0 -
GetInfo GET /api/v1/info Done < 1.0.0 -
GetInfoCreds GET /api/v1/info/creds Later 4.0.0 -
GetUser GET /api/v1/user Later 6.1.0 -
ListActiveUsersSince GET /api/v1/users Later 5.5.0 -
ListDestroyingContainers GET /api/v1/containers/destroying Later 3.14.0 -
ReportWorkerContainers PUT /api/v1/containers/report Later 3.14.0 -
ListContainers GET /api/v1/teams/:team_name/containers Done < 1.0.0 - Renamed from /api/v1/containers in 3.10.0
GetContainer GET /api/v1/teams/:team_name/containers/:id Done < 1.0.0 - Renamed from /api/v1/containers/:id in 3.10.0
HijackContainer GET /api/v1/teams/:team_name/containers/:id/hijack Later < 1.0.0 - Renamed from /api/v1/containers/:id/hijack in 3.10.0
ListVolumes GET /api/v1/teams/:team_name/volumes Done < 1.0.0 - Renamed from /api/v1/volumes in 3.10.0
ListDestroyingVolumes GET /api/v1/volumes/destroying Later 3.14.0 -
ReportWorkerVolumes PUT /api/v1/volumes/report Later 3.14.0 -
ListAuthMethods GET /api/v1/teams/:team_name/auth/methods Later < 1.0.0 3.9.0 Team name prefix added in v1.3.0
GetAuthToken GET /api/v1/teams/:team_name/auth/token Later < 1.0.0 3.9.0 Team name prefix added in v1.3.0
GetAccessToken GET /api/v1/teams/:team_name/auth/access_token Later 2.7.5 2.7.5
GetUser GET /api/v1/user Later 2.0.0 3.9.0
LegacyListAuthMethods GET /api/v1/teams/:team_name/auth/methods Later 3.9.0 4.0.0
LegacyGetAuthToken GET /api/v1/teams/:team_name/auth/token Later 3.9.0 4.0.0
LegacyGetUser GET /api/v1/user Later 3.9.0 4.0.0
ListTeams GET /api/v1/teams Done 2.0.0 -
GetTeam GET /api/v1/teams/:team_name Now 5.2.0 -
SetTeam PUT /api/v1/teams/:team_name Done < 1.0.0 -
RenameTeam PUT /api/v1/teams/:team_name/rename Done 3.9.0 -
DestroyTeam DELETE /api/v1/teams/:team_name Done 2.7.0 -
ListTeamBuilds GET /api/v1/teams/:team_name/builds Done 3.13.0 -
CreateArtifact POST /api/v1/teams/:team_name/artifacts Later 5.1.0 -
GetArtifact GET /api/v1/teams/:team_name/artifacts/:artifact_id Later 5.1.0 -
GetWall GET /api/v1/wall Later 6.0.0 -
SetWall PUT /api/v1/wall Later 6.0.0 -
ClearWall DELETE /api/v1/wall Later 6.0.0 -