Account, keys and billing

How-to guides

Account 14

Key introspection and the write log of your API keys.

• GET/whoamiDescribe the calling API key
• GET/cloud/activityList write calls made with your API keys
• GET/pingPing
• GET/meGet me
• PATCH/meUpdate me
• GET/me/securityGet security
• GET/me/notificationsGet notifications
• PUT/me/notificationsUpdate notifications
• GET/addressesList addresses
• POST/addressesCreate address
• GET/addresses/{id}Get address (path: {id})
• PUT/addresses/{id}Update address (path: {id})
• DELETE/addresses/{id}Delete address (path: {id})
• POST/addresses/{id}/defaultSet default address (path: {id})

Account limits 1

Every limit of your account and its current usage in one place. Limits are raised on request: open a support ticket.

• GET/cloud/account/limitsAccount limits and usage

API keys 3

Sub-account keys narrowed to services, actions or a reseller end-customer. Only GyroAPI /cloud routes accept them.

• GET/cloud/keysList sub-account keys (never shows tokens)
• POST/cloud/keysCreate a sub-account key (token returned once)
• DELETE/cloud/keys/{id}Delete a sub-account key

Projects 7

Group your services into projects (e.g. one per business, client or environment). Every service is in exactly one project; services without one are in the default project (id 0). Invoices are not split by project.

• GET/cloud/projectsList projects
• POST/cloud/projectsCreate a project
• GET/cloud/projects/{id}Get a project with its service ids
• PATCH/cloud/projects/{id}Rename / recolour a project
• DELETE/cloud/projects/{id}Delete a project
• POST/cloud/projects/{id}/servicesMove services into a project
• PUT/cloud/services/{id}/projectSet the project of a service

Webhooks 7

Signed HTTPS callbacks for service, invoice, order and ticket events.

• GET/cloud/webhooksList webhooks
• POST/cloud/webhooksCreate a webhook (secret returned once)
• GET/cloud/webhooks/{id}Get a webhook
• PATCH/cloud/webhooks/{id}Update url, events, description or status
• DELETE/cloud/webhooks/{id}Delete a webhook
• POST/cloud/webhooks/{id}/testSend an api.test event now
• GET/cloud/webhooks/{id}/deliveriesLast 100 deliveries

Panel users 5

Sub-users: extra panel logins with limited permissions (accountant, technical staff). Scope users.

• GET/cloud/usersList sub-users
• POST/cloud/usersInvite a sub-user
• PATCH/cloud/users/{id}Update a sub-user (label, status, permissions)
• DELETE/cloud/users/{id}Remove a sub-user
• POST/cloud/users/{id}/resend-inviteResend the invitation e-mail

Billing 16

Invoices and account balance (read-only with the recommended scopes).

• GET/invoicesList invoices
• GET/invoices/{id}Get an invoice
• GET/balanceAccount balance
• GET/balance/transactionsBalance ledger
• POST/cloud/invoices/{id}/payPay an invoice from the account balance
• GET/cloud/invoices/{id}/pdfInvoice PDF (base64 in JSON)
• POST/cloud/balance/top-upCreate a balance top-up invoice and get its payment link
• POST/invoices/{id}/payPay invoice (path: {id})
• POST/invoices/{id}/couponApply invoice coupon (path: {id})
• PATCH/balance/settingsUpdate balance settings
• GET/cloud/billing/balanceBalance, hourly cost of running prepaid services and estimated time left
• GET/cloud/billing/usageHour-by-hour usage ledger (or daily/monthly totals). Times are Europe/Istanbul.
• GET/cloud/billing/statement/{month}Monthly usage statement (not an invoice); JSON, PDF or CSV
• POST/cloud/billing/estimateHourly / daily / monthly cost of prepaid plans and serverless containers, and how long the balance lasts
• GET/cloud/billing/topup-urlBrowser link of the balance top-up page (top-ups are invoiced with VAT; usage is not)
• GET/cloud/billing/container-sizesServerless container sizes (vCPU / memory pairs) and prices

Reference data 3

Countries, states, cities.

• GET/reference/countriesList countries
• GET/reference/countries/{code}/statesList states (path: {code})
• GET/reference/states/{id}/citiesList cities (path: {id})