-
Notifications
You must be signed in to change notification settings - Fork 3
Documentation
Tom Withers edited this page Jul 10, 2020
·
1 revision
All URIs are relative to https://circleci.com/api/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| InsightsApi | GetProjectJobRuns | Get /insights/{project-slug}/workflows/{workflow-name}/jobs/{job-name} | Get recent runs of a workflow job |
| InsightsApi | GetProjectWorkflowJobMetrics | Get /insights/{project-slug}/workflows/{workflow-name}/jobs | Get summary metrics for a project workflow's jobs. |
| InsightsApi | GetProjectWorkflowMetrics | Get /insights/{project-slug}/workflows | Get summary metrics for a project's workflows |
| InsightsApi | GetProjectWorkflowRuns | Get /insights/{project-slug}/workflows/{workflow-name} | Get recent runs of a workflow |
| JobApi | CancelJob | Post /project/{project-slug}/job/{job-number}/cancel | Cancel job |
| JobApi | GetJobArtifacts | Get /project/{project-slug}/{job-number}/artifacts | Get a job's artifacts |
| JobApi | GetJobDetails | Get /project/{project-slug}/job/{job-number} | Get job details |
| JobApi | GetTests | Get /project/{project-slug}/{job-number}/tests | Get test metadata |
| PipelineApi | GetPipelineById | Get /pipeline/{pipeline-id} | Get a pipeline |
| PipelineApi | GetPipelineByNumber | Get /project/{project-slug}/pipeline/{pipeline-number} | Get a pipeline |
| PipelineApi | GetPipelineConfigById | Get /pipeline/{pipeline-id}/config | Get a pipeline's configuration |
| PipelineApi | ListMyPipelines | Get /project/{project-slug}/pipeline/mine | Get your pipelines |
| PipelineApi | ListPipelines | Get /pipeline | Get a list of pipelines |
| PipelineApi | ListPipelinesForProject | Get /project/{project-slug}/pipeline | Get all pipelines |
| PipelineApi | ListWorkflowsByPipelineId | Get /pipeline/{pipeline-id}/workflow | Get a pipeline's workflows |
| PipelineApi | TriggerPipeline | Post /project/{project-slug}/pipeline | Trigger a new pipeline |
| PreviewApi | CancelJob | Post /project/{project-slug}/job/{job-number}/cancel | Cancel job |
| PreviewApi | CreateCheckoutKey | Post /project/{project-slug}/checkout-key | Create a new checkout key |
| PreviewApi | CreateEnvVar | Post /project/{project-slug}/envvar | Create an environment variable |
| PreviewApi | DeleteCheckoutKey | Delete /project/{project-slug}/checkout-key/{fingerprint} | Delete a checkout key |
| PreviewApi | DeleteEnvVar | Delete /project/{project-slug}/envvar/{name} | Delete an environment variable |
| PreviewApi | GetCheckoutKey | Get /project/{project-slug}/checkout-key/{fingerprint} | Get a checkout key |
| PreviewApi | GetCollaborations | Get /me/collaborations | Collaborations |
| PreviewApi | GetCurrentUser | Get /me | User Information |
| PreviewApi | GetEnvVar | Get /project/{project-slug}/envvar/{name} | Get a masked environment variable |
| PreviewApi | GetJobArtifacts | Get /project/{project-slug}/{job-number}/artifacts | Get a job's artifacts |
| PreviewApi | GetJobDetails | Get /project/{project-slug}/job/{job-number} | Get job details |
| PreviewApi | GetProjectBySlug | Get /project/{project-slug} | Get a project |
| PreviewApi | GetProjectJobRuns | Get /insights/{project-slug}/workflows/{workflow-name}/jobs/{job-name} | Get recent runs of a workflow job |
| PreviewApi | GetProjectWorkflowJobMetrics | Get /insights/{project-slug}/workflows/{workflow-name}/jobs | Get summary metrics for a project workflow's jobs. |
| PreviewApi | GetProjectWorkflowMetrics | Get /insights/{project-slug}/workflows | Get summary metrics for a project's workflows |
| PreviewApi | GetProjectWorkflowRuns | Get /insights/{project-slug}/workflows/{workflow-name} | Get recent runs of a workflow |
| PreviewApi | GetTests | Get /project/{project-slug}/{job-number}/tests | Get test metadata |
| PreviewApi | GetUser | Get /user/{id} | User Information |
| PreviewApi | ListCheckoutKeys | Get /project/{project-slug}/checkout-key | Get all checkout keys |
| PreviewApi | ListEnvVars | Get /project/{project-slug}/envvar | List all environment variables |
| PreviewApi | ListPipelines | Get /pipeline | Get a list of pipelines |
| ProjectApi | CreateCheckoutKey | Post /project/{project-slug}/checkout-key | Create a new checkout key |
| ProjectApi | CreateEnvVar | Post /project/{project-slug}/envvar | Create an environment variable |
| ProjectApi | DeleteCheckoutKey | Delete /project/{project-slug}/checkout-key/{fingerprint} | Delete a checkout key |
| ProjectApi | DeleteEnvVar | Delete /project/{project-slug}/envvar/{name} | Delete an environment variable |
| ProjectApi | GetCheckoutKey | Get /project/{project-slug}/checkout-key/{fingerprint} | Get a checkout key |
| ProjectApi | GetEnvVar | Get /project/{project-slug}/envvar/{name} | Get a masked environment variable |
| ProjectApi | GetProjectBySlug | Get /project/{project-slug} | Get a project |
| ProjectApi | ListCheckoutKeys | Get /project/{project-slug}/checkout-key | Get all checkout keys |
| ProjectApi | ListEnvVars | Get /project/{project-slug}/envvar | List all environment variables |
| UserApi | GetCollaborations | Get /me/collaborations | Collaborations |
| UserApi | GetCurrentUser | Get /me | User Information |
| UserApi | GetUser | Get /user/{id} | User Information |
| WorkflowApi | ApprovePendingApprovalJobById | Post /workflow/{id}/approve/{approval_request_id} | Approve a job |
| WorkflowApi | CancelWorkflow | Post /workflow/{id}/cancel | Cancel a workflow |
| WorkflowApi | GetWorkflowById | Get /workflow/{id} | Get a workflow |
| WorkflowApi | ListWorkflowJobs | Get /workflow/{id}/job | Get a workflow's jobs |
| WorkflowApi | RerunWorkflow | Post /workflow/{id}/rerun | Rerun a workflow |