Pular para o conteúdo principal
POST
Install a package

Autorizações

Authorization
string
header
obrigatório

Enforced on every transport, with no exempt operation. A person's request must carry a JWT issued by the configured identity provider, which the host verifies itself against that issuer's key set: signature, issuer, expiry, and the person and organisation it names. Requests without a valid one receive 401 NRY-0011 — except a request with no token on a laptop's socket from the OS user the kernel names as the host's own, which is that machine's user.

Corpo

application/json

Request to install a package.

source
string
obrigatório

A registry reference or a local directory path.

Maximum string length: 1024
trustAcknowledged
boolean
padrão:false

Must be true when source carries compiled Go code: installing it means trusting it fully — it runs in the host's own process, with no sandbox. Omitted or false on a code-carrying source is rejected (422) naming the acknowledgement, before any install is attempted.

Resposta

Install job started. Poll it for progress.

An asynchronous package operation. Code-carrying packages resolve, build and swap the binary; a failure at any stage leaves the previous binary intact and serving — the user is never left without a working agent.

id
string<uuid>
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
resolving,
building,
swapping,
done,
failed
startedAt
string<date-time>
obrigatório
packageName
string
Maximum string length: 256
source
string
Maximum string length: 1024
error
object

Present when status is failed; the previous binary is intact.

Exemplo:
finishedAt
string<date-time>