Job

Cancel job by job number

Cancel job with a given job number.

post/project/{project-slug}/job/{job-number}/cancel

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/project/{project-slug}/job/{job-number}/cancel
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

job-numberunknown required

The number of the job.

project-slugstring required

Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

Response

messagestring required

A human-readable message

Changes

No recorded changes to this operation across all 1 revision of this API.