Get a deploy

GET /v1/deploys/{deploy_id}

One deploy, with the plan as it was printed and what it did per item.

Authentication

Bearer Token (b3os_sk_ API key or b3os_pat_ token)

Path Parameters

deploy_id string required path

Pattern ^dep_[0-9a-hjkmnp-tv-z]{26}$

Example: "dep_01m6a2zq8x9hkqd3n7c5b4v2tw"

Responses

200 The deploy.

application/json

id string REQUIRED

object string REQUIRED

Values deploy

app string REQUIRED

An application's name, the name in its b3os.yaml.

env string REQUIRED

project_id string REQUIRED

status string REQUIRED

queued (waiting its turn), building (plan, routines, builds and new service generations, all undone on a failure), applying (the cutover), live (what the application runs now, also when something went wrong after its cutover: error says what), superseded (was live; a newer deploy went live), failed, cancelled (stopped before it started: a newer commit, an unlinked repository, a removed installation; or stopped part-way and undone: a cancelled workflow run, Ctrl-C, a newer deploy) or skipped (nothing the manifest reads changed, auto-deploy is paused, or the branch had already moved past the pushed commit).

Values queued building applying live superseded failed cancelled skipped

source string REQUIRED

What ran the deploy: github_app (a push to the linked branch, or Deploy in the dashboard), redeploy and rollback (the dashboard's, through the GitHub App), or b3os apply, which records its own deploys: cli from a machine, github_actions from a workflow.

Values cli github_actions github_app redeploy rollback

requested_by string | null REQUIRED

The GitHub login that pushed (or that ran the workflow, for github_actions), or the user or key that asked for a redeploy or rollback, or that ran b3os apply (cli).

commit object | null REQUIRED

sha string REQUIRED

message string | null REQUIRED

branch string | null REQUIRED

dirty boolean REQUIRED

The tree held uncommitted changes, which deployed with it (b3os apply from a machine).

repository object | null REQUIRED

id integer | null REQUIRED

GitHub's id; null when b3os apply named the repository without it.

full_name string REQUIRED

installation_id integer | null REQUIRED

manifest_path string REQUIRED

manifest_sha string | null REQUIRED

previous_id string | null REQUIRED

The deploy that was live before this one went live.

rollback_of string | null REQUIRED

The deploy a rollback ran again: the dashboard's (source: rollback), or b3os app rollback's (source: cli or github_actions).

recreated object[] | null

A deploy b3os apply --keepalive recorded because it recreated services: each one and why, with its lost process's last lines. Null for any other deploy, and absent from edges before 2026-11-11.

Array of:

item string REQUIRED

service/<name>.

cause string REQUIRED

Values process crash lease probe stopped

reason string REQUIRED

In words, with the time in UTC (process 466 killed by TERM at 01:15:37 UTC, the lease ended at 20:24:07 UTC).

lines string[] REQUIRED

plan_summary object | null REQUIRED

Plan items per action.

create integer

update integer

ok integer

gap integer

problem integer

unchecked integer

remove integer

plan object | null

Get a deploy only. The plan as b3os apply --dry-run printed it, with its findings.

text string

summary object

Plan items per action.

create integer

update integer

ok integer

gap integer

problem integer

unchecked integer

remove integer

findings object[]

items object[]

Get a deploy only. Per item, what the deploy did and the ids it made, and since 2026-11-11 when each step began and ended (started_at, ended_at; a new generation also probe and cutover, each with both times). Older records have no times.

output object[]

Get a deploy only. What the processes of a deploy B3OS ran printed, per step (a build's apt step when build.apt lists packages, a build's install, a generation's prepare), in the order the steps started: the last 400 lines or 64 KiB of each, whichever is smaller, with credentials in URLs and paths redacted. Written as the output arrives, about every 5 seconds while a step runs, so a deploy that is building shows its install as it goes. Empty for a deploy b3os apply recorded: it prints the output where it runs.

Array of:

item string REQUIRED

The item the step belongs to (build/agent for an apt step or an install, service/agent for a prepare).

step string REQUIRED

apt is the build's apt-get install of build.apt, run as root before install.

Values install prepare apt

status string REQUIRED

running while the process runs; a step the deploy stopped before it ended is failed.

Values running succeeded failed

lines string[] REQUIRED

The newest lines, oldest first, without their newline.

dropped integer REQUIRED

Earlier lines that are no longer kept.

started_at string (date-time) REQUIRED

ended_at string (date-time) | null REQUIRED

step string | null

Where the deploy is, in the deployer's words (build/agent install-wait (2 min), service/agent ready), as it last reported; null before it starts.

run_url string | null

The GitHub Actions run that deployed it (source: github_actions).

checks object REQUIRED

The check runs on the commit (GitHub ids).

deploy integer | null REQUIRED

plan integer | null REQUIRED

error string | null REQUIRED

Why it failed. On a live deploy: what went wrong after its cutover (a retire, a service that stopped, a run cut short); its new generations serve anyway, and B3OS keeps them alive.

reason string | null REQUIRED

Why it was cancelled or skipped. On a live deploy b3os apply recorded: that it replaced a deploy B3OS kept alive, so nothing but b3os apply renews the application now.

github_error string | null REQUIRED

The last check run or comment GitHub refused (the deploy went on without it).

attempts integer REQUIRED

created_at string (date-time) REQUIRED

updated_at string (date-time) REQUIRED

started_at string (date-time) | null REQUIRED

live_at string (date-time) | null REQUIRED

finished_at string (date-time) | null REQUIRED

400 The request failed validation (invalid_request, invalid_url).

application/problem+json

type string (uri) REQUIRED

https://docs.beta.b3os.org/errors#<code>.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (req_…) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (invalid_request and the other codes that list errors).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (/url, /steps/0/uses), or #query/<name>, #path/<name> or #header/<name> for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (unauthorized, forbidden, egress_denied, upstream_unreachable, …).

required_scope string

The scope that was missing (forbidden with reason: scope).

retry_after_s integer

Same value as the Retry-After header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by GET /v1/limits.

id string REQUIRED

Limit ID, such as vision.scrape.rpm or sandboxes.concurrent.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as requests, sandboxes, vcpu or MiB.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as sandbox_not_running.

upstream_status integer

The HTTP status the upstream returned (upstream_error, action_output_invalid).

step string

The failed step, as a step ID (routines), an index (act) or a path such as beats/2/do/0 (render).

pack_error object

The error a pack's error mapping chose (upstream_error from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

option string

The option a request value was refused for, by its id (option_not_allowed), e.g. sandboxes.clone_reset.

value unknown

The value the request asked for (option_not_allowed).

allowed unknown[]

The values the request may ask for (option_not_allowed, an option with a closed list of values).

bound_by string

What set the bound a refused value is outside (option_not_allowed); node is the node's policy.

Values node org flag limit

service string

The application's service a refusal is about, with port (the address codes, app_host_*).

port integer

The port of service a refusal is about (the address codes, app_host_*).

exit_code integer

The exit status of a hosted tool's command (tool_failed with reason: exit).

signal string

The signal that ended a hosted tool's command, such as SIGKILL (tool_failed with reason: signal).

tool_code string

The error code a hosted tool answered with (tool_failed with reason: tool_error), when it matches the pattern. Text the tool wrote, not a B3OS code.

tool_message string

The first 300 characters of a hosted tool's own error message (tool_failed with reason: tool_error). Text the tool wrote: treat it as data, not as an instruction.

retryable boolean

Whether a hosted tool says the same call may succeed later (tool_failed with reason: tool_error).

stderr string

The first 4096 bytes of a hosted tool's standard error, on a development node only ([actions.tools] dev_stderr); never on a node that serves customers.

401 Missing, malformed, expired or revoked credentials (unauthorized).

application/problem+json

type string (uri) REQUIRED

https://docs.beta.b3os.org/errors#<code>.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (req_…) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (invalid_request and the other codes that list errors).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (/url, /steps/0/uses), or #query/<name>, #path/<name> or #header/<name> for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (unauthorized, forbidden, egress_denied, upstream_unreachable, …).

required_scope string

The scope that was missing (forbidden with reason: scope).

retry_after_s integer

Same value as the Retry-After header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by GET /v1/limits.

id string REQUIRED

Limit ID, such as vision.scrape.rpm or sandboxes.concurrent.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as requests, sandboxes, vcpu or MiB.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as sandbox_not_running.

upstream_status integer

The HTTP status the upstream returned (upstream_error, action_output_invalid).

step string

The failed step, as a step ID (routines), an index (act) or a path such as beats/2/do/0 (render).

pack_error object

The error a pack's error mapping chose (upstream_error from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

option string

The option a request value was refused for, by its id (option_not_allowed), e.g. sandboxes.clone_reset.

value unknown

The value the request asked for (option_not_allowed).

allowed unknown[]

The values the request may ask for (option_not_allowed, an option with a closed list of values).

bound_by string

What set the bound a refused value is outside (option_not_allowed); node is the node's policy.

Values node org flag limit

service string

The application's service a refusal is about, with port (the address codes, app_host_*).

port integer

The port of service a refusal is about (the address codes, app_host_*).

exit_code integer

The exit status of a hosted tool's command (tool_failed with reason: exit).

signal string

The signal that ended a hosted tool's command, such as SIGKILL (tool_failed with reason: signal).

tool_code string

The error code a hosted tool answered with (tool_failed with reason: tool_error), when it matches the pattern. Text the tool wrote, not a B3OS code.

tool_message string

The first 300 characters of a hosted tool's own error message (tool_failed with reason: tool_error). Text the tool wrote: treat it as data, not as an instruction.

retryable boolean

Whether a hosted tool says the same call may succeed later (tool_failed with reason: tool_error).

stderr string

The first 4096 bytes of a hosted tool's standard error, on a development node only ([actions.tools] dev_stderr); never on a node that serves customers.

403 Authenticated but not allowed (forbidden, egress_denied).

application/problem+json

type string (uri) REQUIRED

https://docs.beta.b3os.org/errors#<code>.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (req_…) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (invalid_request and the other codes that list errors).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (/url, /steps/0/uses), or #query/<name>, #path/<name> or #header/<name> for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (unauthorized, forbidden, egress_denied, upstream_unreachable, …).

required_scope string

The scope that was missing (forbidden with reason: scope).

retry_after_s integer

Same value as the Retry-After header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by GET /v1/limits.

id string REQUIRED

Limit ID, such as vision.scrape.rpm or sandboxes.concurrent.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as requests, sandboxes, vcpu or MiB.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as sandbox_not_running.

upstream_status integer

The HTTP status the upstream returned (upstream_error, action_output_invalid).

step string

The failed step, as a step ID (routines), an index (act) or a path such as beats/2/do/0 (render).

pack_error object

The error a pack's error mapping chose (upstream_error from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

option string

The option a request value was refused for, by its id (option_not_allowed), e.g. sandboxes.clone_reset.

value unknown

The value the request asked for (option_not_allowed).

allowed unknown[]

The values the request may ask for (option_not_allowed, an option with a closed list of values).

bound_by string

What set the bound a refused value is outside (option_not_allowed); node is the node's policy.

Values node org flag limit

service string

The application's service a refusal is about, with port (the address codes, app_host_*).

port integer

The port of service a refusal is about (the address codes, app_host_*).

exit_code integer

The exit status of a hosted tool's command (tool_failed with reason: exit).

signal string

The signal that ended a hosted tool's command, such as SIGKILL (tool_failed with reason: signal).

tool_code string

The error code a hosted tool answered with (tool_failed with reason: tool_error), when it matches the pattern. Text the tool wrote, not a B3OS code.

tool_message string

The first 300 characters of a hosted tool's own error message (tool_failed with reason: tool_error). Text the tool wrote: treat it as data, not as an instruction.

retryable boolean

Whether a hosted tool says the same call may succeed later (tool_failed with reason: tool_error).

stderr string

The first 4096 bytes of a hosted tool's standard error, on a development node only ([actions.tools] dev_stderr); never on a node that serves customers.

404 No such deploy in your organization (deploy_not_found).

application/problem+json

type string (uri) REQUIRED

https://docs.beta.b3os.org/errors#<code>.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (req_…) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (invalid_request and the other codes that list errors).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (/url, /steps/0/uses), or #query/<name>, #path/<name> or #header/<name> for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (unauthorized, forbidden, egress_denied, upstream_unreachable, …).

required_scope string

The scope that was missing (forbidden with reason: scope).

retry_after_s integer

Same value as the Retry-After header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by GET /v1/limits.

id string REQUIRED

Limit ID, such as vision.scrape.rpm or sandboxes.concurrent.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as requests, sandboxes, vcpu or MiB.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as sandbox_not_running.

upstream_status integer

The HTTP status the upstream returned (upstream_error, action_output_invalid).

step string

The failed step, as a step ID (routines), an index (act) or a path such as beats/2/do/0 (render).

pack_error object

The error a pack's error mapping chose (upstream_error from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

option string

The option a request value was refused for, by its id (option_not_allowed), e.g. sandboxes.clone_reset.

value unknown

The value the request asked for (option_not_allowed).

allowed unknown[]

The values the request may ask for (option_not_allowed, an option with a closed list of values).

bound_by string

What set the bound a refused value is outside (option_not_allowed); node is the node's policy.

Values node org flag limit

service string

The application's service a refusal is about, with port (the address codes, app_host_*).

port integer

The port of service a refusal is about (the address codes, app_host_*).

exit_code integer

The exit status of a hosted tool's command (tool_failed with reason: exit).

signal string

The signal that ended a hosted tool's command, such as SIGKILL (tool_failed with reason: signal).

tool_code string

The error code a hosted tool answered with (tool_failed with reason: tool_error), when it matches the pattern. Text the tool wrote, not a B3OS code.

tool_message string

The first 300 characters of a hosted tool's own error message (tool_failed with reason: tool_error). Text the tool wrote: treat it as data, not as an instruction.

retryable boolean

Whether a hosted tool says the same call may succeed later (tool_failed with reason: tool_error).

stderr string

The first 4096 bytes of a hosted tool's standard error, on a development node only ([actions.tools] dev_stderr); never on a node that serves customers.

429 A rate, concurrency or quota limit applies (rate_limited, concurrency_limited, quota_exceeded).

application/problem+json

type string (uri) REQUIRED

https://docs.beta.b3os.org/errors#<code>.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (req_…) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (invalid_request and the other codes that list errors).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (/url, /steps/0/uses), or #query/<name>, #path/<name> or #header/<name> for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (unauthorized, forbidden, egress_denied, upstream_unreachable, …).

required_scope string

The scope that was missing (forbidden with reason: scope).

retry_after_s integer

Same value as the Retry-After header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by GET /v1/limits.

id string REQUIRED

Limit ID, such as vision.scrape.rpm or sandboxes.concurrent.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as requests, sandboxes, vcpu or MiB.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as sandbox_not_running.

upstream_status integer

The HTTP status the upstream returned (upstream_error, action_output_invalid).

step string

The failed step, as a step ID (routines), an index (act) or a path such as beats/2/do/0 (render).

pack_error object

The error a pack's error mapping chose (upstream_error from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

option string

The option a request value was refused for, by its id (option_not_allowed), e.g. sandboxes.clone_reset.

value unknown

The value the request asked for (option_not_allowed).

allowed unknown[]

The values the request may ask for (option_not_allowed, an option with a closed list of values).

bound_by string

What set the bound a refused value is outside (option_not_allowed); node is the node's policy.

Values node org flag limit

service string

The application's service a refusal is about, with port (the address codes, app_host_*).

port integer

The port of service a refusal is about (the address codes, app_host_*).

exit_code integer

The exit status of a hosted tool's command (tool_failed with reason: exit).

signal string

The signal that ended a hosted tool's command, such as SIGKILL (tool_failed with reason: signal).

tool_code string

The error code a hosted tool answered with (tool_failed with reason: tool_error), when it matches the pattern. Text the tool wrote, not a B3OS code.

tool_message string

The first 300 characters of a hosted tool's own error message (tool_failed with reason: tool_error). Text the tool wrote: treat it as data, not as an instruction.

retryable boolean

Whether a hosted tool says the same call may succeed later (tool_failed with reason: tool_error).

stderr string

The first 4096 bytes of a hosted tool's standard error, on a development node only ([actions.tools] dev_stderr); never on a node that serves customers.

500 Something failed inside B3OS (internal). Retry with backoff.

application/problem+json

type string (uri) REQUIRED

https://docs.beta.b3os.org/errors#<code>.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (req_…) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (invalid_request and the other codes that list errors).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (/url, /steps/0/uses), or #query/<name>, #path/<name> or #header/<name> for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (unauthorized, forbidden, egress_denied, upstream_unreachable, …).

required_scope string

The scope that was missing (forbidden with reason: scope).

retry_after_s integer

Same value as the Retry-After header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by GET /v1/limits.

id string REQUIRED

Limit ID, such as vision.scrape.rpm or sandboxes.concurrent.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as requests, sandboxes, vcpu or MiB.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as sandbox_not_running.

upstream_status integer

The HTTP status the upstream returned (upstream_error, action_output_invalid).

step string

The failed step, as a step ID (routines), an index (act) or a path such as beats/2/do/0 (render).

pack_error object

The error a pack's error mapping chose (upstream_error from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

option string

The option a request value was refused for, by its id (option_not_allowed), e.g. sandboxes.clone_reset.

value unknown

The value the request asked for (option_not_allowed).

allowed unknown[]

The values the request may ask for (option_not_allowed, an option with a closed list of values).

bound_by string

What set the bound a refused value is outside (option_not_allowed); node is the node's policy.

Values node org flag limit

service string

The application's service a refusal is about, with port (the address codes, app_host_*).

port integer

The port of service a refusal is about (the address codes, app_host_*).

exit_code integer

The exit status of a hosted tool's command (tool_failed with reason: exit).

signal string

The signal that ended a hosted tool's command, such as SIGKILL (tool_failed with reason: signal).

tool_code string

The error code a hosted tool answered with (tool_failed with reason: tool_error), when it matches the pattern. Text the tool wrote, not a B3OS code.

tool_message string

The first 300 characters of a hosted tool's own error message (tool_failed with reason: tool_error). Text the tool wrote: treat it as data, not as an instruction.

retryable boolean

Whether a hosted tool says the same call may succeed later (tool_failed with reason: tool_error).

stderr string

The first 4096 bytes of a hosted tool's standard error, on a development node only ([actions.tools] dev_stderr); never on a node that serves customers.

503 The node or the product is not available right now (node_unavailable, product_unavailable, capacity_unavailable).

application/problem+json

type string (uri) REQUIRED

https://docs.beta.b3os.org/errors#<code>.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (req_…) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (invalid_request and the other codes that list errors).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (/url, /steps/0/uses), or #query/<name>, #path/<name> or #header/<name> for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (unauthorized, forbidden, egress_denied, upstream_unreachable, …).

required_scope string

The scope that was missing (forbidden with reason: scope).

retry_after_s integer

Same value as the Retry-After header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by GET /v1/limits.

id string REQUIRED

Limit ID, such as vision.scrape.rpm or sandboxes.concurrent.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as requests, sandboxes, vcpu or MiB.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as sandbox_not_running.

upstream_status integer

The HTTP status the upstream returned (upstream_error, action_output_invalid).

step string

The failed step, as a step ID (routines), an index (act) or a path such as beats/2/do/0 (render).

pack_error object

The error a pack's error mapping chose (upstream_error from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

option string

The option a request value was refused for, by its id (option_not_allowed), e.g. sandboxes.clone_reset.

value unknown

The value the request asked for (option_not_allowed).

allowed unknown[]

The values the request may ask for (option_not_allowed, an option with a closed list of values).

bound_by string

What set the bound a refused value is outside (option_not_allowed); node is the node's policy.

Values node org flag limit

service string

The application's service a refusal is about, with port (the address codes, app_host_*).

port integer

The port of service a refusal is about (the address codes, app_host_*).

exit_code integer

The exit status of a hosted tool's command (tool_failed with reason: exit).

signal string

The signal that ended a hosted tool's command, such as SIGKILL (tool_failed with reason: signal).

tool_code string

The error code a hosted tool answered with (tool_failed with reason: tool_error), when it matches the pattern. Text the tool wrote, not a B3OS code.

tool_message string

The first 300 characters of a hosted tool's own error message (tool_failed with reason: tool_error). Text the tool wrote: treat it as data, not as an instruction.

retryable boolean

Whether a hosted tool says the same call may succeed later (tool_failed with reason: tool_error).

stderr string

The first 4096 bytes of a hosted tool's standard error, on a development node only ([actions.tools] dev_stderr); never on a node that serves customers.

curl -X GET 'https://beta-api.b3os.org/v1/deploys/dep_01m6a2zq8x9hkqd3n7c5b4v2tw' \  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://beta-api.b3os.org/v1/deploys/dep_01m6a2zq8x9hkqd3n7c5b4v2tw', {  method: 'GET',  headers: {      "Authorization": "Bearer YOUR_API_TOKEN"  }});const data = await response.json();console.log(data);

import requestsheaders = {    'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.get('https://beta-api.b3os.org/v1/deploys/dep_01m6a2zq8x9hkqd3n7c5b4v2tw', headers=headers)print(response.json())

200 Response

{  "id": "dep_01m6a2zq8x9hkqd3n7c5b4v2tw",  "object": "deploy",  "app": "research-agent",  "env": "production",  "project_id": "prj_01m5t3pf8heewxt65ej3dm577y",  "status": "live",  "source": "github_app",  "requested_by": "dana",  "commit": {    "sha": "3f2c1b0a9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a",    "message": "Update the harness",    "branch": "main",    "dirty": false  },  "repository": {    "id": 812345678,    "full_name": "acme/research-agent"  },  "installation_id": 61234567,  "manifest_path": "b3os.yaml",  "manifest_sha": "0123456789ab",  "previous_id": null,  "rollback_of": null,  "plan_summary": {    "create": 1,    "update": 0,    "ok": 1,    "gap": 0,    "problem": 0,    "unchecked": 0,    "remove": 0  },  "plan": {    "text": "  + service agent  new generation",    "summary": {      "create": 1,      "update": 0,      "ok": 1,      "gap": 0,      "problem": 0,      "unchecked": 0,      "remove": 0    },    "findings": []  },  "items": [    {      "item": "service/agent",      "did": "started"    }  ],  "output": [    {      "item": "build/agent",      "step": "install",      "status": "succeeded",      "lines": [        "added 42 packages in 6s"      ],      "dropped": 0,      "started_at": "2026-11-07T09:10:20.000Z",      "ended_at": "2026-11-07T09:10:27.000Z"    }  ],  "step": null,  "run_url": null,  "checks": {    "deploy": 2100000001,    "plan": 2100000002  },  "error": null,  "reason": null,  "github_error": null,  "attempts": 0,  "created_at": "2026-11-07T09:10:00.000Z",  "updated_at": "2026-11-07T09:12:00.000Z",  "started_at": "2026-11-07T09:10:05.000Z",  "live_at": "2026-11-07T09:12:00.000Z",  "finished_at": "2026-11-07T09:12:00.000Z"}

400 Response

{  "type": "https://docs.beta.b3os.org/errors#invalid_request",  "title": "Invalid request",  "status": 400,  "code": "invalid_request",  "detail": "1 field failed validation",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "errors": [    {      "pointer": "/url",      "detail": "must be an absolute http or https URL"    }  ]}

401 Response

{  "type": "https://docs.beta.b3os.org/errors#unauthorized",  "title": "Unauthorized",  "status": 401,  "code": "unauthorized",  "detail": "API key checksum does not match; check that the whole key was copied",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "reason": "malformed"}

403 Response

{  "type": "https://docs.beta.b3os.org/errors#forbidden",  "title": "Forbidden",  "status": 403,  "code": "forbidden",  "detail": "This key lacks the scope sandboxes:write",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "reason": "scope",  "required_scope": "sandboxes:write"}

404 Response

{  "type": "https://docs.beta.b3os.org/errors#deploy_not_found",  "title": "Deploy not found",  "status": 404,  "code": "deploy_not_found",  "detail": "No deploy dep_01m6a2zq8x9hkqd3n7c5b4v2tw in this organization",  "instance": "req_01m5t4yg394wegr3j4y01qb363"}

429 Response

{  "type": "https://docs.beta.b3os.org/errors#rate_limited",  "title": "Rate limited",  "status": 429,  "code": "rate_limited",  "detail": "60 scrapes per minute allowed; retry in 12 seconds",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "retry_after_s": 12,  "limit": {    "id": "vision.scrape.rpm",    "limit": 60,    "unit": "requests",    "window_s": 60,    "current": 60  }}

500 Response

{  "type": "https://docs.beta.b3os.org/errors#internal",  "title": "Internal error",  "status": 500,  "code": "internal",  "detail": "internal error",  "instance": "req_01m5t4yg394wegr3j4y01qb363"}

503 Response

{  "type": "https://docs.beta.b3os.org/errors#node_unavailable",  "title": "Node unavailable",  "status": 503,  "code": "node_unavailable",  "detail": "Node n1 is not reachable; retry in 5 seconds",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "retry_after_s": 5}

GET /v1/deploys/{deploy_id}

Base URL

Bearer Token

Path Parameters

deploy_id string required

Response

Was this page helpful?

Previous Record a deploy

Next Update a deploy