Sign in
Chat

Cancel Build

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 with no registered owner (build_public_tmp) are accessible to any authenticated user, consistent with get_build_events.

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

Path parameters

job_idstring required

Response

Successful Response

messagestring required
successboolean required

Changes

Changed in 6 of the 22 revisions of this API.214

  • 830c311182152See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0be3417795292See the full diff
    • ○

      the endpoint scheme security OAuth2PasswordBearerCookie was added to the API

      api-security-added

    • ○

      the endpoint scheme security OAuth2PasswordBearer was removed from the API

      api-security-removed

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 191b57fc530b2See the full diff
    • ○

      the endpoint scheme security OAuth2PasswordBearer was added to the API

      api-security-added

    • ○

      the endpoint scheme security OAuth2PasswordBearerCookie was removed from the API

      api-security-removed

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0be3417795292See the full diff
    • ○

      the endpoint scheme security OAuth2PasswordBearerCookie was added to the API

      api-security-added

    • ○

      the endpoint scheme security OAuth2PasswordBearer was removed from the API

      api-security-removed

    This revision also has 59 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b0ee9ddb8d9f3See the full diff
    • ○

      the endpoint scheme security API key header was added to the API

      api-security-added

    • ○

      the endpoint scheme security API key query was added to the API

      api-security-added

    • ○

      the endpoint scheme security OAuth2PasswordBearer was added to the API

      api-security-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9bd3e81318d723See the full diff
    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      the endpoint scheme security API key header was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security API key query was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security OAuth2PasswordBearerCookie was removed from the API

      api-security-removed

    This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog