REST API - Documentation - Orchestrator 0.4.0-rc73

appconfigs

Scoped application configuration at zone, org, and project scope.

POST /api/orgs/{org}/apps-configure Auth required

Configure an org-scoped app

Saves (default), resets, or refreshes version discovery for one app's org-scoped configuration. Sensitive values are tokenized server-side. Requires the `ManageOrgApps` permission. `reset` returns 204.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id

Request body

Schema: AppsConfigureRequest

Property	Type	Required	Description
action	string, nullable	no	`save` (default), `reset`, or `refresh_versions`.
app	AppRef	yes	The app this configuration targets.
disabled	boolean, nullable	no	Whether the app is disabled at this scope.
locked	array of string	no	Parameter names locked at this scope.
params	object	no	Default parameter values; sensitive values are tokenized server-side.

Responses

200 Saved config (or refresh result)

Schema: object (free-form)

204 Config reset

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not manage org apps

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Version discovery is disabled

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid app, action, param, or locked key

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/orgs/{org}/projects/{proj}/apps-configure Auth required

Configure a project-scoped app

Saves (default), resets, or refreshes version discovery for one app's project-scoped configuration. Sensitive values are tokenized server-side. Requires the `ManageProjectApps` permission. `reset` returns 204.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id

Request body

Schema: AppsConfigureRequest

Property	Type	Required	Description
action	string, nullable	no	`save` (default), `reset`, or `refresh_versions`.
app	AppRef	yes	The app this configuration targets.
disabled	boolean, nullable	no	Whether the app is disabled at this scope.
locked	array of string	no	Parameter names locked at this scope.
params	object	no	Default parameter values; sensitive values are tokenized server-side.

Responses

200 Saved config (or refresh result)

Schema: object (free-form)

204 Config reset

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not manage project apps

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or project not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Version discovery is disabled

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid app, action, param, or locked key

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

auth

Sign in, sign up, and read the current user.

GET /api/auth/user Auth required

Get the current user

Returns the user identified by the session cookie or bearer API key. Requires authentication.

Responses

200 The signed-in user

Schema: object (free-form)

401 Not authenticated

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

billing

Per-organization billing accounts, invoices, and the billing cycle.

GET /api/orgs/{org}/billing/account Auth required

Get an organization's billing account

Returns the org's billing account: plan, billing interval, cycle anchor, and next billing date. Requires the `read_billing` permission. Unknown orgs or orgs without an account are 404.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization wire ID or code

Responses

200 The billing account

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller lacks read_billing

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or account not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

PUT /api/orgs/{org}/billing/account Auth required

Update an organization's plan

Updates the org's plan. `billing_interval` changes are not yet supported. Requires the `manage_billing` permission. An empty update is a no-op 200.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization wire ID or code

Request body

Schema: UpdateAccountRequest

Property	Type	Required	Description
billing_interval	string, nullable	no	Billing interval; updates are not yet supported (rejected with 400).
plan	string, nullable	no	New plan to switch the account to (e.g. `demo`, `standard`).

Responses

200 Plan updated (or no-op)

Schema: object (free-form)

400 Malformed body or unsupported interval change

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller lacks manage_billing

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or account not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid plan type

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/orgs/{org}/billing/invoices/ Auth required

List an organization's invoices

Lists the org's invoices, newest first, with offset pagination. Requires the `read_billing` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization wire ID or code
status	query	string	no	Filter by invoice status (e.g. `draft`, `finalized`)
limit	query	integer	no	Page size (1–100, default 30)
after	query	string	no	Numeric offset cursor from a prior page

Responses

200 Paginated invoice list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller lacks read_billing

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/orgs/{org}/billing/invoices/{invoice_id} Auth required

Get one invoice

Returns a single invoice for the org. Requires the `read_billing` permission. Malformed invoice IDs are 400; unknown or foreign invoices are 404.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization wire ID or code
invoice_id	path	string	yes	Invoice wire ID

Responses

200 The invoice

Schema: object (free-form)

400 Malformed invoice_id

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller lacks read_billing

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Invoice not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/orgs/{org}/billing/invoices/{invoice_id}/lines Auth required

Get an invoice's line items

Returns the per-pool line items and computed total for an invoice. Requires the `read_billing` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization wire ID or code
invoice_id	path	string	yes	Invoice wire ID

Responses

200 Line items and total

Schema: object (free-form)

400 Malformed invoice_id

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller lacks read_billing

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Invoice not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/orgs/{org}/billing/upcoming-invoice Auth required

Get the upcoming (draft) invoice

Returns the org's latest draft invoice with its line items. Requires the `read_billing` permission; 404 when no draft exists.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization wire ID or code

