Ctrlk
APIMCPOpen portal
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Builds

Follow repository builds, read builder logs and trigger a deployment.

List the builds of a GitHub-sourced app, newest first

get

Requires apps:read (View apps, their configuration and status).

Authorizations
AuthorizationstringRequired

An API key from Account settings, e.g. kn_...

Path parameters
projectIdstringRequired

Project id

Pattern: ^[0-9a-fA-F]{24}$
appIdstringRequired

App id

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
limitinteger · min: 1 · max: 200Optional

Items per page, 1 to 200 (default 50)

cursorstring · min: 1 · max: 512Optional

nextCursor from the previous page; omit for the first page

Responses
200

OK

application/json
get/projects/{projectId}/apps/{appId}/builds
GET /v1/projects/{projectId}/apps/{appId}/builds HTTP/1.1
Host: api.kinesis.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "builds": [
    {
      "id": "text",
      "appId": "text",
      "status": "pending",
      "step": "vcs_import",
      "imageBuildStatus": null,
      "source": {
        "repo": null,
        "branch": null,
        "commitSha": null,
        "commitMessage": null,
        "contextDir": null,
        "dockerfilePath": null
      },
      "error": {
        "step": "text",
        "message": "text",
        "code": null
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "startedAt": "2026-01-01T00:00:00.000Z",
      "finishedAt": "2026-01-01T00:00:00.000Z",
      "pollAfterSec": 1
    }
  ],
  "nextCursor": null
}

Start a new build of a GitHub-sourced app from its branch head, or from one commit, cancelling any build still running. The app is redeployed and started when the build succeeds; poll apps.builds.get to follow it.

post

Requires apps:write (Create, update, start, stop, restart and rebuild apps), compute:spend (Spend credits: start, scale or resize apps, provision or wake servers, rent spot instances).

Errors specific to this operation:

  • 409 app_source_unsupported: The app is not built from a repository

  • 403 serverless_disabled: The app would run on Kinesis serverless capacity, which the organization keeps to its admins; target a grid

  • 503 github_not_configured: GitHub deployments are not enabled on this server

  • 404 github_installation_not_found: The caller has no connected GitHub account with this installation id; connect it in the dashboard

  • 404 github_repo_not_found: The installation cannot see the repository; grant the GitHub App access to it

  • 502 upstream_github: GitHub did not answer; retry shortly

  • 404 github_commit_not_found: No commit has this sha

Authorizations
AuthorizationstringRequired

An API key from Account settings, e.g. kn_...

Path parameters
projectIdstringRequired

Project id

Pattern: ^[0-9a-fA-F]{24}$
appIdstringRequired

App id

Pattern: ^[0-9a-fA-F]{24}$
Body
commitShastringOptional

Commit to build instead of the branch head

Pattern: ^[0-9a-fA-F]{7,40}$
Responses
202

Accepted

application/json
post/projects/{projectId}/apps/{appId}/builds
POST /v1/projects/{projectId}/apps/{appId}/builds HTTP/1.1
Host: api.kinesis.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "commitSha": "text"
}
{
  "build": {
    "id": "text",
    "appId": "text",
    "status": "pending",
    "step": "vcs_import",
    "imageBuildStatus": null,
    "source": {
      "repo": null,
      "branch": null,
      "commitSha": null,
      "commitMessage": null,
      "contextDir": null,
      "dockerfilePath": null
    },
    "error": {
      "step": "text",
      "message": "text",
      "code": null
    },
    "createdAt": "2026-01-01T00:00:00.000Z",
    "startedAt": "2026-01-01T00:00:00.000Z",
    "finishedAt": "2026-01-01T00:00:00.000Z",
    "pollAfterSec": 1
  },
  "cancelledBuilds": 1
}

Get one build: its status, pipeline step, source commit and error

get

Requires apps:read (View apps, their configuration and status).

Authorizations
AuthorizationstringRequired

An API key from Account settings, e.g. kn_...

Path parameters
projectIdstringRequired

Project id

Pattern: ^[0-9a-fA-F]{24}$
appIdstringRequired

App id

Pattern: ^[0-9a-fA-F]{24}$
buildIdstringRequired

Build id

Pattern: ^[0-9a-fA-F]{24}$
Responses
200

OK

application/json
get/projects/{projectId}/apps/{appId}/builds/{buildId}
GET /v1/projects/{projectId}/apps/{appId}/builds/{buildId} HTTP/1.1
Host: api.kinesis.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "appId": "text",
  "status": "pending",
  "step": "vcs_import",
  "imageBuildStatus": null,
  "source": {
    "repo": null,
    "branch": null,
    "commitSha": null,
    "commitMessage": null,
    "contextDir": null,
    "dockerfilePath": null
  },
  "error": {
    "step": "text",
    "message": "text",
    "code": null
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "startedAt": "2026-01-01T00:00:00.000Z",
  "finishedAt": "2026-01-01T00:00:00.000Z",
  "pollAfterSec": 1
}

Read the image builder's log for a build. The whole log once the build has finished, a snapshot of what has been written so far while it runs (empty until the builder starts writing).

get

Requires monitoring:read (Read usage metrics, app logs, build logs and server logs).

Authorizations
AuthorizationstringRequired

An API key from Account settings, e.g. kn_...

Path parameters
projectIdstringRequired

Project id

Pattern: ^[0-9a-fA-F]{24}$
appIdstringRequired

App id

Pattern: ^[0-9a-fA-F]{24}$
buildIdstringRequired

Build id

Pattern: ^[0-9a-fA-F]{24}$
Responses
200

OK

application/json
get/projects/{projectId}/apps/{appId}/builds/{buildId}/logs
GET /v1/projects/{projectId}/apps/{appId}/builds/{buildId}/logs HTTP/1.1
Host: api.kinesis.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "status": "pending",
  "imageBuildStatus": null,
  "lines": [
    "text"
  ],
  "complete": true,
  "truncated": true
}
PreviousApps
NextDomains

Was this helpful?