Applications

List user applications

List all applications owned by the user or organization. The result will only contain applications that the authenticated user has access to. If the call is made without a token, only public applications will be returned.

GET /api/v3/applications/:username

Querystring values

Name Description
stack Stack used by application. Currently supported: 1 (classic), 6 (Docker enabled)
limit Limit the results that will get returned. Default: 20. Min: 1. Max: 100.
skip Skip a certain amount of builds.
sort Sort builds using this key. Default: nameAsc. Possible values: nameAsc, nameDesc, createdAtAsc, createdAtDesc, updatedAtAsc, updatedAtDesc.

Response

Status: 200 OK
[
  {
    "stack": 6,
    "privacy": "public",
    "createdAt": "2015-01-28T17:04:09.851Z",
    "owner": {
      "meta": {
        "werckerEmployee": false,
        "username": "wercker"
      },
      "userId": "55310d295732ce8a41000054",
      "avatar": {
        "gravatar": "33a5bfbcf8a2b90f40e849b6f1fa5eeb"
      },
      "name": "wercker",
      "type": "wercker"
    },
    "name": "docs",
    "url": "https://app.wercker.com/api/v3/applications/wercker/docs",
    "id": "54c9168980c7075225004157"
  }
]

Get an application

Get the details of a single application.

GET /api/v3/applications/:username/:application

Response

Status: 200 OK
{
  "stack": 6,
  "privacy": "public",
  "id": "54c9168980c7075225004157",
  "url": "https://app.wercker.com/api/v3/applications/wercker/docs",
  "name": "docs",
  "owner": {
    "meta": {
      "werckerEmployee": false,
      "username": "wercker"
    },
    "userId": "55310d295732ce8a41000054",
    "avatar": {
      "gravatar": "33a5bfbcf8a2b90f40e849b6f1fa5eeb"
    },
    "name": "wercker",
    "type": "wercker"
  },
  "builds": "https://app.wercker.com/api/v3/applications/wercker/docs/builds",
  "deploys": "https://app.wercker.com/api/v3/applications/wercker/docs/deploys",
  "scm": {
    "repository": "docs",
    "owner": "wercker",
    "type": "git"
  },
  "createdAt": "2015-01-28T17:04:09.851Z",
  "ignoredBranches": []
}

Update an application

Update a single application. Currently it is only possible to change the ignored branches for the application. The updated application will be returned.

PATCH /api/v3/applications/:username/:application

Payload values

Name Description
ignoredBranches Array containing the new branches. Max 10 branches.

Response

Status: 200 OK
{
  "stack": 6,
  "privacy": "public",
  "id": "54c9168980c7075225004157",
  "url": "https://app.wercker.com/api/v3/applications/wercker/docs",
  "name": "docs",
  "owner": {
    "meta": {
      "werckerEmployee": false,
      "username": "wercker"
    },
    "userId": "55310d295732ce8a41000054",
    "avatar": {
      "gravatar": "33a5bfbcf8a2b90f40e849b6f1fa5eeb"
    },
    "name": "wercker",
    "type": "wercker"
  },
  "builds": "https://app.wercker.com/api/v3/applications/wercker/docs/builds",
  "deploys": "https://app.wercker.com/api/v3/applications/wercker/docs/deploys",
  "scm": {
    "repository": "docs",
    "owner": "wercker",
    "type": "git"
  },
  "createdAt": "2015-01-28T17:04:09.851Z",
  "ignoredBranches": []
}

List builds

Retrieve all builds of an application.

GET /api/v3/applications/:username/:application/builds

Querystring values

Name Description
branch Branch of the commit that triggered a build.
commit Commit of the build that triggered the build. 40 characters.
result Result of the build. Possible values: aborted, unknown, passed, failed.
stack Stack used to run a build. Currently supported: 1 (classic), 6 (Docker enabled)
status Status of the build. Possible values: notstarted, started, finished, running.
limit Limit the results that will get returned. Default: 10. Min: 1. Max: 20.
skip Skip a certain amount of builds.
sort Sort builds using this key. Default: creationDateDesc. Possible values: creationDateAsc, creationDateDesc.

Response

Status: 200 OK
[
  {
    "status": "finished",
    "startedAt": "2015-04-30T17:06:04.686Z",
    "id": "554260f7dc16db44791955a7",
    "url": "https://app.wercker.com/api/v3/builds/554260f7dc16db44791955a7",
    "branch": "hide_api",
    "createdAt": "2015-04-30T17:05:59.209Z",
    "finishedAt": "2015-04-30T17:09:02.753Z",
    "message": "Hide API header",
    "progress": 100,
    "result": "passed"
  }
]

List deploys

Retrieve all deploys of an application.

GET /api/v3/applications/:username/:application/deploys

Querystring values

Name Description
buildId The ID of the build which was used for a deploy.
result Result of the deploy. Possible values: aborted, unknown, passed, failed.
stack Stack used to run a deploy. Currently supported: 1 (classic), 6 (Docker enabled)
status Status of the deploy. Possible values: notstarted, started, finished, running.
limit Limit the results that will get returned. Default: 10. Min: 1. Max: 20.
skip Skip a certain amount of builds.
sort Sort builds using this key. Default: creationDateDesc. Possible values: creationDateAsc, creationDateDesc.

Response

Status: 200 OK
[
  {
    "progress": 100,
    "createdAt": "2015-05-02T21:26:18.834Z",
    "result": "passed",
    "status": "finished",
    "url": "https://app.wercker.com/api/v3/deploys/554540fadc16db447926a82a",
    "id": "554540fadc16db447926a82a"
  }
]