Responses

200 Draft invoice with items

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller lacks read_billing

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 No upcoming invoice

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

downloads

Public catalog of files published for download by this zone.

GET /api/downloads Public

List downloads

Returns every published download repository with its version tags, plus the title and description the publisher annotated the served artifact with when it carries them. Unauthenticated: downloads are public.

Responses

200 Download repositories and their tags

Schema: object (free-form)

GET /api/downloads/{name} Public

Get a download

Returns one download repository: the publisher's title and description when annotated, its version tags and, per tag, the files with size, platform, and sha256 digest. The digest is the file's own sha256 — download bytes are stored verbatim. Unauthenticated: downloads are public.

Parameters

Name	In	Type	Required	Description
name	path	string	yes	Download repository name

Responses

200 The repository, its tags, and their files

Schema: object (free-form)

404 No such download

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

networks

Per-organization address plans and per-project networks.

GET /api/orgs/{org}/address-plan Auth required

Get an organization's address plan

Returns the org's allocatable and reserved prefixes and its allocated `/24` blocks. Requires the `ReadAddressPlan` permission (system operator).

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id

Responses

200 The org's address plan

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read address plans

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/orgs/{org}/address-plan/prefixes Auth required

Add an address-plan prefix

Adds an allocatable (default) or reserved IPv4 prefix to the org's address plan. Requires the `ManageAddressPlans` permission. Overlaps within this plan are rejected (422); overlaps with another org's plan are allowed and reported under `warnings`.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id

Request body

Schema: PrefixRequest

Property	Type	Required	Description
kind	string	no	`allocatable` (default) or `reserved`.
prefix	string	yes	IPv4 CIDR prefix to add or remove, e.g. `10.20.0.0/16`.

Responses

200 Updated plan with any cross-org warnings

Schema: object (free-form)

400 Malformed request body

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not manage address plans

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid prefix, kind, or overlapping prefix

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/orgs/{org}/address-plan/prefixes/remove Auth required

Remove an address-plan prefix

Removes an allocatable (default) or reserved IPv4 prefix from the org's address plan. Requires the `ManageAddressPlans` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id

Request body

Schema: PrefixRequest

Property	Type	Required	Description
kind	string	no	`allocatable` (default) or `reserved`.
prefix	string	yes	IPv4 CIDR prefix to add or remove, e.g. `10.20.0.0/16`.

Responses

200 Updated plan

Schema: object (free-form)

400 Malformed request body

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not manage address plans

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid prefix or kind

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/orgs/{org}/projects/{proj}/networks Auth required

List a project's network

Returns the project's isolated network (VNI, subnets, members) as a list of zero or one entry. Requires the `ReadProject` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id

Responses

200 The project's network (0 or 1 entry)

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this project

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or project not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

nodes

Node inventory, live logs, interactive terminals, and termination.

GET /api/nodes/ Auth required

List visible nodes

Returns every node in the pools the caller can see (via org or project membership), including liveness state, as a paginated envelope.

Responses

200 Paginated node list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/nodes/{node}/audit Auth required

Get a node's audit history

Returns the node aggregate's ordered event log as a paginated envelope; each entry carries the event type, sequence, and decoded payload. Requires the `ReadNode` permission in the node's project.

Parameters

Name	In	Type	Required	Description
node	path	string	yes	Node wire id

Responses

200 Paginated event history

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this node

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Node not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/nodes/{node}/logs Auth required

Stream a node's logs

Server-Sent Events stream of a node's durable logs. Replays retained rows then live-tails. Requires the `ReadNodeLogs` permission in the node's project. `Last-Event-ID` resumes while rows are retained.

Parameters

Name	In	Type	Required	Description
node	path	string	yes	Node wire id
debug	query	string	no	`true` to include debug-level records
mode	query	string	no	`head` (replay then stop) or `tail` (default, keep streaming)
since	query	string	no	Tail window duration, e.g. `30s`, `15m`, `6h`, `3d`

Responses

200 SSE stream of log records

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this node's logs

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Node not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/nodes/{node}/terminal/ws Auth required

Open an interactive terminal (WebSocket)

Upgrades to a WebSocket carrying an interactive PTY on the node's agent. Binary frames carry stdin/stdout; JSON text frames carry control (`resize`, `close`) and lifecycle events. Requires the `TerminalAttach` permission in the node's project.

Parameters

Name	In	Type	Required	Description
node	path	string	yes	Node wire id
cols	query	integer	no	Initial terminal columns (default 80)
rows	query	integer	no	Initial terminal rows (default 24)

Responses

