Qodex.ai
Qodex.ai
Introduction
CircleCI API v2
context-{context-id}-environment-variable-{env-var-name}
Remove an environment variableAdd or update an environment variable
context-{context-id}-environment-variable
List environment variables
context-{context-id}
Get a contextDelete a context
context
List contextsCreate a new context
insights-time-series/{project-slug}/workflows
Workflow timeseries dataJob timeseries data
insights-{project-slug}-workflows-{workflow-name}-jobs
Get summary metrics for a project workflow's jobs.Get recent runs of a workflow job
insights-{project-slug}-workflows-{workflow-name}
Get recent runs of a workflowGet metrics and trends for workflowsGet test metrics for a project's workflows
insights-{project-slug}-workflows
Get summary metrics for a project's workflows
insights-{project-slug}
Get all branches for a projectGet flaky tests for a project
insights
Get summary metrics and trends for a project across it's workflows and branchesGet summary metrics with trends for the entire org, and for each project.
me
User InformationCollaborations
pipeline-{pipeline-id}
Get a pipelineGet a pipeline's configurationGet a pipeline's workflows
pipeline
Get a list of pipelinesContinue a pipeline (Preview)
project/{project-slug}-checkout-key-{fingerprint}
Delete a checkout keyGet a checkout key
project/{project-slug}-checkout-key
Get all checkout keysCreate a new checkout key
project/{project-slug}-envvar-{name}
Delete an environment variableGet a masked environment variable
project/{project-slug}-envvar
List all environment variablesCreate an environment variable
project/{project-slug}-job/{job-number}
Get job detailsCancel job
project/{project-slug}-pipeline
Trigger a new pipelineGet all pipelinesGet your pipelinesGet a pipeline
project/{project-slug}-schedule
Create a scheduleGet all schedules
project/{project-slug}-{job-number}
Get a job's artifactsGet test metadata
project/{project-slug}
Get a project
schedule/{schedule-id}
Delete a scheduleGet a scheduleUpdate a schedule
workflow/{id}
Get a workflowApprove a jobCancel a workflowGet a workflow's jobsRerun a workflow
User Information
Introduction
CircleCI API v2
context-{context-id}-environment-variable-{env-var-name}
Remove an environment variableAdd or update an environment variable
context-{context-id}-environment-variable
List environment variables
context-{context-id}
Get a contextDelete a context
context
List contextsCreate a new context
insights-time-series/{project-slug}/workflows
Workflow timeseries dataJob timeseries data
insights-{project-slug}-workflows-{workflow-name}-jobs
Get summary metrics for a project workflow's jobs.Get recent runs of a workflow job
insights-{project-slug}-workflows-{workflow-name}
Get recent runs of a workflowGet metrics and trends for workflowsGet test metrics for a project's workflows
insights-{project-slug}-workflows
Get summary metrics for a project's workflows
insights-{project-slug}
Get all branches for a projectGet flaky tests for a project
insights
Get summary metrics and trends for a project across it's workflows and branchesGet summary metrics with trends for the entire org, and for each project.
me
User InformationCollaborations
pipeline-{pipeline-id}
Get a pipelineGet a pipeline's configurationGet a pipeline's workflows
pipeline
Get a list of pipelinesContinue a pipeline (Preview)
project/{project-slug}-checkout-key-{fingerprint}
Delete a checkout keyGet a checkout key
project/{project-slug}-checkout-key
Get all checkout keysCreate a new checkout key
project/{project-slug}-envvar-{name}
Delete an environment variableGet a masked environment variable
project/{project-slug}-envvar
List all environment variablesCreate an environment variable
project/{project-slug}-job/{job-number}
Get job detailsCancel job
project/{project-slug}-pipeline
Trigger a new pipelineGet all pipelinesGet your pipelinesGet a pipeline
project/{project-slug}-schedule
Create a scheduleGet all schedules
project/{project-slug}-{job-number}
Get a job's artifactsGet test metadata
project/{project-slug}
Get a project
schedule/{schedule-id}
Delete a scheduleGet a scheduleUpdate a schedule
workflow/{id}
Get a workflowApprove a jobCancel a workflowGet a workflow's jobsRerun a workflow
User Information
HomeCircleCI API v2workflow/{id}

workflow/{id}

Number of APIs: 5

  1. Get a workflow GET {{baseUrl}}/workflow/:id

  2. Cancel a workflow POST {{baseUrl}}/workflow/:id/cancel

  3. Get a workflow's jobs GET {{baseUrl}}/workflow/:id/job

  4. Rerun a workflow POST {{baseUrl}}/workflow/:id/rerun

  5. Approve a job POST {{baseUrl}}/workflow/:id/approve/:approval_request_id

Previous
Update a schedule
Next
Get a workflow