API reference

The seenode REST API: base URL, authentication, and endpoints for automating deployments.

The seenode REST API lets you automate deployments and read account information, for example from a GitHub Actions or GitLab CI/CD pipeline.

Base URL

1
https://api.seenode.com/v1

Authentication

All requests use a Bearer token. Create one in the dashboard (see Create an API token) and send it in the Authorization header:

1
Authorization: Bearer YOUR_API_TOKEN

Endpoints

List teams

1
GET /v1/teams

Returns the teams your token can access.

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.seenode.com/v1/teams

Example response (200 OK):

1
{
2
  "teams": [
3
    {
4
      "id": 12345,
5
      "name": "My Workspace",
6
      "icon": "0",
7
      "created": "2025-06-17T11:14:22",
8
      "membersCount": 1,
9
      "servicesLimit": 10,
10
      "billingThreshold": 200,
11
      "freeTrialAvailable": false,
12
      "freeTrialEnds": "2025-06-23T11:20:00",
13
      "lowCreditPrevention": null,
14
      "topUpAmount": null
15
    }
16
  ]
17
}

Field	Description
`id`	Team identifier
`name`	Team name
`icon`	Team icon
`created`	Creation timestamp
`membersCount`	Number of members
`servicesLimit`	Maximum services allowed on the team
`billingThreshold`	Spend threshold, in dollars
`freeTrialAvailable`	Whether a free trial is available
`freeTrialEnds`	Trial end timestamp (or `null`)
`lowCreditPrevention`	Auto top-up configuration (or `null`)
`topUpAmount`	Configured top-up amount (or `null`)

Trigger a deployment

1
POST /v1/applications/{applicationId}/deployments

Deploys a specific commit of an application.

curl -X POST \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"gitCommitSha": "<commit-sha>"}' \
  https://api.seenode.com/v1/applications/APPLICATION_ID/deployments

Request body:

Field	Description
`gitCommitSha`	The Git commit SHA to deploy (must exist in the connected repository)

A successful call returns 201 Created. The new deployment is nested under a deployment key. The full response embeds the resolved build settings (image, build/start commands, port) as applicationBuildSettings:

1
{
2
  "deployment": {
3
    "applicationBuildSettings": {
4
      "buildCommand": "go build -o app ./cmd/server",
5
      "continuousDelivery": false,
6
      "created": "Sat, 11 Jul 2026 22:37:43 GMT",
7
      "id": 1945778,
8
      "image": {
9
        "dockerImageDefaultCommands": {
10
          "buildCommand": "go build -v -o app main.go",
11
          "id": 3,
12
          "runCommand": "./app"
13
        },
14
        "dockerImageDefaultCommandsId": 3,
15
        "enabled": true,
16
        "id": 15,
17
        "imageRepository": "golang",
18
        "imageTag": "1.24",
19
        "name": "Golang 1.24",
20
        "note": "Public Golang 1.24",
21
        "type": "application"
22
      },
23
      "imageId": 15,
24
      "port": 8080,
25
      "rootDirectory": "",
26
      "runCommand": "./app"
27
    },
28
    "applicationBuildSettingsId": 1945778,
29
    "applicationId": 969217,
30
    "builtImage": null,
31
    "created": "Sun, 12 Jul 2026 09:00:28 GMT",
32
    "deployIsLive": false,
33
    "finished": null,
34
    "gitCommitAuthor": "Jane Developer",
35
    "gitCommitDate": "Tue, 16 Dec 2025 11:48:38 GMT",
36
    "gitCommitMessage": "Update service",
37
    "gitCommitSha": "a1b2c3d4e5f6…",
38
    "message": null,
39
    "sentryId": null,
40
    "started": null,
41
    "state": "NEW",
42
    "uuid": "3f2b1a9c-…"
43
  }
44
}

The deployment object fields:

Field	Description
`applicationBuildSettings`	The resolved build configuration used for this deployment: the runtime `image`, `buildCommand`, `runCommand`, `port`, `rootDirectory`, `deploymentTimeout`, and `continuousDelivery` flag
`applicationBuildSettingsId`	ID of the build-settings record
`applicationId`	The application this deployment belongs to
`builtImage`	Registry path of the built container image, or `null` until the build finishes
`created`	When the deployment was created
`deployIsLive`	Whether this deployment is currently serving traffic
`finished`	Build/finish timestamp, or `null` while in progress
`gitCommitAuthor`	Commit author
`gitCommitDate`	Commit date
`gitCommitMessage`	Commit message
`gitCommitSha`	The deployed commit
`message`	Status/error message, or `null`
`sentryId`	Associated Sentry event ID, or `null`
`started`	When the build started, or `null`
`state`	Deployment state: `NEW`, `RUNNING`, and so on
`uuid`	Deployment UUID

The deployment starts in state: "NEW"; state, started, builtImage, finished, and deployIsLive fill in as the build progresses. An unknown or missing commit returns 500 with {"error": "Commit SHA: … not found in the repository: <owner>/<repo>."}.

List deployments

1
GET /v1/applications/{applicationId}/deployments

Returns the most recent and currently-live deployments for an application.

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.seenode.com/v1/applications/APPLICATION_ID/deployments

Example response (200 OK). Each entry is a full deployment object (the applicationBuildSettings block is omitted below for brevity):

1
{
2
  "deployments": {
3
    "lastDeployment": {
4
      "applicationBuildSettingsId": 1945778,
5
      "applicationId": 969217,
6
      "builtImage": null,
7
      "created": "2026-07-12 09:00:28",
8
      "deployIsLive": false,
9
      "finished": null,
10
      "gitCommitAuthor": "Jane Developer",
11
      "gitCommitDate": "2025-12-16 11:48:38",
12
      "gitCommitMessage": "Update service",
13
      "gitCommitSha": "a1b2c3d4e5f6…",
14
      "message": null,
15
      "sentryId": null,
16
      "started": "2026-07-12 09:00:28",
17
      "state": "RUNNING",
18
      "uuid": "3f2b1a9c-…"
19
    },
20
    "liveDeployment": {
21
      "applicationBuildSettingsId": 1945778,
22
      "applicationId": 969217,
23
      "builtImage": "registry.example.com/seenode/production/<image-uuid>:<tag-uuid>",
24
      "created": "2026-07-12 08:59:56",
25
      "deployIsLive": true,
26
      "finished": "2026-07-12 09:00:39",
27
      "gitCommitAuthor": "Jane Developer",
28
      "gitCommitDate": "2025-12-16 11:48:38",
29
      "gitCommitMessage": "Update service",
30
      "gitCommitSha": "a1b2c3d4e5f6…",
31
      "message": null,
32
      "sentryId": null,
33
      "started": "2026-07-12 08:59:56",
34
      "state": "RUNNING",
35
      "uuid": "7c4e0d2b-…"
36
    }
37
  }
38
}

Field	Description
`deployments.lastDeployment`	The most recently created deployment. May still be building; watch `state` progress from `NEW` to `RUNNING`.
`deployments.liveDeployment`	The deployment currently serving traffic (`deployIsLive: true`, with a `builtImage` and a `finished` timestamp). `null` if nothing is live yet.

Both entries are the same deployment object returned by Trigger a deployment. Note that this endpoint formats timestamps as YYYY-MM-DD HH:MM:SS, whereas the trigger endpoint returns RFC-1123 dates (Sun, 12 Jul 2026 09:00:28 GMT).

Finding your application ID: open the application in the dashboard: the ID is in the URL, e.g. …/dashboard/applications?applicationId=969217 → 969217.