Build

Learn how to update a build as an admin in the system.

Endpoint

PUT  /api/v1/admin/build

Permissions

COMING SOON!

Responses

Status CodeDescription
200indicates the request has succeeded
401indicates the user does not have proper permissions

Sample

Note: You must provide the entire build object, as this endpoint overwrites the existing entry for the build.

File

{
  "id": 1,
  "repo_id": 1,
  "number": 1,
  "parent": 1,
  "event": "push",
  "status": "created",
  "error": "",
  "enqueued": 1563474077,
  "created": 1563474076,
  "started": 1563474077,
  "finished": 0,
  "deploy": "",
  "clone": "https://github.com/github/octocat.git",
  "source": "https://github.com/github/octocat/commit/48afb5bdc41ad69bf22588491333f7cf71135163",
  "title": "push received from https://github.com/github/octocat",
  "message": "this is an updated message",
  "commit": "48afb5bdc41ad69bf22588491333f7cf71135163",
  "sender": "OctoKitty",
  "author": "OctoKitty",
  "branch": "main",
  "ref": "refs/heads/main",
  "base_ref": "",
  "host": "company.localhost",
  "runtime": "docker",
  "distribution": "linux"
}

Request

curl \
  -X PUT \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "@data.json" \
  "http://127.0.0.1:8080/api/v1/admin/build"

Response

{
  "id": 1,
  "repo_id": 1,
  "number": 1,
  "parent": 1,
  "event": "push",
  "status": "created",
  "error": "",
  "enqueued": 1563474077,
  "created": 1563474076,
  "started": 1563474077,
  "finished": 0,
  "deploy": "",
  "clone": "https://github.com/github/octocat.git",
  "source": "https://github.com/github/octocat/commit/48afb5bdc41ad69bf22588491333f7cf71135163",
  "title": "push received from https://github.com/github/octocat",
  "message": "this is an updated message",
  "commit": "48afb5bdc41ad69bf22588491333f7cf71135163",
  "sender": "OctoKitty",
  "author": "OctoKitty",
  "branch": "main",
  "ref": "refs/heads/main",
  "base_ref": "",
  "host": "company.localhost",
  "runtime": "docker",
  "distribution": "linux"
}