Cancel a build

{
  "base":     "\https://api.buddybuild.com/v1",
  "endpoint": "/builds/:build_id:/cancel",
  "method":   "post",
  "params": {
    "headers": [
      {
        "name": "Authorization",
        "type": "Bearer :api-access-token:",
        "req":  true,
        "cue":  "Enter your API access token"
      }
    ],
    "path":   [
      {
        "name": ":build_id:",
        "type": "string",
        "desc": 'Build identifier',
        "req":  true,
        "cue":  'Enter a build id'
      }
    ],
    "query":  [],
    "body":   []
  },
  "authentication": "required"
}

Definition

Placeholder for the definition; auto-generated from JSON above.

Use this method to cancel a build that has not finished yet. This method has no effect on builds that are already finished.

Note

Looking for your API access token?

Parameters

Required = *

Placeholder for the endpoint parameters; auto-generated from JSON above.

curl
curl -X POST \
  -H 'Authorization: Bearer :api-access-token:' \
  'https://api.buddybuild.com/v1/builds/:build_id:/cancel'
jquery
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.buddybuild.com/v1/builds/:build_id:/cancel",
  "method": "POST",
  "headers": {
    "authorization": "Bearer :api-access-token:"
  }
}
$.ajax(settings).done(function (response) {
  console.log(response);
});

results matching ""

    No results matching ""