101 Switching protocols to WebSocket

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not attach a terminal

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Node not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/nodes/{node}/terminate Auth required

Terminate a node

Requests termination of a node. Online nodes drain through the agent; offline nodes end immediately; a node hosting provider resources cascades to its children. Requires the `TerminateNode` permission. Returns the node's post-write lifecycle state.

Parameters

Name	In	Type	Required	Description
node	path	string	yes	Node wire id

Responses

200 Termination accepted; returns the new state

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not terminate this node

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Node not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Node already ended

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

orgs

Organization identity and resource limits.

GET /api/orgs/{org} Auth required

Get an organization

Returns the organization's identity (id, code, name) and its effective resource limits (`-1` means unlimited). Any member who can read the org may call this.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id

Responses

200 Organization identity and limits

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this organization

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

pools

Pool provisioning requests: create, reconfigure, resize, and remove.

GET /api/orgs/{org}/projects/{proj}/pools/ Auth required

List a project's pools

Returns the project's live pools as a paginated envelope. Requires the `ListProjectRequests` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id

Responses

200 Paginated pool list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not list pools here

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or project not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/orgs/{org}/projects/{proj}/pools/ Auth required

Create or reconfigure a pool

Creates a pool provisioning request (name, size, provider, spec, app assignments); a name that already exists is reconfigured at the next request version (201 for a fresh pool, 200 for a reconfigure). Requires the `CreateRequest` permission; core pools require system membership. Sensitive app params are tokenized server-side.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id

Request body

Schema: CreatePoolRequest

Property	Type	Required	Description
apps	object	no	App assignments; sensitive params are tokenized server-side.
pool	string	yes	DNS-label pool name (1-63 lowercase letters, digits, dashes; must not end in `-<digits>`, which is reserved for slot names).
provider	string	yes	Provider: a built-in type, a visible provider name, or a provider pool id.
size	integer	yes	Desired node count (0 for non-scalable providers).
spec	object	no	Provider-specific spec object.

Responses

200 Existing pool reconfigured

Schema: object (free-form)

201 Pool created

Schema: object (free-form)

400 Malformed pool request

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not create requests here

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or project not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Pool is being removed; retry later

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid name, provider, spec, or app param

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

503 Secret replication lacked quorum; retry

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/orgs/{org}/projects/{proj}/pools/{pool} Auth required

Get a pool by name

Returns one live pool addressed by name within the project. Requires the `ReadPool` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id
pool	path	string	yes	Pool name

Responses

200 The pool

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this pool

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Org, project, or pool not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/orgs/{org}/projects/{proj}/pools/{pool}/agent-tokens/ Auth required

Mint a pool agent-registration token

Issues a short-lived registration token that agents redeem at `/api/agent/connect` to enroll into the pool, plus install-script URLs. Requires the `CreatePoolAgentToken` permission. The pool must accept agent-registered nodes.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id
pool	path	string	yes	Pool name

Responses

201 Registration token and install URLs

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not mint agent tokens

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Org, project, or pool not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Pool does not accept agent-registered nodes

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

PUT /api/pools/{pool} Auth required

Update a pool

Resizes, changes lifecycle state (`active`/`blocked`/`rejected`), and/or reconfigures a pool addressed by id. Supplying any of `provider`, `spec`, or `apps` commits the next request version. Requires the `UpdatePool` permission; core pools require system membership. Returns the updated pool.

Parameters

Name	In	Type	Required	Description
pool	path	string	yes	Pool wire id

Request body

Schema: UpdatePoolRequest

Property	Type	Required	Description
apps	object	no	New app assignments (presence triggers a reconfigure).
provider	string, nullable	no	New provider (presence triggers a reconfigure).
reason	string	no	Human-readable reason for a state change.
size	integer, nullable	no	New desired node count.
spec	object	no	New provider spec (presence triggers a reconfigure).
state	string, nullable	no	Lifecycle state: `active`, `blocked`, or `rejected`.

Responses

200 Updated pool

Schema: object (free-form)

400 Malformed pool update

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not update this pool

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Pool not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Update conflicted or state invalid; retry

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid size, state, provider, spec, or app param

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

503 Secret replication lacked quorum; retry

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

DELETE /api/pools/{pool} Auth required

Remove a pool

Removes a pool addressed by id. Requires the `DeletePool` permission. Removal completes once all nodes end: 204 when fully removed (idempotent), 202 while removal is still staged.

Parameters

Name	In	Type	Required	Description
pool	path	string	yes	Pool wire id

Responses

202 Removal staged; completing as nodes end

Schema: object (free-form)

204 Pool removed

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not delete this pool

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Pool not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Removal conflicted; retry

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/pools/{pool}/requests/{version} Auth required

