Create a root key with the permissions listed on this page under Root Keys in the dashboard sidebar. CLI commands can instead use a session from unkey login with the required permissions. See Permission reference for every permission.
- Send the
pagination.cursorof the last response ascursor. The response contains only the entries after it. - When
hasMoreis true, request again now. - When
hasMoreis false, you have all entries so far. Wait, then request again with the same cursor. - The cursor is absent only when the request had no cursor and the build has no entries yet.
- A response can contain fewer than
limitentries and still havehasMore: truewhen the entries are large.
building, request until
you get an empty response at least 5 seconds later.
When a build attempt is retried, an entry from the earlier attempt can
arrive after the cursor has moved past it, and a poll does not return it.
A request without a cursor returns it. A deployment from a prebuilt image
has no build and returns no entries. Build logs are kept for 3 months.
Usage
Flags
string
Pagination cursor from a previous response to fetch the entries after it. Omit it to start at the first entry of the build.
string
required
Identifies the deployment by its unique ID or slug. Accepts a prefixed deployment ID such as
d_1234abcd or a slug.integer
Maximum number of log entries to return. A response can contain fewer entries and still have
hasMore: true when the entries are large. Range: 1 to 500. The API defaults to 100 when omitted.string
Return only the log entries of this build step. Use the
stepId of an entry from a previous response. An unknown step returns no entries. Omit this field to return the entries of every step.Shared flags
These flags control authentication, requests, and output. CLI output and shared flags describes them in full.string
A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See Send a raw body.
string
Root key used for the request. Falls back to
UNKEY_ROOT_KEY, then stored credentials, including a CLI session. See CLI authentication for the full precedence order.string
default:"https://api.unkey.com"
Base URL of the API. Falls back to
UNKEY_API_BASE_URL. You don’t normally need to set it.string
default:"~/.unkey/config.toml"
Path of the TOML config file. Falls back to
UNKEY_CONFIG. An explicit --config takes precedence over a stored CLI session. Browser login stores a session, not a root key in this file. See CLI authentication.enum
default:"human"
Use
human (default) for name-first summary tables and labeled details, or json for the unchanged full response envelope, including all fields and pagination. Terminal tables use relative timestamps and may shorten display names and descriptions, but never identifiers, slugs, or credentials. Redirected human output keeps complete values and uses RFC3339 UTC timestamps. Falls back to UNKEY_OUTPUT; other values are rejected. --json also selects JSON output. Add --debug to print the request ID to stderr. See Output formats.boolean
Print the successful response’s request ID to stderr, separate from stdout.
boolean
Print the full response as JSON. Takes precedence over a valid
--output or UNKEY_OUTPUT value.Required permissions
Your root key must have the following permission:unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/deployments/<deployment_id>/buildLogs#read
Examples
API endpoint
The command callsPOST /v2/deployments.listBuildLogs and prints its response. See the endpoint definition for the HTTP contract. Request fields use camelCase in --body.