API reference
Every route in the App API: what it takes, what it returns and who can call it.
The API is at https://api.rustward.com. Authenticate with a workspace API token (create one
on the API tokens page of your workspace settings) in the Authorization header. Requests and responses are JSON, and errors come back as { "error": "…" } with a 4xx status.
curl https://api.rustward.com/servers \
-H "Authorization: Bearer YOUR_TOKEN" Each route shows who can call it:
- API tokens: a token, which always acts in its own workspace, or a signed-in
session, which picks one with the
Workspaceheader (else its personal workspace). The scope shown (such asservers:write) is the one the token needs. - Signed-in only: the dashboard only, not API tokens.
- No sign-in needed: anyone, e.g. to sign in.
The spec is generated from the API itself: download openapi.yaml for client generators, or try requests in the API explorer.
Auth
Signing in by emailed link, and signing out.
/auth/magic-linkEmail a sign-in link
Request body
emailstring required min length 3max length 254redirectTostring max length 512Site-relative path to land on after signing in
Responses
202 Sent
okboolean required
400Not an email address429A link was sent to this address under a minute ago502The email could not be sent
/auth/verifyRedeem a sign-in link
Opens a session (sets the session cookie) and says where to go next.
Request body
tokenstring required min length 1max length 128
Responses
200 Signed in
redirectTostring | null required
400The link is invalid, used or expired
/auth/sign-in/emailSign in or sign up inline by email
New address: opens an unverified account and sets the session cookie. Existing address: emails a sign-in code (answer `auth: "code"`); redeem it with /auth/sign-in/code.
Request body
emailstring required min length 3max length 254
Responses
200 Signed in, or a code was sent
Option 1objectauthstring requiredcreatedboolean requiredTrue when a new (unverified) account was just opened
Option 2objectauthstring requiredemailstring requirednoticestringSet when a code was already on its way
400Not an email address502The email could not be sent
/auth/sign-in/codeSign in with an emailed code
Checks the 6-digit code from /auth/sign-in/email and sets the session cookie. Each code allows 5 attempts.
Request body
emailstring required min length 3max length 254codestring required min length 1max length 16
Responses
200 Signed in
okboolean required
400Wrong, expired or used-up code
/auth/logoutSign out
Ends the session and clears its cookie. Succeeds when already signed out.
Responses
200 Signed out
okboolean required
Profile
Your own account.
/profileGet the profile
Responses
200 Success
userobject requiredidstring requirednamestring requiredemailstring requiredavatarUrlstring | null required
/profileUpdate the profile
Updates the signed-in user's name and avatar URL. An empty avatarUrl clears it.
Request body
namestring required min length 1max length 100Display name; surrounding whitespace is trimmed
avatarUrlone ofURL of the avatar image; null, empty or omitted clears it
Option 1string | nullOption 2string
Responses
200 Success
userobject requiredidstring requirednamestring requiredemailstring requiredavatarUrlstring | null required
400Invalid request
/sessionsList signed-in sessions
Every device signed in to your account, the current one first. Needs a signed-in session.
Responses
200 Your sessions
itemsarray<SignedInSession> requiredidstring requiredA reference for this session (not its cookie or its stored hash)
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$When you signed in
expiresAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Extended while the session is in use
currentboolean requiredThe session making this request
401Not signed in
/sessions/revoke-othersSign out of all other devices
Ends every session except the one making this request. Needs a signed-in session.
Responses
200 How many sessions ended
okboolean requiredcountinteger required min -9007199254740991max 9007199254740991
401Not signed in
/sessions/{id}Sign out a device
Ends one of your other sessions. To end this one, use logout. Needs a signed-in session.
Parameters
idpath · string required pattern ^[0-9a-f]{32}$
Responses
200 Signed out
okboolean required
400This is the current session401Not signed in404No such session
Currency
Exchange rates for showing prices in other currencies.
/currency/ratesUSD exchange rates for the currencies we sell in
At most an hour old. When the rate service is down, only USD is returned and `stale` is true.
Responses
200 Rate table
basestring requiredratesobject requiredMultipliers against one USD, e.g. { "EUR": 0.92 }
fetchedAtstring requiredstaleboolean requiredTrue when the rate service was unreachable and only USD is real
Orders
Ordering and paying for servers.
/ordersOrder a server
Validates the order against the live catalogue and locks its prices in. Prepaid workspaces get an invoice and payment is attempted; postpaid ones are built straight away.
Request body
packagestring required min length 1max length 100Package slug
locationstring required min length 1max length 100Host group slug
imagestring required min length 1max length 100OS image slug
hostnamestring required min length 1max length 253sshPublicKeystring | null max length 16384sshKeyIdsarray<string> max 20 itemsdefault []Saved SSH keys in the workspace, for signed-in buyers
workspaceIdstring required min length 1max length 64currencystring default "USD"The currency the page showed prices in; the order is charged in it
USDEURGBPCADAUDNZDSEKPLNBRLJPY
Responses
201 Order placed
orderIdstring requiredstatusstring requiredcompletedawaiting_payment
400A field is invalid (see `fields`), or the order breaks a rule (limits, unpaid balance, missing rate)
/orders/{id}/payPay an order's open invoice
Retries payment for an order awaiting payment. Builds the server once it succeeds.
Parameters
idpath · string required min length 1max length 64
Responses
200 Paid
okboolean required
400Nothing to pay, or payment failed404No such order of yours
Workspaces
Your workspaces: personal and team.
/workspacesList your workspaces
Your personal workspace first, then your teams, with your role in each. Needs a signed-in user.
Responses
200 Your workspaces
itemsarray<MyWorkspace> requiredidstring requiredUse this (or the slug) as `:workspaceId` in other routes
slugstring requirednamestring requiredtypestring requiredPERSONALTEAMrolestring requiredOWNERADMINBILLINGMEMBER
401Not signed in
/workspacesCreate a team
A new team workspace with you as its owner, billed to your email address until you change it. Its slug comes from the name, with a random ending if it's taken. Needs a signed-in user.
Request body
namestring required min length 1max length 100The team's name. Its slug (web address) is made from it.
Responses
201 Created
idstring requiredUse this (or the slug) as `:workspaceId` in other routes
slugstring requirednamestring requiredtypestring requiredPERSONALTEAMrolestring requiredOWNERADMINBILLINGMEMBER
400No name401Not signed in409You own too many teams
/workspaces/{workspaceId}/overviewGet the overview
Server counts and the newest servers (with `servers:read`), what needs attention, the monthly cost and credit (with `billing:read`), and recent activity (with `audit:read`). Parts the caller may not see are null. Any member or token of the workspace can call it.
Parameters
workspaceIdpath · string required min length 1max length 64
Responses
200 The overview
serversobject | null requiredNull without `servers:read`
totalinteger required min -9007199254740991max 9007199254740991countsobject requireditemsarray<object> requiredUp to 6, newest first
idstring requirednamestring requiredstatusstring requiredstatestring requiredrunningstoppedsetting_upbusyrescuesuspendederroripv4string | null requiredplanstring requiredregionstring requiredbillingobject | null requiredNull without `billing:read`
statusstring | null requiredACTIVEPAST_DUESUSPENDEDCLOSEDmodestring | null requiredPREPAID_MONTHLYPOSTPAID_USAGEcurrencystring requiredcreditBalanceCentsinteger required min -9007199254740991max 9007199254740991monthlyarray<object> requiredWhat active subscriptions renew at each month, per currency
currencystring requiredcentsinteger required min -9007199254740991max 9007199254740991attentionarray<AttentionItem> requiredThings that need a look; only those the caller's permissions cover
Option 1objectkindstring requiredserver_errorserver_suspendedserverIdstring requiredserverNamestring requiredreasonstring | null requiredOption 2objectkindstring requiredinvoiceIdstring requirednumberstring | null requiredamountDueCentsinteger required min -9007199254740991max 9007199254740991currencystring requireddueAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$overdueboolean requiredOption 3objectkindstring requiredbilling_past_duebilling_suspendedOption 4objectkindstring requiredserverIdstring requiredserverNamestring requiredsnapshotNamestring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$activityarray<ActivityEntry> | null requiredThe latest 8 entries; null without `audit:read`
idstring requiredactionstring requiredDotted action, e.g. `server.start`
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$actorobject requiredtypestring requiredusertokenstaffsystemnamestring requiredA member's name, "API token <name>", "Support" or "Automatic"
emailstring | null requiredsummarystring requiredWhat they did, to follow the actor's name
targetTypestring requiredtargetIdstring requiredhrefstring | null requiredThe dashboard page for what it happened to, when it still exists
ipAddressstring | null requiredOnly for members' and API tokens' actions
metadataobject | null required
400The request failed validation404No such workspace
/workspaces/{workspaceId}Rename a team
Its slug, and so its URLs, stay the same. Personal workspaces can't be renamed. Needs `workspace:write` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64
Request body
namestring required min length 1max length 100
Responses
200 Renamed
idstring requiredslugstring requirednamestring requiredtypestring requiredPERSONALTEAMcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400A personal workspace, or no name403Not allowed404No such workspace
/workspaces/{workspaceId}Delete a team
Refused while it has servers, unpaid invoices or active subscriptions. Its API tokens and pending invites stop working. Personal workspaces can't be deleted. Needs `workspace:delete` (owners only) and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64
Request body
confirmNamestring required max length 200The workspace's current name, typed to confirm
Responses
200 Deleted
okboolean required
400A personal workspace, or the name doesn't match403Not allowed404No such workspace409Something still needs dealing with first
Servers
Servers in a workspace: power, rebuild, network, snapshots.
/servers/deploy-optionsWhat you can deploy
Plans with their locations, OS images, the workspace's limits and saved SSH keys, and how it's billed. Needs `servers:create`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
Responses
200 Options
packagesarray<object> requiredslugstring requirednamestring requiredvcpusinteger required min -9007199254740991max 9007199254740991memoryMbinteger required min -9007199254740991max 9007199254740991diskGbinteger required min -9007199254740991max 9007199254740991trafficGbinteger | null required min -9007199254740991max 9007199254740991monthlyPriceCentsinteger required min -9007199254740991max 9007199254740991USD cents
ipv4MonthlyCentsinteger required min -9007199254740991max 9007199254740991backupMonthlyPriceCentsinteger required min -9007199254740991max 9007199254740991locationsarray<object> requiredslugstring requirednamestring requiredimageGroupsarray<string> | null requiredAllowed image groups; null = all
imageGroupsarray<object> requiredslugstring requirednamestring requirediconstring | null requiredLogo key, e.g. ubuntu
imagesarray<object> requiredslugstring requirednamestring requiredminDiskGbinteger required min -9007199254740991max 9007199254740991limitsobject requiredserversobject requiredusedinteger required min -9007199254740991max 9007199254740991maxinteger required min -9007199254740991max 9007199254740991vcpusobject requiredusedinteger required min -9007199254740991max 9007199254740991maxinteger required min -9007199254740991max 9007199254740991billingobject requiredmodestring requiredPREPAID_MONTHLYPOSTPAID_USAGEstatusstring requiredACTIVEPAST_DUESUSPENDEDCLOSEDcurrencystring requiredcreditBalanceCentsinteger required min -9007199254740991max 9007199254740991paymentMethodobject | null requiredtypestring requiredbrandstring | null requiredlast4string | null requiredexpMonthinteger | null required min -9007199254740991max 9007199254740991expYearinteger | null required min -9007199254740991max 9007199254740991sshKeysarray<object> requiredidstring requirednamestring requiredfingerprintstring requiredtypestring required
403Not allowed
/serversList servers
Newest first. Destroyed servers are left out. Needs `servers:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
qquery · string max length 100Name, hostname or the start of an IP address
statusquery · string`building` and `setting_up` are the same group
runningstoppedbuildingsetting_upbusyrescuesuspendederror
Responses
200 The servers
itemsarray<Server> requiredidstring requirednamestring requiredhostnamestring requiredstatusstring requiredPENDINGPROVISIONINGRUNNINGSTOPPEDSTARTINGSTOPPINGREBOOTINGRESIZINGREBUILDINGRESTORINGMIGRATINGRESCUESUSPENDEDERRORDESTROYINGDESTROYEDstatusReasonstring | null requiredWhy it is suspended, or the last error
desiredPowerStatestring requiredRUNNINGSTOPPEDipv4array<string> requiredipv6array<string> requiredRouted /64 networks
hostIdstring | null requiredbackupsEnabledboolean requiredactiveSnapshotIdstring | null requireddeletionProtectionboolean requiredvcpusinteger required min -9007199254740991max 9007199254740991memoryMbinteger required min -9007199254740991max 9007199254740991diskGbinteger required min -9007199254740991max 9007199254740991packageobject requiredidstring requiredslugstring requirednamestring requiredimageobject | null requiredidstring requirednamestring requireddistributionstring requiredversionstring requireddefaultUserstring requiredwindowsboolean requiredregionobject requiredslugstring requirednamestring requiredcitystring | null requiredcountrystring requiredlocationstring requiredtrafficobject requiredusedBytesnumber requiredlimitGbinteger | null required min -9007199254740991max 9007199254740991Monthly allowance; null = unlimited
throttleMbpsinteger | null required min -9007199254740991max 9007199254740991throttledboolean requiredperiodStartstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$measuredAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$operationobject | null requiredThe action queued or in progress, if any
idstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such workspace
/serversDeploy a server
Places an order billed to the workspace, with prices locked in. Prepaid: an invoice is issued and charged; once paid, the server is built (`serverId` is set). Postpaid: the server is built at once. Needs `servers:create` (and `ssh_keys:read` to choose saved keys).
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
Request body
packagestring required min length 1max length 100Package slug, e.g. nvme-2 (see GET /servers/deploy-options)
locationstring required min length 1max length 100Location slug, e.g. dallas
imagestring required min length 1max length 100OS image slug, e.g. ubuntu-24-04-x64
hostnamestring required min length 1max length 253Also the server’s name
sshKeyIdsarray<string> max 20 itemsdefault []Saved SSH keys in the workspace
sshPublicKeystring | null max length 16384A new public key to add (saved to the workspace too)
currencystring default "USD"Prepaid orders are charged in this currency. Postpaid accounts use their own.
USDEURGBPCADAUDNZDSEKPLNBRLJPY
Responses
201 Order placed
orderIdstring requiredstatusstring required`completed`: the server is being built. `awaiting_payment`: pay invoiceId first.
completedawaiting_paymentserverIdstring | null requiredSet once the order is paid (or at once, for postpaid)
invoiceIdstring | null required
400A field is invalid (see `fields`)403Not allowed409Over a limit, an unpaid balance, an unpaid order for the same name, or an SSH key not in the workspace
/servers/{id}Get a server
With its network interfaces, and its price when you can see billing (`billing:read`). Needs `servers:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 The server
idstring requirednamestring requiredhostnamestring requiredstatusstring requiredPENDINGPROVISIONINGRUNNINGSTOPPEDSTARTINGSTOPPINGREBOOTINGRESIZINGREBUILDINGRESTORINGMIGRATINGRESCUESUSPENDEDERRORDESTROYINGDESTROYEDstatusReasonstring | null requiredWhy it is suspended, or the last error
desiredPowerStatestring requiredRUNNINGSTOPPEDipv4array<string> requiredipv6array<string> requiredRouted /64 networks
hostIdstring | null requiredbackupsEnabledboolean requiredactiveSnapshotIdstring | null requireddeletionProtectionboolean requiredvcpusinteger required min -9007199254740991max 9007199254740991memoryMbinteger required min -9007199254740991max 9007199254740991diskGbinteger required min -9007199254740991max 9007199254740991packageobject requiredidstring requiredslugstring requirednamestring requiredimageobject | null requiredidstring requirednamestring requireddistributionstring requiredversionstring requireddefaultUserstring requiredwindowsboolean requiredregionobject requiredslugstring requirednamestring requiredcitystring | null requiredcountrystring requiredlocationstring requiredtrafficobject requiredusedBytesnumber requiredlimitGbinteger | null required min -9007199254740991max 9007199254740991Monthly allowance; null = unlimited
throttleMbpsinteger | null required min -9007199254740991max 9007199254740991throttledboolean requiredperiodStartstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$measuredAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$operationobject | null requiredThe action queued or in progress, if any
idstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$interfacesarray<object> requiredidstring requirednamestring requiredmacAddressstring requiredaddressesarray<object> requiredidstring requiredfamilystring requiredV4V6addressstring requiredprefixLengthinteger required min -9007199254740991max 9007199254740991gatewaystring requiredptrRecordstring | null requiredReverse DNS name
pricingone of | null requiredWhat it costs, in minor units; null without `billing:read`
Option 1objectmodestring requiredcurrencystring requiredserverCentsinteger required min -9007199254740991max 9007199254740991ipv4Centsinteger required min -9007199254740991max 9007199254740991backupCentsinteger required min -9007199254740991max 9007199254740991totalCentsinteger required min -9007199254740991max 9007199254740991renewsAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Option 2objectmodestring requiredcurrencystring requiredhourlyCentsnumber requiredmonthlyEstimateCentsinteger required min -9007199254740991max 9007199254740991serverCentsinteger required min -9007199254740991max 9007199254740991ipv4Centsinteger required min -9007199254740991max 9007199254740991backupCentsinteger required min -9007199254740991max 9007199254740991
400The request failed validation403Not allowed404No such server
/servers/{id}Rename a server or change its deletion protection
Names are unique among the workspace's servers, ignoring case. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Request body
namestring max length 200deletionProtectionboolean
Responses
200 Updated
idstring requirednamestring requiredhostnamestring requiredstatusstring requiredPENDINGPROVISIONINGRUNNINGSTOPPEDSTARTINGSTOPPINGREBOOTINGRESIZINGREBUILDINGRESTORINGMIGRATINGRESCUESUSPENDEDERRORDESTROYINGDESTROYEDstatusReasonstring | null requiredWhy it is suspended, or the last error
desiredPowerStatestring requiredRUNNINGSTOPPEDipv4array<string> requiredipv6array<string> requiredRouted /64 networks
hostIdstring | null requiredbackupsEnabledboolean requiredactiveSnapshotIdstring | null requireddeletionProtectionboolean requiredvcpusinteger required min -9007199254740991max 9007199254740991memoryMbinteger required min -9007199254740991max 9007199254740991diskGbinteger required min -9007199254740991max 9007199254740991packageobject requiredidstring requiredslugstring requirednamestring requiredimageobject | null requiredidstring requirednamestring requireddistributionstring requiredversionstring requireddefaultUserstring requiredwindowsboolean requiredregionobject requiredslugstring requirednamestring requiredcitystring | null requiredcountrystring requiredlocationstring requiredtrafficobject requiredusedBytesnumber requiredlimitGbinteger | null required min -9007199254740991max 9007199254740991Monthly allowance; null = unlimited
throttleMbpsinteger | null required min -9007199254740991max 9007199254740991throttledboolean requiredperiodStartstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$measuredAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$operationobject | null requiredThe action queued or in progress, if any
idstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400Invalid name403Not allowed404No such server409Name taken
/servers/{id}/startStart a server
Queues a start. Refused while the server is suspended, being built or being destroyed. Send an `Idempotency-Key` header to make retries safe: a repeat with the same key returns the first action. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Request body
forcebooleanStop and reboot only: cut the power instead of asking the OS to shut down
Responses
202 Queued
idstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such server409Not possible in its current state, or busy
/servers/{id}/stopStop a server
Queues a shutdown: graceful unless `force` is true. Refused while the server is suspended, being built or being destroyed. Send an `Idempotency-Key` header to make retries safe: a repeat with the same key returns the first action. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Request body
forcebooleanStop and reboot only: cut the power instead of asking the OS to shut down
Responses
202 Queued
idstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such server409Not possible in its current state, or busy
/servers/{id}/rebootReboot a server
Queues a restart: graceful unless `force` is true. Refused while the server is suspended, being built or being destroyed. Send an `Idempotency-Key` header to make retries safe: a repeat with the same key returns the first action. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Request body
forcebooleanStop and reboot only: cut the power instead of asking the OS to shut down
Responses
202 Queued
idstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such server409Not possible in its current state, or busy
/servers/{id}/ip-addresses/{addressId}Set reverse DNS for an address
The PTR record of one of the server's addresses. Empty or null clears it. Changes take a few minutes to show. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64addressIdpath · string required min length 1max length 64
Request body
ptrRecordstring | null required max length 253A hostname like mail.example.com; empty or null clears it
Responses
200 Updated
idstring requiredaddressstring requiredptrRecordstring | null required
400Not a hostname403Not allowed404No such server or address
/servers/{id}/rebuild-optionsImages and SSH keys for a rebuild
Operating systems this server's plan and disk allow, and the workspace's SSH keys. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 The options
currentImageIdstring | null requiredimagesarray<object> requiredidstring requirednamestring requiredgroupstring | null requireddefaultUserstring requiredwindowsboolean requiredsshKeysarray<object> requiredidstring requirednamestring requiredfingerprintstring requiredonServerboolean requiredAlready on this server
400The request failed validation403Not allowed404No such server
/servers/{id}/rebuildRebuild a server
Reinstalls it from an image with the given SSH keys, erasing its disk. Keeps its IP addresses. Refused while a snapshot is in place. Send an `Idempotency-Key` header to make retries safe: a repeat with the same key returns the first action. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Request body
imageIdstring required min length 1max length 64sshKeyIdsarray<string> max 50 itemsdefault []
Responses
202 Queued
idstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400Image or key not available403Not allowed404No such server409Not possible in its current state, or busy
/servers/{id}/destroyDestroy a server
Deletes the server and its disk, and stops billing for it. Its backups are kept. Refused while deletion protection is on. Send an `Idempotency-Key` header to make retries safe: a repeat with the same key returns the first action. Needs `servers:destroy`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
202 Queued
idstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such server409Deletion protection is on, or busy
/servers/{id}/operationsA server's activity
Its last 100 actions, newest first, and changes made to it (those need `audit:read`; null without). Needs `servers:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 The activity
operationsarray<object> requiredidstring requiredtypestring requiredCREATESTARTSTOPREBOOTRESIZEREBUILDDESTROYMIGRATESNAPSHOT_CREATESNAPSHOT_COMMITSNAPSHOT_REVERTBACKUP_CREATEBACKUP_RESTOREBACKUP_DELETEPROVISIONRESCUE_ENTERRESCUE_EXITMEDIA_MOUNTMEDIA_UNMOUNTAPPLY_LIMITSstatusstring requiredQUEUEDRUNNINGSUCCEEDEDFAILEDCANCELEDerrorstring | null requiredWhy it failed, when it did
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$startedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$finishedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$requestedBystring | null requiredA person's name, "API token <name>", or null for the platform itself
eventsarray<object> | null requiredChanges to the server, from the activity log; null without `audit:read`
idstring requiredactionstring requiredactorstring | null requiredmetadataobject | null requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such server
/servers/{serverId}/snapshotsA server's snapshots
The current snapshot, if any, and the last 50, newest first. Needs `servers:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
serverIdpath · string required min length 1max length 64
Responses
200 The snapshots
serverobject requiredidstring requirednamestring requiredstatusstring requiredactiveSnapshotIdstring | null requiredactiveOperationobject | null requiredThe server's action in progress, if any; other actions wait for it
idstring requiredtypestring requiredstatusstring requiredQUEUEDRUNNINGcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$snapshotsarray<Snapshot> requiredidstring requirednamestring requiredstatusstring requiredCREATINGACTIVECOMMITTINGREVERTINGCOMMITTEDREVERTEDFAILEDsizeBytesinteger | null required min -9007199254740991max 9007199254740991How much the layer has grown, when known
autoCommitAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Kept automatically at this time
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$resolvedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$When it was kept or discarded
createdBystring | null requiredactiveboolean requiredThe server's current layer
400The request failed validation403Not allowed404No such server
/servers/{serverId}/snapshotsTake a snapshot
Saves the disk as it is now; everything after goes into a separate layer that you then commit (keep) or revert (throw away). One at a time. Optionally commits itself after `autoCommitHours`. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
serverIdpath · string required min length 1max length 64
Request body
namestring max length 100Defaults to the server name and time
autoCommitHoursinteger | null min 1max 720Keep the changes automatically after this many hours
Responses
202 Queued
snapshotIdstring | null requiredoperationIdstring required
400The request failed validation403Not allowed404No such server409A snapshot is already in place, or The server is busy with another action, or the request conflicts with its state
/servers/{serverId}/snapshots/{id}/commitKeep the changes since a snapshot
Merges the layer into the disk and ends the snapshot. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
serverIdpath · string required min length 1max length 64idpath · string required min length 1max length 64
Responses
202 Queued
operationIdstring required
400The request failed validation403Not allowed404No such server or snapshot409Not active, or The server is busy with another action, or the request conflicts with its state
/servers/{serverId}/snapshots/{id}/revertGo back to a snapshot
Throws away everything written since the snapshot. Needs `servers:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
serverIdpath · string required min length 1max length 64idpath · string required min length 1max length 64
Responses
202 Queued
operationIdstring required
400The request failed validation403Not allowed404No such server or snapshot409Not active, or The server is busy with another action, or the request conflicts with its state
Backups
Backups of servers in a workspace.
/backupsList backups
Every backup in the workspace, newest first, including those of destroyed servers. Needs `backups:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
serverIdquery · string min length 1max length 64Only backups of this server
Responses
200 The backups
itemsarray<Backup> requiredidstring requirednamestring requiredkindstring requiredSCHEDULEDMANUALstatusstring requiredCREATINGAVAILABLEFAILEDDELETINGDELETEDsizeBytesinteger | null required min -9007199254740991max 9007199254740991Known once the backup is AVAILABLE
minDiskGbinteger required min -9007199254740991max 9007199254740991Smallest disk this backup can be restored to
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$imagestring | null requiredOS image the server was built from
serverobject | null requiredThe server it was taken from; null once that server is destroyed
idstring requirednamestring requiredformerServerNamestring | null requiredName of the destroyed server it came from
400The request failed validation403Not allowed404No such workspace
/backups/{id}Delete a backup
Marks it DELETING; it is removed from storage shortly after. Needs `backups:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 Being deleted
okboolean required
400The request failed validation403Not allowed404No such backup409Still being taken, already deleting, or The server is busy with another action, or the request conflicts with its state
/backups/{id}/restoreRestore a backup onto a server
Replaces the server's disk with the backup; anything written since is lost. The server must be in the backup's location, have at least `minDiskGb` of disk, and have no snapshot in place. Needs `backups:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Request body
serverIdstring required min length 1max length 64Server to restore onto; its disk is replaced
Responses
202 Queued
operationIdstring required
400Disk too small or wrong location403Not allowed404No such backup or server409The server is busy with another action, or the request conflicts with its state
/servers/{serverId}/backupsA server's backups
Its backups, newest first, and any action in progress. Needs `backups:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
serverIdpath · string required min length 1max length 64
Responses
200 Backups
serverobject requiredidstring requirednamestring requiredstatusstring requireddiskGbinteger required min -9007199254740991max 9007199254740991hasActiveSnapshotboolean requiredactiveOperationobject | null requiredThe server's action in progress, if any; other actions wait for it
idstring requiredtypestring requiredstatusstring requiredQUEUEDRUNNINGcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$backupsarray<Backup> requiredidstring requirednamestring requiredkindstring requiredSCHEDULEDMANUALstatusstring requiredCREATINGAVAILABLEFAILEDDELETINGDELETEDsizeBytesinteger | null required min -9007199254740991max 9007199254740991Known once the backup is AVAILABLE
minDiskGbinteger required min -9007199254740991max 9007199254740991Smallest disk this backup can be restored to
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$imagestring | null requiredOS image the server was built from
serverobject | null requiredThe server it was taken from; null once that server is destroyed
idstring requirednamestring requiredformerServerNamestring | null requiredName of the destroyed server it came from
400The request failed validation403Not allowed404No such server
/servers/{serverId}/backupsBack up a server now
Takes a manual backup, which counts toward the same retention as automatic ones. Not while a snapshot is in place. Needs `backups:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
serverIdpath · string required min length 1max length 64
Request body
namestring max length 100Defaults to the server name and time
Responses
202 Queued
backupIdstring | null requiredoperationIdstring required
400The request failed validation403Not allowed404No such server409The server is busy with another action, or the request conflicts with its state
SSH keys
Public keys added to new servers.
/ssh-keysList SSH keys
Newest first. Needs `ssh_keys:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
Responses
200 The keys
itemsarray<SshKey> requiredidstring requirednamestring requiredfingerprintstring requiredSHA256 fingerprint, as `ssh-keygen -lf` prints it
typestring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdBystring | null requiredserverCountinteger required min -9007199254740991max 9007199254740991Servers built with this key
403Not allowed404No such workspace
/ssh-keysAdd an SSH key
Offered when deploying or rebuilding a server. Needs `ssh_keys:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
Request body
namestring max length 100Defaults to the key's comment
publicKeystring required min length 1max length 16384One line from a .pub file
Responses
201 Added
idstring requirednamestring requiredfingerprintstring requiredSHA256 fingerprint, as `ssh-keygen -lf` prints it
typestring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdBystring | null requiredserverCountinteger required min -9007199254740991max 9007199254740991Servers built with this key
400Not a public key403Not allowed409Already added
/ssh-keys/{id}Remove an SSH key
Servers already built with it keep it. Needs `ssh_keys:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 Removed
okboolean required
400The request failed validation403Not allowed404No such key
Billing
Invoices, subscriptions and billing details.
/billingGet the billing overview
Billing mode and status, billing details, credit balance, what is due now, upcoming renewals, and (pay as you go) an estimate of usage so far this cycle. Needs `billing:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
Responses
200 The overview
accountobject | null requiredNull until the workspace first orders or saves billing details
billingEmailstring requiredWhere invoices and receipts are sent
legalNamestring | null requiredaddressLine1string | null requiredaddressLine2string | null requiredcitystring | null requiredregionstring | null requiredState or province
postalCodestring | null requiredcountrystring | null requiredISO 3166-1 alpha-2
taxStatusstring requiredTAXABLEEXEMPTREVERSE_CHARGEtaxIdstring | null requiredtaxIdTypestring | null requiredtaxIdVerifiedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$idstring requiredmodestring requiredPREPAID_MONTHLY: each server is charged a month ahead. POSTPAID_USAGE: hours are invoiced monthly in arrears.
PREPAID_MONTHLYPOSTPAID_USAGEstatusstring requiredACTIVEPAST_DUESUSPENDEDCLOSEDcurrencystring requiredLowercase ISO 4217 code
creditBalanceCentsinteger required min -9007199254740991max 9007199254740991paymentTermsDaysinteger required min -9007199254740991max 9007199254740991usageLimitCentsinteger | null required min -9007199254740991max 9007199254740991paymentsEnabledboolean requiredWhether invoices can be paid online now
amountDuearray<object> requiredcurrencystring requiredLowercase ISO 4217 code
centsinteger required min -9007199254740991max 9007199254740991countinteger required min -9007199254740991max 9007199254740991Open invoices
overdueinteger required min -9007199254740991max 9007199254740991Open invoices past their due date
subscriptionsarray<object> requiredidstring requirednamestring | null requiredstatusstring requiredACTIVEPAST_DUECANCELEDcurrencystring requiredLowercase ISO 4217 code
currentPeriodStartstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$currentPeriodEndstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$When it renews (or ends, if cancelAtPeriodEnd)
cancelAtPeriodEndboolean requiredtotalCentsinteger required min -9007199254740991max 9007199254740991Each renewal, in the subscription currency
itemsarray<object> requiredidstring requiredserverobject requiredidstring requirednamestring requiredpackageNamestring requiredpriceCentsinteger required min -9007199254740991max 9007199254740991backupPriceCentsinteger required min -9007199254740991max 9007199254740991ipv4PriceCentsinteger required min -9007199254740991max 9007199254740991totalCentsinteger required min -9007199254740991max 9007199254740991usageobject | null requiredPay-as-you-go accounts: an estimate of this cycle so far
periodStartstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$periodEndstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$currencystring requiredLowercase ISO 4217 code
estimatedCentsinteger required min -9007199254740991max 9007199254740991serversarray<object> requiredserverobject requiredidstring requirednamestring requiredhoursnumber requiredcentsinteger required min -9007199254740991max 9007199254740991defaultPaymentMethodobject | null requiredidstring requiredtypestring requiredCARDBANK_ACCOUNTMANUALbrandstring | null requiredlast4string | null requiredexpMonthinteger | null required min -9007199254740991max 9007199254740991expYearinteger | null required min -9007199254740991max 9007199254740991expiredboolean requiredisDefaultboolean requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
403Not allowed404No such workspace
/billing/detailsChange billing details
Billing email, legal name, address and tax ID. Send only the fields to change; `null` clears one. Applies to invoices issued from now on: issued invoices keep the details they were billed to. Changing the tax ID clears its verification. Needs `billing:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
Request body
billingEmailstring emailmax length 254pattern ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$legalNamestring | null max length 200addressLine1string | null max length 200addressLine2string | null max length 200citystring | null max length 100regionstring | null max length 100postalCodestring | null max length 20countrystring | null pattern ^[A-Za-z]{2}$ISO 3166-1 alpha-2
taxIdstring | null max length 50taxIdTypestring | null max length 20
Responses
200 The updated overview
accountobject | null requiredNull until the workspace first orders or saves billing details
billingEmailstring requiredWhere invoices and receipts are sent
legalNamestring | null requiredaddressLine1string | null requiredaddressLine2string | null requiredcitystring | null requiredregionstring | null requiredState or province
postalCodestring | null requiredcountrystring | null requiredISO 3166-1 alpha-2
taxStatusstring requiredTAXABLEEXEMPTREVERSE_CHARGEtaxIdstring | null requiredtaxIdTypestring | null requiredtaxIdVerifiedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$idstring requiredmodestring requiredPREPAID_MONTHLY: each server is charged a month ahead. POSTPAID_USAGE: hours are invoiced monthly in arrears.
PREPAID_MONTHLYPOSTPAID_USAGEstatusstring requiredACTIVEPAST_DUESUSPENDEDCLOSEDcurrencystring requiredLowercase ISO 4217 code
creditBalanceCentsinteger required min -9007199254740991max 9007199254740991paymentTermsDaysinteger required min -9007199254740991max 9007199254740991usageLimitCentsinteger | null required min -9007199254740991max 9007199254740991paymentsEnabledboolean requiredWhether invoices can be paid online now
amountDuearray<object> requiredcurrencystring requiredLowercase ISO 4217 code
centsinteger required min -9007199254740991max 9007199254740991countinteger required min -9007199254740991max 9007199254740991Open invoices
overdueinteger required min -9007199254740991max 9007199254740991Open invoices past their due date
subscriptionsarray<object> requiredidstring requirednamestring | null requiredstatusstring requiredACTIVEPAST_DUECANCELEDcurrencystring requiredLowercase ISO 4217 code
currentPeriodStartstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$currentPeriodEndstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$When it renews (or ends, if cancelAtPeriodEnd)
cancelAtPeriodEndboolean requiredtotalCentsinteger required min -9007199254740991max 9007199254740991Each renewal, in the subscription currency
itemsarray<object> requiredidstring requiredserverobject requiredidstring requirednamestring requiredpackageNamestring requiredpriceCentsinteger required min -9007199254740991max 9007199254740991backupPriceCentsinteger required min -9007199254740991max 9007199254740991ipv4PriceCentsinteger required min -9007199254740991max 9007199254740991totalCentsinteger required min -9007199254740991max 9007199254740991usageobject | null requiredPay-as-you-go accounts: an estimate of this cycle so far
periodStartstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$periodEndstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$currencystring requiredLowercase ISO 4217 code
estimatedCentsinteger required min -9007199254740991max 9007199254740991serversarray<object> requiredserverobject requiredidstring requirednamestring requiredhoursnumber requiredcentsinteger required min -9007199254740991max 9007199254740991defaultPaymentMethodobject | null requiredidstring requiredtypestring requiredCARDBANK_ACCOUNTMANUALbrandstring | null requiredlast4string | null requiredexpMonthinteger | null required min -9007199254740991max 9007199254740991expYearinteger | null required min -9007199254740991max 9007199254740991expiredboolean requiredisDefaultboolean requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400Invalid details403Not allowed
/billing/invoicesList invoices
Newest first, 25 to a page. Each is in the currency it was charged in. Needs `billing:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
pagequery · integer min 1max 9007199254740991default 11-based page number
statusquery · stringOPENPAIDVOIDUNCOLLECTIBLE
Responses
200 A page of invoices
itemsarray<Invoice> requiredidstring requirednumberstring | null requiredstatusstring requiredOPENPAIDVOIDUNCOLLECTIBLEcurrencystring requiredThe currency it was charged in
totalCentsinteger required min -9007199254740991max 9007199254740991amountDueCentsinteger required min -9007199254740991max 9007199254740991overdueboolean requiredperiodStartstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$periodEndstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$issuedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$dueAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$paidAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$totalinteger required min -9007199254740991max 9007199254740991pageinteger required min -9007199254740991max 9007199254740991pageSizeinteger required min -9007199254740991max 9007199254740991pageCountinteger required min -9007199254740991max 9007199254740991
400The request failed validation403Not allowed
/billing/invoices/{id}Get an invoice
With its line items, taxes, credit applied and payments. Needs `billing:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 The invoice
idstring requirednumberstring | null requiredstatusstring requiredOPENPAIDVOIDUNCOLLECTIBLEcurrencystring requiredThe currency it was charged in
totalCentsinteger required min -9007199254740991max 9007199254740991amountDueCentsinteger required min -9007199254740991max 9007199254740991overdueboolean requiredperiodStartstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$periodEndstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$issuedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$dueAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$paidAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$subtotalCentsinteger required min -9007199254740991max 9007199254740991taxCentsinteger required min -9007199254740991max 9007199254740991creditAppliedCentsinteger required min -9007199254740991max 9007199254740991amountPaidCentsinteger required min -9007199254740991max 9007199254740991voidedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$billedNamestring | null requiredbilledEmailstring requiredbilledAddressobject | null requiredAs it was when the invoice was issued
line1string | null requiredline2string | null requiredcitystring | null requiredregionstring | null requiredpostalCodestring | null requiredcountrystring | null requiredbilledTaxIdstring | null requiredlineItemsarray<object> requiredidstring requiredkindstring requiredSUBSCRIPTIONPRORATIONUSAGEADJUSTMENTdescriptionstring requiredquantitynumber requiredMonths, hours, or 1
unitPriceCentsnumber requiredMay have fractional cents
amountCentsinteger required min -9007199254740991max 9007199254740991periodStartstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$periodEndstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$serverIdstring | null requiredtaxesarray<object> requiredidstring requireddisplayNamestring requiredpercentagenumber requiredjurisdictionstring | null requiredtaxableAmountCentsinteger required min -9007199254740991max 9007199254740991amountCentsinteger required min -9007199254740991max 9007199254740991paymentsarray<object> requiredidstring requiredstatusstring requiredPENDINGSUCCEEDEDFAILEDREFUNDEDamountCentsinteger required min -9007199254740991max 9007199254740991currencystring requiredLowercase ISO 4217 code
failureReasonstring | null requiredmethodobject | null requiredtypestring requiredCARDBANK_ACCOUNTMANUALbrandstring | null requiredlast4string | null requiredtestboolean requiredRecorded in test mode; nothing was charged
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$creditsarray<object> requiredidstring requiredkindstring requiredGRANTPROMOREFUNDAPPLIEDEXPIREDADJUSTMENTamountCentsinteger required min -9007199254740991max 9007199254740991descriptionstring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such invoice
/billing/invoices/{id}/payPay an open invoice
Charges the amount due. If online payment isn't available, answers 409 and nothing is charged. Paying a new order's invoice builds its server. Needs `billing:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 Paid
idstring requirednumberstring | null requiredstatusstring requiredOPENPAIDVOIDUNCOLLECTIBLEcurrencystring requiredThe currency it was charged in
totalCentsinteger required min -9007199254740991max 9007199254740991amountDueCentsinteger required min -9007199254740991max 9007199254740991overdueboolean requiredperiodStartstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$periodEndstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$issuedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$dueAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$paidAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$subtotalCentsinteger required min -9007199254740991max 9007199254740991taxCentsinteger required min -9007199254740991max 9007199254740991creditAppliedCentsinteger required min -9007199254740991max 9007199254740991amountPaidCentsinteger required min -9007199254740991max 9007199254740991voidedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$billedNamestring | null requiredbilledEmailstring requiredbilledAddressobject | null requiredAs it was when the invoice was issued
line1string | null requiredline2string | null requiredcitystring | null requiredregionstring | null requiredpostalCodestring | null requiredcountrystring | null requiredbilledTaxIdstring | null requiredlineItemsarray<object> requiredidstring requiredkindstring requiredSUBSCRIPTIONPRORATIONUSAGEADJUSTMENTdescriptionstring requiredquantitynumber requiredMonths, hours, or 1
unitPriceCentsnumber requiredMay have fractional cents
amountCentsinteger required min -9007199254740991max 9007199254740991periodStartstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$periodEndstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$serverIdstring | null requiredtaxesarray<object> requiredidstring requireddisplayNamestring requiredpercentagenumber requiredjurisdictionstring | null requiredtaxableAmountCentsinteger required min -9007199254740991max 9007199254740991amountCentsinteger required min -9007199254740991max 9007199254740991paymentsarray<object> requiredidstring requiredstatusstring requiredPENDINGSUCCEEDEDFAILEDREFUNDEDamountCentsinteger required min -9007199254740991max 9007199254740991currencystring requiredLowercase ISO 4217 code
failureReasonstring | null requiredmethodobject | null requiredtypestring requiredCARDBANK_ACCOUNTMANUALbrandstring | null requiredlast4string | null requiredtestboolean requiredRecorded in test mode; nothing was charged
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$creditsarray<object> requiredidstring requiredkindstring requiredGRANTPROMOREFUNDAPPLIEDEXPIREDADJUSTMENTamountCentsinteger required min -9007199254740991max 9007199254740991descriptionstring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such invoice409Not open, or online payment unavailable
/billing/payment-methodsList payment methods
The default first. Needs `billing:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
Responses
200 The payment methods
itemsarray<PaymentMethod> requiredidstring requiredtypestring requiredCARDBANK_ACCOUNTMANUALbrandstring | null requiredlast4string | null requiredexpMonthinteger | null required min -9007199254740991max 9007199254740991expYearinteger | null required min -9007199254740991max 9007199254740991expiredboolean requiredisDefaultboolean requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
403Not allowed
/billing/payment-methods/{id}/defaultMake a payment method the default
Open invoices and renewals are charged to it. Needs `billing:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 The payment methods
itemsarray<PaymentMethod> requiredidstring requiredtypestring requiredCARDBANK_ACCOUNTMANUALbrandstring | null requiredlast4string | null requiredexpMonthinteger | null required min -9007199254740991max 9007199254740991expYearinteger | null required min -9007199254740991max 9007199254740991expiredboolean requiredisDefaultboolean requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such payment method409Card expired
/billing/payment-methods/{id}Remove a payment method
Removing the default makes the newest other method the default. Refused for the only method while servers are still billing. Needs `billing:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 Removed
okboolean required
400The request failed validation403Not allowed404No such payment method409Still needed
/billing/creditsList credit history
Newest first, 25 to a page, with the current balance. Needs `billing:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
pagequery · integer min 1max 9007199254740991default 11-based page number
Responses
200 A page of credit entries
itemsarray<CreditTransaction> requiredidstring requiredkindstring requiredGRANTPROMOREFUNDAPPLIEDEXPIREDADJUSTMENTamountCentsinteger required min -9007199254740991max 9007199254740991Positive adds credit; negative uses it
balanceAfterCentsinteger required min -9007199254740991max 9007199254740991descriptionstring requiredexpiresAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$invoiceobject | null requiredidstring requirednumberstring | null requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$totalinteger required min -9007199254740991max 9007199254740991pageinteger required min -9007199254740991max 9007199254740991pageSizeinteger required min -9007199254740991max 9007199254740991pageCountinteger required min -9007199254740991max 9007199254740991balanceCentsinteger required min -9007199254740991max 9007199254740991currencystring requiredLowercase ISO 4217 code
400The request failed validation403Not allowed
Members
People in a team workspace, and invites.
/workspaces/{workspaceId}/membersList members and pending invites
Owners first. Team workspaces only. Needs `members:read`.
Parameters
workspaceIdpath · string required min length 1max length 64
Responses
200 Members and invites
itemsarray<Member> requireduserIdstring requirednamestring requiredemailstring requiredavatarUrlstring | null requiredrolestring requiredOWNERADMINBILLINGMEMBERjoinedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$isYouboolean requiredinvitesarray<Invite> requiredInvites not yet accepted or revoked (expired ones included)
idstring requiredemailstring requiredrolestring requiredOWNERADMINBILLINGMEMBERinvitedBystring | null requiredsentAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$expiresAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$expiredboolean required
400The request failed validation403Not allowed404No such workspace, or a personal one
/workspaces/{workspaceId}/members/{userId}Change a member's role
Only an owner can make someone an owner or change an owner's role, and a team always keeps at least one owner. Needs `members:write` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64userIdpath · string required min length 1max length 64
Request body
rolestring requiredOWNERADMINBILLINGMEMBER
Responses
200 Updated
userIdstring requirednamestring requiredemailstring requiredavatarUrlstring | null requiredrolestring requiredOWNERADMINBILLINGMEMBERjoinedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$isYouboolean required
400The request failed validation403Not allowed404No such member409Would leave the team without an owner
/workspaces/{workspaceId}/members/{userId}Remove a member
Their API tokens in this workspace are revoked too. Only an owner can remove an owner, and never the last one. Removing yourself is the same as leaving. Needs `members:write` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64userIdpath · string required min length 1max length 64
Responses
200 Removed
okboolean required
400The request failed validation403Not allowed404No such member409The last owner
/workspaces/{workspaceId}/leaveLeave a team
Your API tokens in it are revoked. The team's last owner can't leave: make someone else an owner first, or delete the team. Needs a signed-in member.
Parameters
workspaceIdpath · string required min length 1max length 64
Responses
200 Left
okboolean required
400The request failed validation403An API token404No such workspace409The last owner
/workspaces/{workspaceId}/invitesInvite someone
Emails a link that works for 7 days. If the address already has a pending invite, that one is refreshed (new link, new role). `emailSent` is false if the email could not be sent: pass `url` on yourself. Only an owner can invite an owner. Needs `members:write` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64
Request body
emailstring required min length 3max length 254rolestringOWNERADMINBILLINGMEMBER
Responses
201 Invited
inviteobject requiredidstring requiredemailstring requiredrolestring requiredOWNERADMINBILLINGMEMBERinvitedBystring | null requiredsentAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$expiresAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$expiredboolean requiredurlstring requiredThe invite link, to pass on yourself if the email could not be sent
emailSentboolean required
400Not an email address403Not allowed409Already a member, or invited under a minute ago
/workspaces/{workspaceId}/invites/{id}/resendResend an invite
Emails a fresh link (the old one stops working), good for another 7 days. Needs `members:write` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64idpath · string required min length 1max length 64
Responses
200 Sent
inviteobject requiredidstring requiredemailstring requiredrolestring requiredOWNERADMINBILLINGMEMBERinvitedBystring | null requiredsentAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$expiresAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$expiredboolean requiredurlstring requiredThe invite link, to pass on yourself if the email could not be sent
emailSentboolean required
400The request failed validation403Not allowed404No such invite409Sent under a minute ago
/workspaces/{workspaceId}/invites/{id}Revoke an invite
Its link stops working. Needs `members:write` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64idpath · string required min length 1max length 64
Responses
200 Revoked
okboolean required
400The request failed validation403Not allowed404No such invite
/invites/previewLook up an invite
The team, role and inviter of an emailed invite, and whether you can accept it. Sent as a POST so the token stays out of URLs and logs. Needs a signed-in user.
Request body
tokenstring required min length 1max length 128
Responses
200 The invite
statusstring requiredinvalidpendingexpiredrevokedacceptedworkspaceobjectnamestring requiredslugstring requiredrolestringOWNERADMINBILLINGMEMBERinviterstring | nullemailstringemailMatchesbooleanWhether you're signed in with the invited address
isMemberboolean
400The request failed validation401Not signed in
/invites/acceptAccept an invite
Joins the team. You must be signed in with the invited address. If you're already in the team, you keep your role unless the invite's is higher. Needs a signed-in user.
Request body
tokenstring required min length 1max length 128
Responses
200 Joined
workspaceobject requiredidstring requiredslugstring requirednamestring requiredrolestring requiredOWNERADMINBILLINGMEMBER
400The request failed validation401Not signed in403Signed in with a different address404No such invite409Expired, revoked or already accepted
API tokens
Tokens for scripts and tools, scoped to one workspace.
/workspaces/{workspaceId}/api-tokensList API tokens
Newest first, revoked and expired ones included. Never includes the tokens themselves. Needs `tokens:manage` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64
Responses
200 The tokens
itemsarray<ApiToken> requiredidstring requirednamestring requiredprefixstring requiredThe start of the token, to tell tokens apart
scopesarray<string> requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdBystring | null requiredexpiresAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$lastUsedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$lastUsedIpstring | null requiredrevokedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$statusstring requiredactiveexpiredrevoked
400The request failed validation403Not allowed404No such workspace
/workspaces/{workspaceId}/api-tokensCreate an API token
Scopes must be ones your role has, and a token never does more than its creator's current role allows. The full token is in this response only: store it now. Needs `tokens:manage` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64
Request body
namestring required min length 1max length 100scopesarray<string> required min 1 itemsmax 32 itemsPermissions from the token scopes your role has
expiresInDaysone of required30, 90 or 365; null for a token that never expires
Option 1numberOption 2numberOption 3numberOption 4null
Responses
201 Created
tokenstring requiredThe full token. It is shown only this once.
itemobject requiredidstring requirednamestring requiredprefixstring requiredThe start of the token, to tell tokens apart
scopesarray<string> requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdBystring | null requiredexpiresAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$lastUsedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$lastUsedIpstring | null requiredrevokedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$statusstring requiredactiveexpiredrevoked
400Bad name, scopes or expiry403Not allowed, or a scope your role lacks409Too many tokens
/workspaces/{workspaceId}/api-tokens/{id}Revoke an API token
It stops working at once; it stays listed as revoked. Needs `tokens:manage` and a signed-in user.
Parameters
workspaceIdpath · string required min length 1max length 64idpath · string required min length 1max length 64
Responses
200 Revoked
okboolean required
400The request failed validation403Not allowed404No such token
Activity
What happened in a workspace, and who did it.
/activityList activity
The workspace's audit log, newest first, 50 a page, each entry with a plain-words summary. Filter by who (a member or API token), area (the action's prefix) and dates. Staff actions appear as Support. Needs `audit:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
pagequery · integer min 1max 9007199254740991default 1whoquery · string pattern ^(user:\S+|token:\S+|staff|system)$`user:<userId>`, `token:<apiTokenId>`, `staff` (Support) or `system`
areaquery · stringserverbackupssh_keymemberinviteapi_tokenticketbillingworkspacefromquery · string pattern ^\d{4}-\d{2}-\d{2}$First day, inclusive (UTC)
toquery · string pattern ^\d{4}-\d{2}-\d{2}$Last day, inclusive (UTC)
Responses
200 One page of entries
itemsarray<ActivityEntry> requiredidstring requiredactionstring requiredDotted action, e.g. `server.start`
createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$actorobject requiredtypestring requiredusertokenstaffsystemnamestring requiredA member's name, "API token <name>", "Support" or "Automatic"
emailstring | null requiredsummarystring requiredWhat they did, to follow the actor's name
targetTypestring requiredtargetIdstring requiredhrefstring | null requiredThe dashboard page for what it happened to, when it still exists
ipAddressstring | null requiredOnly for members' and API tokens' actions
metadataobject | null requiredpageinteger required min -9007199254740991max 9007199254740991pageCountinteger required min -9007199254740991max 9007199254740991pageSizeinteger required min -9007199254740991max 9007199254740991totalinteger required min -9007199254740991max 9007199254740991
400Bad filter403Not allowed404No such workspace
Support
Support tickets: conversations with the support team.
/ticketsList support tickets
The workspace's tickets, latest message first. Needs `support:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
statusquery · string`open` includes answered tickets
openclosed
Responses
200 The tickets
itemsarray<TicketSummary> requiredidstring requirednumberinteger required min -9007199254740991max 9007199254740991Short number for people, as in "#1042"
subjectstring requiredcategorystring requiredTECHNICALBILLINGSALESABUSEOTHERprioritystring requiredLOWNORMALHIGHURGENTstatusstring required`OPEN` is waiting on support, `ANSWERED` on you. Replying to a `CLOSED` ticket opens it again.
OPENANSWEREDCLOSEDserverobject | null requiredThe server it is about
idstring requirednamestring requiredopenedBystring | null requiredmessageCountinteger required min -9007199254740991max 9007199254740991lastMessageAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$closedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed
/ticketsOpen a support ticket
With its first message. Needs `support:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
Request body
subjectstring required min length 1max length 200bodystring required min length 1max length 20000The first message
categorystringDefaults to `TECHNICAL`
TECHNICALBILLINGSALESABUSEOTHERprioritystringDefaults to `NORMAL`
LOWNORMALHIGHURGENTserverIdstring | null max length 64A server in the workspace it is about
Responses
201 Opened
idstring requirednumberinteger required min -9007199254740991max 9007199254740991Short number for people, as in "#1042"
subjectstring requiredcategorystring requiredTECHNICALBILLINGSALESABUSEOTHERprioritystring requiredLOWNORMALHIGHURGENTstatusstring required`OPEN` is waiting on support, `ANSWERED` on you. Replying to a `CLOSED` ticket opens it again.
OPENANSWEREDCLOSEDserverobject | null requiredThe server it is about
idstring requirednamestring requiredopenedBystring | null requiredmessageCountinteger required min -9007199254740991max 9007199254740991lastMessageAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$closedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$messagesarray<TicketMessage> requiredidstring requiredstaffboolean requiredWritten by the support team
authorstring requiredmineboolean requiredWritten by you
bodystring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such server409Too many open tickets
/tickets/{id}Get a support ticket
With its messages, oldest first. Needs `support:read`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 The ticket
idstring requirednumberinteger required min -9007199254740991max 9007199254740991Short number for people, as in "#1042"
subjectstring requiredcategorystring requiredTECHNICALBILLINGSALESABUSEOTHERprioritystring requiredLOWNORMALHIGHURGENTstatusstring required`OPEN` is waiting on support, `ANSWERED` on you. Replying to a `CLOSED` ticket opens it again.
OPENANSWEREDCLOSEDserverobject | null requiredThe server it is about
idstring requirednamestring requiredopenedBystring | null requiredmessageCountinteger required min -9007199254740991max 9007199254740991lastMessageAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$closedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$messagesarray<TicketMessage> requiredidstring requiredstaffboolean requiredWritten by the support team
authorstring requiredmineboolean requiredWritten by you
bodystring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such ticket
/tickets/{id}/messagesReply to a support ticket
Replying to a closed ticket opens it again. Needs `support:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Request body
bodystring required min length 1max length 20000
Responses
201 The ticket, with the reply
idstring requirednumberinteger required min -9007199254740991max 9007199254740991Short number for people, as in "#1042"
subjectstring requiredcategorystring requiredTECHNICALBILLINGSALESABUSEOTHERprioritystring requiredLOWNORMALHIGHURGENTstatusstring required`OPEN` is waiting on support, `ANSWERED` on you. Replying to a `CLOSED` ticket opens it again.
OPENANSWEREDCLOSEDserverobject | null requiredThe server it is about
idstring requirednamestring requiredopenedBystring | null requiredmessageCountinteger required min -9007199254740991max 9007199254740991lastMessageAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$closedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$messagesarray<TicketMessage> requiredidstring requiredstaffboolean requiredWritten by the support team
authorstring requiredmineboolean requiredWritten by you
bodystring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such ticket
/tickets/{id}/closeClose a support ticket
When the problem is solved. Reply to open it again. Needs `support:write`.
Parameters
Workspaceheader · stringThe workspace's ID or slug. With an API token, leave it out: the token's own workspace is used. Signed in, it defaults to your personal workspace. `?workspace=` works too.
idpath · string required min length 1max length 64
Responses
200 The closed ticket
idstring requirednumberinteger required min -9007199254740991max 9007199254740991Short number for people, as in "#1042"
subjectstring requiredcategorystring requiredTECHNICALBILLINGSALESABUSEOTHERprioritystring requiredLOWNORMALHIGHURGENTstatusstring required`OPEN` is waiting on support, `ANSWERED` on you. Replying to a `CLOSED` ticket opens it again.
OPENANSWEREDCLOSEDserverobject | null requiredThe server it is about
idstring requirednamestring requiredopenedBystring | null requiredmessageCountinteger required min -9007199254740991max 9007199254740991lastMessageAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$closedAtstring | null date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$createdAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$messagesarray<TicketMessage> requiredidstring requiredstaffboolean requiredWritten by the support team
authorstring requiredmineboolean requiredWritten by you
bodystring requiredcreatedAtstring required date-timepattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
400The request failed validation403Not allowed404No such ticket