The caller's account, its regions, members and Agents. The overview covers what every operation shares: authentication, roles, errors, pagination, idempotency and If-Match.
GET /account Read the caller's account, membership and limits
GET /regions List the regions new resources can be created in
GET /members List the account's people and Agents with their roles
The key’s role does not hold the capability the operation needs, the key is narrowed away from the resource, or the account already holds as many of the resource as it may.
No
Use a key whose role holds the capability, or one that is not narrowed; delete what you no longer need, or ask for a higher limit. (more)
The key’s role does not hold the capability the operation needs, the key is narrowed away from the resource, or the account already holds as many of the resource as it may.
No
Use a key whose role holds the capability, or one that is not narrowed; delete what you no longer need, or ask for a higher limit. (more)
The key’s role does not hold the capability the operation needs, the key is narrowed away from the resource, or the account already holds as many of the resource as it may.
No
Use a key whose role holds the capability, or one that is not narrowed; delete what you no longer need, or ask for a higher limit. (more)
PATCH /v1/members/{subject} · CLI: tonbo member update
Needs members.write, which owner and admin hold. A narrowed key may not.
Owners and admins give a person or an Agent another role; only an owner grants owner. name renames an Agent: it follows the Agent name rule and is unique among the account's active Agents (409 otherwise), and the Agent keeps its id, keys, home region and public hostname. A person's name belongs to their own profile, so name on a person is refused with 422 validation_error on the field name. Both fields in one request change together or not at all. People change members; an Agent's credential is refused with 403.
Parameters
Name
In
Type
Required
Description
subject
path
string
yes
The member to change, by the subjectGET /v1/members lists: a person's user id, or agent.<agent id> for an Agent. Matches ^[a-z0-9._-]{1,64}$.
Request body
application/json, required. Unknown fields are refused.
At least one field.
Field
Type
Required
Description
role
one of "owner", "admin" or "member"
no
The member's new role. Only an owner grants owner, and an account always keeps at least one person as owner.
name
string
no
The Agent's new name; refused for a person. 1 to 40 characters. Matches ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$.
The key’s role does not hold the capability the operation needs, the key is narrowed away from the resource, or the account already holds as many of the resource as it may.
No
Use a key whose role holds the capability, or one that is not narrowed; delete what you no longer need, or ask for a higher limit. (more)
The name is held by another live resource of the account, the Idempotency-Key already created another resource or one since deleted, or the resource’s current state does not allow the change. detail says which, and errors names the field.
No
Pick another name or a new Idempotency-Key, or read the resource again and act on its current state. (more)
Create an Agent, an identity with a role in the account
POST /v1/agents · CLI: tonbo agent create
Needs agents.create, which owner and admin hold. A narrowed key may not.
Owners and admins create Agents; only an owner grants owner. A replay with the same Idempotency-Key returns the Agent the first request created.
Parameters
Name
In
Type
Required
Description
Idempotency-Key
header
string
yes
A value you choose for this one creation, 1 to 255 characters, such as a new UUID. Send a new one for each resource you create, and the same one only to retry that request after a timeout or a lost answer: the retry answers what the first request created, in its current state, and never creates a second. A key reused for a different database, stream or Machine answers 409. 1 to 255 characters.
Request body
application/json, required. Unknown fields are refused.
Field
Type
Required
Description
name
string
yes
The Agent's name; 409 when an active Agent of the account has it. 1 to 40 characters. Matches ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$.
role
one of "owner", "admin" or "member"
no
The Agent's role; member when omitted. Only an owner grants owner. Default "member".
region
string
no
The Agent's home region; the only open region when omitted.
The key’s role does not hold the capability the operation needs, the key is narrowed away from the resource, or the account already holds as many of the resource as it may.
No
Use a key whose role holds the capability, or one that is not narrowed; delete what you no longer need, or ask for a higher limit. (more)
The name is held by another live resource of the account, the Idempotency-Key already created another resource or one since deleted, or the resource’s current state does not allow the change. detail says which, and errors names the field.
No
Pick another name or a new Idempotency-Key, or read the resource again and act on its current state. (more)
The key or the account sent more requests than its rate allows.
After Retry-After
Wait for the seconds Retry-After names, then send the request again; spread requests out if it recurs. (more)
Retries
Send a new Idempotency-Key with each request and the same one when you send it again: a repeat answers what the first request did, and the key reused for a different request answers 409 (see Idempotency).
429 carry Retry-After: wait that many seconds, then send the same request again.
The region's id, which a creation names as region. Matches ^[a-z]{2}-[a-z]+-[0-9]$.
url
string (uri)
yes
The origin of the data plane in this region; a database's URL is this origin, the account id and the database name, and a bucket's is this origin and the bucket name.
default
boolean
yes
Whether a database goes to this region when its creation names none.