Get a pool request version

Returns one historical request version of a pool (provider, spec, apps). Requires the `ReadPool` permission.

Parameters

Name	In	Type	Required	Description
pool	path	string	yes	Pool wire id
version	path	integer	yes	Request version number

Responses

200 The request version

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this pool

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Pool or request version not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/pools/{pool}/requests/{version}/nodes Auth required

List nodes for a pool request version

Returns the nodes provisioned under a pool's request version as a paginated envelope. Requires the `ListPoolNodes` permission.

Parameters

Name	In	Type	Required	Description
pool	path	string	yes	Pool wire id
version	path	integer	yes	Request version number

Responses

200 Paginated node list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not list this pool's nodes

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Pool or request version not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

projects

Projects within an organization and their memberships.

GET /api/orgs/{org}/projects/ Auth required

List an organization's projects

Returns the projects in the organization as a paginated envelope. Requires the `ListOrgProjects` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id

Responses

200 Paginated project list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not list this org's projects

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/orgs/{org}/projects/ Auth required

Create a project

Creates a project (name and DNS-label code) with the caller as owner. Requires the `CreateOrgProjects` permission. A code collision returns 409; hitting the org's project limit returns 422.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id

Request body

Schema: CreateProjectRequest

Property	Type	Required	Description
code	string	yes	DNS-label code (lowercase letters, digits, dashes).
name	string	yes	Display name (1-80 characters).

Responses

201 Project created

Schema: object (free-form)

400 Malformed request body

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not create projects here

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Project code already taken

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid name/code or org project limit reached

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

PUT /api/orgs/{org}/projects/{proj} Auth required

Rename a project

Renames a project's name and/or code. Requires the `UpdateProject` permission. A code collision returns 409; invalid name/code returns 422.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id

Request body

Schema: UpdateProjectRequest

Property	Type	Required	Description
code	string	yes	New DNS-label code (lowercase letters, digits, dashes).
name	string	yes	New display name (1-80 characters).

Responses

200 Updated name and code

Schema: object (free-form)

400 Malformed request body

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not update this project

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or project not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

409 Project code already taken

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid name or code

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/orgs/{org}/projects/{proj}/members/ Auth required

List project members

Returns the project's members as a paginated envelope, ordered by display name. Requires the `ListProjectMembers` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id

Responses

200 Paginated member list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not list members

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or project not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/orgs/{org}/projects/{proj}/members/ Auth required

Add a project member

Adds a member to the project by `email` or `user_id` with a role. Requires the `ManageProjectMembers` permission. 400 when neither identifier is supplied; 404 when no user matches; 422 on an invalid role.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id

Request body

Schema: AddMemberRequest

Property	Type	Required	Description
email	string, nullable	no	Target member by email (resolved to a user); one of `email` or `user_id`.
role	string	no	Project role to grant.
user_id	string, nullable	no	Target member by user wire id; one of `email` or `user_id`.

Responses

200 Member added

Schema: object (free-form)

400 Malformed body or missing identifier

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not manage members

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Org, project, or user not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid role

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

PUT /api/orgs/{org}/projects/{proj}/members/{user} Auth required

Update a member's role

Changes a project member's role. Requires the `ManageProjectMembers` permission. 422 on an invalid role.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id
user	path	string	yes	Member user wire id

Request body

Schema: UpdateMemberRequest

Property	Type	Required	Description
role	string	yes	New project role.

Responses

200 Role updated

Schema: object (free-form)

400 Malformed request body

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not manage members

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Org, project, or user not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid role

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

DELETE /api/orgs/{org}/projects/{proj}/members/{user} Auth required

Remove a project member

Removes a member from the project. Requires the `ManageProjectMembers` permission. Idempotent: succeeds whether or not the user was a member.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id
user	path	string	yes	Member user wire id

Responses

200 Member removed (or already absent)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not manage members

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or project not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

providers

Infrastructure providers visible to a project and their visibility scope.

GET /api/orgs/{org}/projects/{proj}/providers/ Auth required

List providers visible to a project

Returns the providers visible from the project: its own project-scoped providers, its org's org-scoped providers, and all zone-scoped providers, with per-resource capacity. Requires the `ListProjectProviders` permission.

Parameters

Name	In	Type	Required	Description
org	path	string	yes	Organization code or wire id
proj	path	string	yes	Project code or wire id

Responses

200 List of visible providers

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not list providers here

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 Organization or project not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

support

File support requests as tracked issues.

POST /api/support/issues Auth required

File a support request

Validates a support request from any authenticated user and durably queues it for asynchronous delivery as a tracked GitHub issue. Returns immediately with an acknowledgement; the issue is created later by the outbox handler. Requires a configured GitHub client (otherwise 503).

