HTTP API: instance
The 2 operations tagged instance, each with its parameters, its body and what it answers.
Change what this installation is called
PATCH /v1/instance
Change this installation's name or its timezone.
Needs instance:admin, which no role carries and only a superuser holds. Deciding what a
whole installation is called is not something a member of one workspace in it should be
able to do.
An omitted field is left alone, and neither may be set to nothing.
Request body: Update as application/json, required.
Responses
200:Instance. Successful Response422:HTTPValidationError. Validation Error
Every workspace on this installation
GET /v1/instance/workspaces
List every workspace here, whether or not the caller is a member.
Needs instance:admin, which no role carries and only a superuser holds.
Discovery, not reach. GET /v1/workspaces lists what this caller can work in and
is unchanged; this says what exists, and nothing a workspace contains is widened by it.
Anybody holding instance:workspace_create can make a workspace the instance owner is
not in, and until this route the owner's answer to what is here silently left it out —
an empty list, which reads as nothing being there rather than as something unseen.
Enveloped and unpaginated, like a workspace's members (§8.4): the number of workspaces on an installation is bounded by how many somebody made.
Parameters
format(stringornull, in query): 'full' (default), 'compact' for one aligned line per item, or 'ids' for the addresses alone. Compact is roughly a twentieth the size of full.fields(stringornull, in query): Comma-separated field names to return instead of the whole item, e.g. 'ref,title,due_at'. GET /v1/meta lists what each entity has. Cannot be combined with 'format'.
Responses
200:Collection_WorkspaceOnInstance_. Successful Response422:HTTPValidationError. Validation Error