Chat

Cancel Build

Changed on

Cancel a specific build job.

Requires authentication and ownership verification to prevent a user from aborting another user's running build (DoS via job cancellation). Jobs started via build_public_tmp are explicitly marked public. Jobs without a queue owner or public marker return 404.

post/api/v1/build/{job_id}/cancel

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Path parameters

job_idstring required

Response

Successful Response

messagestring required
successboolean required

Changes

  • 830c31118215Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 0be341779529Revision changes
    • info

      the endpoint scheme security OAuth2PasswordBearerCookie was added to the API

    • info

      the endpoint scheme security OAuth2PasswordBearer was removed from the API