Request body

Schema: SupportRequest

Property	Type	Required	Description
description	string	no	Body of the request (20–5000 characters).
kind	string	no	Issue kind: `bug` or `feature`.
org_code	string	no	Optional organization code for context.
project_code	string	no	Project code the request relates to (required; reported as `project`).
title	string	no	Short title (5–120 characters).

Responses

200 Request accepted and queued

Schema: object (free-form)

400 Malformed request body

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Validation failed

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

503 GitHub is not configured

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

users

User profiles, API keys, and the resources a user can see.

GET /api/users/{user} Auth required

Get a user

Returns the target user's profile. Callable by the user themselves or a system administrator (`ReadUser`).

Parameters

Name	In	Type	Required	Description
user	path	string	yes	User wire id

Responses

200 The user profile

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this user

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 User not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/users/{user}/api-keys/ Auth required

List a user's API keys

Returns the target user's API key metadata (never the secret tokens) as a paginated envelope. Callable by the user themselves or a system administrator (`ListUserApiKeys`).

Parameters

Name	In	Type	Required	Description
user	path	string	yes	User wire id

Responses

200 Paginated API key metadata

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not list this user's keys

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 User not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

POST /api/users/{user}/api-keys/ Auth required

Create an API key

Mints a new API key for the target user, optionally with a purpose label and an expiry duration (`30m`, `12h`, `7d`). The plaintext token is returned once. Callable by the user themselves or a system administrator (`CreateUserApiKey`).

Parameters

Name	In	Type	Required	Description
user	path	string	yes	User wire id

Request body

Schema: CreateApiKeyRequest

Property	Type	Required	Description
expiry	string, nullable	no	Optional lifetime as a duration like `30m`, `12h`, or `7d`.
purpose	string, nullable	no	Optional label for the key (defaults to `api`).

Responses

201 The created key, including its one-time token

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not create keys for this user

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 User not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

422 Invalid expiry duration

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

DELETE /api/users/{user}/api-keys/{apikey} Auth required

Delete an API key

Revokes one of the target user's API keys by its numeric id. Callable by the user themselves or a system administrator (`DeleteUserApiKey`).

Parameters

Name	In	Type	Required	Description
user	path	string	yes	User wire id
apikey	path	integer	yes	Numeric API key id

Responses

200 Key revoked

Schema: object (free-form)

400 Malformed api key id

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not delete this user's keys

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 User not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/users/{user}/nodes/ Auth required

List a user's nodes

Returns the nodes in projects the target user can access, as a paginated envelope. Callable by the user themselves or a system administrator (`ReadUser`).

Parameters

Name	In	Type	Required	Description
user	path	string	yes	User wire id

Responses

200 Paginated node list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this user

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 User not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/users/{user}/orgs/ Auth required

List a user's organizations

Returns the organizations the target user can see, as a paginated envelope. Callable by the user themselves or a system administrator (`ReadUser`).

Parameters

Name	In	Type	Required	Description
user	path	string	yes	User wire id

Responses

200 Paginated organization list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this user

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 User not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/users/{user}/pools/ Auth required

List a user's pools

Returns the pools the target user can see, as a paginated envelope. Callable by the user themselves or a system administrator (`ReadUser`).

Parameters

Name	In	Type	Required	Description
user	path	string	yes	User wire id

Responses

200 Paginated pool list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this user

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 User not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

GET /api/users/{user}/projects/ Auth required

List a user's projects

Returns the projects across the target user's visible organizations, as a paginated envelope. Callable by the user themselves or a system administrator (`ReadUser`).

Parameters

Name	In	Type	Required	Description
user	path	string	yes	User wire id

Responses

200 Paginated project list

Schema: object (free-form)

401 Authentication required

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

403 Caller may not read this user

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

404 User not found

Schema: Problem

Property	Type	Required	Description
current	integer, nullable	no	Current resource usage for `urn:orc:limit` problems.
detail	string	yes	Human-readable explanation specific to this occurrence.
errors	object	yes	Field-level validation errors, keyed by field name.
instance	string, nullable	no	URI reference identifying this specific occurrence.
limit	integer, nullable	no	Configured resource limit for `urn:orc:limit` problems.
resource	string, nullable	no	Limited resource name for `urn:orc:limit` problems.
status	integer	yes	HTTP status code for this occurrence.
title	string	yes	Short human-readable summary of the problem type.
type	string	yes	URI reference identifying the problem type; `about:blank` when generic.

REST API reference

appconfigs

auth

billing

downloads

networks

nodes

orgs

pools

projects

providers

support

users