|
cloud:read
|
Read your cloud — instances, volumes and their snapshots, ISOs, templates, firewall rules, public IP addresses, VPN and affinity groups, the offerings behind them, and your usage records. Also reveals an instance's saved password. |
cloud: view
|
GET /affinity-groups
GET /compute-offerings
GET /disk-offerings
GET /egress-rules
GET /ingress-rules
GET /instances
GET /instances/{instance}
GET /instances/{instance}/annotations
GET /instances/{instance}/events
GET /instances/{instance}/networks
GET /instances/{instance}/password
GET /instances/{instance}/schedules
GET /instances/{instance}/vm-snapshots
GET /isos
GET /isos/{iso}
GET /networks
GET /networks/{network}
GET /public-ip-addresses
GET /public-ip-addresses/{publicIPAddress}
GET /public-ip-addresses/{publicIPAddress}/move-plan
GET /templates
GET /templates/{template}
GET /usage
GET /volumes
GET /volumes/{volume}
GET /volumes/{volume}/snapshot-policies
GET /volumes/{volume}/snapshots
GET /volumes/{volume}/snapshots/{snapshot}
GET /vpn
GET /vpn/users
|
|
cloud:write
|
Start, stop, restart and rename your machines, reset a password, open a console, attach and detach ISOs and volumes, take disk snapshots, and manage firewall rules, VPN users and affinity groups. |
cloud: manage
|
POST /affinity-groups
DELETE /affinity-groups/{affinityGroup}
PATCH /affinity-groups/{affinityGroup}
POST /egress-rules
DELETE /egress-rules/{egressRule}
POST /ingress-rules
DELETE /ingress-rules/{ingressRule}
PATCH /ingress-rules/{ingressRule}
PATCH /instances/{instance}
POST /instances/{instance}/actions/attach-iso
POST /instances/{instance}/actions/detach-iso
POST /instances/{instance}/actions/reset-password
POST /instances/{instance}/actions/restart
POST /instances/{instance}/actions/start
POST /instances/{instance}/actions/stop
POST /instances/{instance}/annotations
DELETE /instances/{instance}/annotations/{annotation}
GET /instances/{instance}/console
POST /instances/{instance}/networks/{network}/actions/attach
POST /instances/{instance}/networks/{network}/actions/change-ip
POST /instances/{instance}/networks/{network}/actions/detach
POST /instances/{instance}/networks/{network}/actions/make-primary
POST /instances/{instance}/networks/{network}/actions/move
POST /instances/{instance}/schedules
DELETE /instances/{instance}/schedules/{schedule}
PATCH /instances/{instance}/schedules/{schedule}
POST /instances/{instance}/vm-snapshots
DELETE /instances/{instance}/vm-snapshots/{vmSnapshot}
POST /instances/{instance}/vm-snapshots/{vmSnapshot}/actions/revert
POST /isos/uploads
DELETE /isos/uploads/{upload}
GET /isos/uploads/{upload}
POST /isos/uploads/{upload}/actions/complete
POST /isos/uploads/{upload}/chunks
DELETE /isos/{iso}
PATCH /isos/{iso}
DELETE /networks/{network}
PATCH /networks/{network}
POST /public-ip-addresses/{publicIPAddress}/actions/move
PATCH /volumes/{volume}
POST /volumes/{volume}/actions/attach
POST /volumes/{volume}/actions/detach
POST /volumes/{volume}/snapshot-policies
POST /volumes/{volume}/snapshots
DELETE /volumes/{volume}/snapshots/{snapshot}
POST /volumes/{volume}/snapshots/{snapshot}/actions/restore
PATCH /vpn
POST /vpn/users
DELETE /vpn/users/{vpnUser}
|
|
dns:read
|
Read your DNS zones and every record in them. |
dns: view
|
GET /dns-zones
GET /dns-zones/{zone}
GET /dns-zones/{zone}/records
|
|
dns:write
|
Create and delete DNS zones, add, change and remove records, and set the reverse DNS record of a public IP address. |
dns: manage
|
POST /dns-zones
DELETE /dns-zones/{zone}
POST /dns-zones/{zone}/records
DELETE /dns-zones/{zone}/records/{record}
PATCH /dns-zones/{zone}/records/{record}
PATCH /public-ip-addresses/{publicIPAddress}
|
|
billing:read
|
Read your subscriptions, orders, payments, refunds, saved cards, account balance and the product catalogue. |
billing: view
|
GET /billing/account
GET /billing/credits
GET /credit-cards
GET /domain-name-products
GET /domain-name-products/{domainNameProduct}
GET /ip-address-products
GET /ip-address-products/{ipAddressProduct}
GET /network-products
GET /network-products/{networkProduct}
GET /payments
GET /payments/{payment}
GET /payments/{payment}/invoice
GET /payments/{payment}/proforma
GET /refunds
GET /service-products
GET /service-products/{serviceProduct}
GET /subscriptions
GET /subscriptions/{subscription}
GET /subscriptions/{subscription}/resize-quote
GET /virtual-machine-products
GET /virtual-machine-products/{virtualMachineProduct}
GET /volume-products
GET /volume-products/{volumeProduct}
|
|
billing:write
|
Pay an open bill with a saved card, ask for a refund inside the refund window, confirm that your company's invoice may be cancelled, and delete a saved card. Paying charges the card with no further confirmation; a card that needs 3-D Secure is sent back to the browser. A card is added only on the website. |
billing: manage
|
PATCH /billing/pay-day
DELETE /credit-cards/{creditCard}
POST /invoice-refund-requests/{invoiceRefundRequest}/actions/confirm
POST /payments/{payment}/actions/pay
POST /subscriptions/{subscription}/actions/refund
|
|
order:write
|
Places orders, resizes and cancels subscriptions. Ordering and resizing spend money — they are carried out with no further confirmation, and a bill left owing is paid on the Billing page or with billing:write. Grant it only to a client you trust with your money. |
shop: manage
|
POST /orders
POST /subscriptions/{subscription}/actions/cancel
POST /subscriptions/{subscription}/actions/cancel-resize
POST /subscriptions/{subscription}/actions/resize
|
|
account:read
|
Read your own profile, contact details and the abilities of the token being used. |
account: view
|
GET /account/billing-information
GET /activity-log
GET /me
GET /me/settings
|
|
account:write
|
Change your own profile, your notification settings and the account's billing information. |
account: manage
|
PATCH /account/billing-information
PATCH /me
PATCH /me/settings
|
|
tickets:read
|
Read your support tickets and the replies on them. |
tickets: view
|
GET /tickets
GET /tickets/{ticket}
|
|
tickets:write
|
Open support tickets, reply to them and close them — each is sent to our support staff in your name. |
tickets: manage
|
POST /tickets
POST /tickets/{ticket}/actions/close
POST /tickets/{ticket}/comments
|
|
ai:read
|
Read your AI gateway keys, the limits our staff set on them and what they have spent. |
ai: view
|
GET /ai/keys
GET /ai/usage
|
|
ai:write
|
Create an AI gateway key, whose secret is shown once, and revoke one. The limits on the keys are set by our staff and cannot be changed here. |
ai: manage
|
POST /ai/keys
DELETE /ai/keys/{aiKey}
|
|
admin:read
admin
|
Read any customer's account, their machines, DNS zones, subscriptions and the audit records. Also requires the admin role — a token never grants authority its owner lacks. |
—
|
GET /admin/accounts
GET /admin/accounts/{accountId}
GET /admin/ai-conversations
GET /admin/ai-conversations/public/{sessionId}
GET /admin/ai-conversations/{conversationId}
GET /admin/ai-gateway/models
GET /admin/ai/prompts
GET /admin/audit-logs
GET /admin/audit-logs/search
GET /admin/audit-logs/{auditLog}
GET /admin/blog/front-page
GET /admin/blog/posts
GET /admin/carts
GET /admin/carts/{cart}
GET /admin/catalogue
GET /admin/catalogue/building-blocks
GET /admin/chargebacks
GET /admin/cloud-scans
GET /admin/coupons
GET /admin/coupons/{coupon}
GET /admin/customers
GET /admin/customers/{user}
GET /admin/customers/{user}/account
GET /admin/customers/{user}/dns-zones
GET /admin/customers/{user}/firewall-rules
GET /admin/customers/{user}/instances
GET /admin/customers/{user}/isos
GET /admin/customers/{user}/isos/uploads/{upload}
GET /admin/customers/{user}/snapshots
GET /admin/customers/{user}/subscriptions
GET /admin/dns-records
GET /admin/dns-zones
GET /admin/domain-prices
GET /admin/dunning-preview
GET /admin/exchange-rates
GET /admin/failed-jobs
GET /admin/failed-jobs/{failedJob}
GET /admin/failed-payments
GET /admin/faqs
GET /admin/faqs/{faq}
GET /admin/health
GET /admin/horizon
GET /admin/instances
GET /admin/instances/{instance}
GET /admin/invitations
GET /admin/invoice-cancellations
GET /admin/invoice-worklist
GET /admin/jobs
GET /admin/join-requests
GET /admin/legal-documents
GET /admin/legal-documents/{legalDocument}
GET /admin/legal-documents/{legalDocument}/compare
GET /admin/legal-documents/{legalDocument}/revisions
GET /admin/networks
GET /admin/news
GET /admin/news/{news}
GET /admin/partner-applications
GET /admin/partner-rebates
GET /admin/partner-setoffs
GET /admin/partner-statements
GET /admin/payments
GET /admin/payments/{payment}
GET /admin/price-notices
GET /admin/privacy-requests
GET /admin/product-prices
GET /admin/public-ip-addresses
GET /admin/referral-rewards
GET /admin/refunds
GET /admin/renewal-preview
GET /admin/retained-resources
GET /admin/roles
GET /admin/screenshots
GET /admin/seller-identity
GET /admin/settings
GET /admin/snapshots
GET /admin/staff-invitations
GET /admin/staged-actions
GET /admin/staged-actions/{stagedAction}
GET /admin/subscriptions
GET /admin/subscriptions/{subscription}
GET /admin/support-assignments
GET /admin/tags
GET /admin/tickets
GET /admin/tickets/{ticket}
GET /admin/usage
GET /admin/volumes
GET /admin/work-queues
|
|
admin:write
admin
|
Start, stop and restart any customer's machine and attach or detach an ISO on it, write news, FAQ and legal drafts, answer and assign tickets, and manage invitations, support assignments and retention holds. Publishing, credit grants, lockouts and every other outward act it asks for are only put into the approval queue, where an administrator decides them in the admin area. Also requires the admin role — a token never grants authority its owner lacks. |
—
|
POST /admin/accounts/{accountId}/ai-limits
POST /admin/accounts/{accountId}/bill-notices
POST /admin/accounts/{accountId}/block
POST /admin/accounts/{accountId}/combine-bills
POST /admin/accounts/{accountId}/default-interest
POST /admin/accounts/{accountId}/members/invite
POST /admin/accounts/{accountId}/members/{member}/capabilities
POST /admin/accounts/{accountId}/members/{member}/remove
POST /admin/accounts/{accountId}/merge
POST /admin/accounts/{accountId}/partner
POST /admin/accounts/{accountId}/partner-bank-details
POST /admin/accounts/{accountId}/partnership-end
POST /admin/accounts/{accountId}/partnership-end/{notice}/outcome
POST /admin/accounts/{accountId}/pay-day
POST /admin/accounts/{accountId}/quotas
POST /admin/ai/prompts
POST /admin/audit-logs/verify
POST /admin/blog/front-page
POST /admin/blog/front-page/arrange
POST /admin/blog/front-page/{cmsPostId}/unfeature
POST /admin/carts/{cart}/clear
POST /admin/carts/{cart}/coupon
POST /admin/carts/{cart}/lines
POST /admin/carts/{cart}/lines/{cartItem}
POST /admin/carts/{cart}/lines/{cartItem}/move
POST /admin/carts/{cart}/lines/{cartItem}/remove
POST /admin/carts/{cart}/partner-code
POST /admin/catalogue/translate
POST /admin/cloud-scans
POST /admin/coupons/{coupon}
POST /admin/coupons/{coupon}/attach
POST /admin/coupons/{coupon}/detach
POST /admin/credit-grants/{creditGrant}/reduce
POST /admin/credit-grants/{creditGrant}/remove
POST /admin/customers
POST /admin/customers/{user}/account/ai-limits
POST /admin/customers/{user}/account/bill-notices
POST /admin/customers/{user}/account/block
POST /admin/customers/{user}/account/default-interest
POST /admin/customers/{user}/account/members/invite
POST /admin/customers/{user}/account/members/{member}/capabilities
POST /admin/customers/{user}/account/members/{member}/remove
POST /admin/customers/{user}/account/merge
POST /admin/customers/{user}/account/partner
POST /admin/customers/{user}/account/partner-bank-details
POST /admin/customers/{user}/account/partnership-end
POST /admin/customers/{user}/account/partnership-end/{notice}/outcome
POST /admin/customers/{user}/account/pay-day
POST /admin/customers/{user}/account/quotas
POST /admin/customers/{user}/billing-info
POST /admin/customers/{user}/delete
POST /admin/customers/{user}/dns-records/{record}
POST /admin/customers/{user}/dns-records/{record}/delete
POST /admin/customers/{user}/dns-zones/{zone}/records
POST /admin/customers/{user}/egress-rules
POST /admin/customers/{user}/egress-rules/{egressRule}/delete
POST /admin/customers/{user}/ingress-rules
POST /admin/customers/{user}/ingress-rules/{ingressRule}
POST /admin/customers/{user}/ingress-rules/{ingressRule}/delete
POST /admin/customers/{user}/instances/{instance}/actions/attach-iso
POST /admin/customers/{user}/instances/{instance}/actions/detach-iso
POST /admin/customers/{user}/instances/{instance}/actions/restart
POST /admin/customers/{user}/instances/{instance}/actions/start
POST /admin/customers/{user}/instances/{instance}/actions/stop
POST /admin/customers/{user}/instances/{instance}/rename
POST /admin/customers/{user}/isos/uploads
POST /admin/customers/{user}/isos/uploads/{upload}/abort
POST /admin/customers/{user}/isos/uploads/{upload}/chunks
POST /admin/customers/{user}/isos/uploads/{upload}/complete
POST /admin/customers/{user}/notifications
POST /admin/customers/{user}/password-reset
POST /admin/customers/{user}/profile
POST /admin/customers/{user}/public-ip-addresses/{address}/reverse-dns
POST /admin/customers/{user}/retention/purge
POST /admin/customers/{user}/snapshots/{snapshot}/delete
POST /admin/customers/{user}/snapshots/{snapshot}/restore
POST /admin/customers/{user}/tickets
POST /admin/customers/{user}/volumes/{volume}/attach
POST /admin/customers/{user}/volumes/{volume}/detach
POST /admin/customers/{user}/volumes/{volume}/snapshots
POST /admin/domain-prices
POST /admin/exchange-rates/refresh
POST /admin/invoice-cancellations/{invoiceCancellation}/confirm
POST /admin/invoice-cancellations/{invoiceCancellation}/decline
POST /admin/invoice-cancellations/{invoiceCancellation}/resolve
POST /admin/invoice-cancellations/{invoiceCancellation}/retry
POST /admin/news
POST /admin/news/{news}
POST /admin/news/{news}/publish
POST /admin/news/{news}/schedule
POST /admin/news/{news}/unschedule
POST /admin/partner-rebates/{partnerRebate}/document
POST /admin/partner-setoffs/{setoff}/return-request
POST /admin/partner-setoffs/{setoff}/write-off
POST /admin/partners/{partner}/reapplication
POST /admin/partners/{partner}/statements
POST /admin/payments/{payment}/chargebacks
POST /admin/payments/{payment}/default-interest/restore
POST /admin/payments/{payment}/default-interest/waive
POST /admin/payments/{payment}/invoice
POST /admin/payments/{payment}/reminder
POST /admin/referrals/{referral}/refusal
POST /admin/refunds/{refund}/retry
POST /admin/refunds/{refund}/settle
POST /admin/retention/networks/{network}/purge
POST /admin/retention/{retainedResource}/reinstate
POST /admin/roles
POST /admin/roles/assignments
POST /admin/roles/{role}
POST /admin/roles/{role}/delete
POST /admin/screenshots/{screenshot}
POST /admin/screenshots/{screenshot}/delete
POST /admin/screenshots/{screenshot}/publish
POST /admin/seller-identity
POST /admin/settings
POST /admin/staff-invitations
POST /admin/staff-invitations/{invitation}/resend
POST /admin/staff-invitations/{invitation}/revoke
POST /admin/subscriptions/{subscription}/agreed-price
POST /admin/subscriptions/{subscription}/agreed-price/release
POST /admin/tags
POST /admin/tags/{tag}
POST /admin/tags/{tag}/delete
POST /admin/tickets/{ticket}/assignment
POST /admin/tickets/{ticket}/close
POST /admin/tickets/{ticket}/comments
POST /admin/tickets/{ticket}/priority
POST /admin/tickets/{ticket}/unassign
POST /admin/token-revocation/break-glass
|
|
support:read
support
|
Read the accounts, resources and audit records of the customers assigned to you. Also requires the support role, and passes the same per-assignment checks as the support area. |
—
|
GET /support/customers
GET /support/customers/{user}
GET /support/customers/{user}/audit-logs
GET /support/customers/{user}/dns-zones
GET /support/customers/{user}/instances
GET /support/customers/{user}/subscriptions
GET /support/customers/{user}/subscriptions/{subscription}/resize-quote
GET /support/staged-actions/{stagedAction}
|
|
support:write
support
|
Act on the customers assigned to you as the support area does — their machines, networks, VPN, snapshots, DNS, tickets, profile, billing information and members, and the billing acts support may take — each only where your assignment lets you manage. Account credit is only asked for: an administrator approves it. Also requires the support role. |
—
|
POST /support/customers/{user}/billing-information
POST /support/customers/{user}/billing/bill-notices
POST /support/customers/{user}/billing/pay-day
POST /support/customers/{user}/billing/refunds-block
POST /support/customers/{user}/billing/shop-block
POST /support/customers/{user}/credits
POST /support/customers/{user}/credits/{creditGrant}/actions/adjust
POST /support/customers/{user}/credits/{creditGrant}/actions/remove
POST /support/customers/{user}/dns-zones
POST /support/customers/{user}/dns-zones/{zone}/actions/delete
POST /support/customers/{user}/dns-zones/{zone}/records
POST /support/customers/{user}/dns-zones/{zone}/records/{record}
POST /support/customers/{user}/dns-zones/{zone}/records/{record}/actions/delete
POST /support/customers/{user}/instances/{instance}/actions/rename
POST /support/customers/{user}/instances/{instance}/actions/restart
POST /support/customers/{user}/instances/{instance}/actions/start
POST /support/customers/{user}/instances/{instance}/actions/stop
GET /support/customers/{user}/instances/{instance}/console
POST /support/customers/{user}/instances/{instance}/networks/{network}/actions/attach
POST /support/customers/{user}/instances/{instance}/networks/{network}/actions/change-ip
POST /support/customers/{user}/instances/{instance}/networks/{network}/actions/detach
POST /support/customers/{user}/instances/{instance}/networks/{network}/actions/make-primary
POST /support/customers/{user}/instances/{instance}/networks/{network}/actions/move
POST /support/customers/{user}/instances/{instance}/vm-snapshots
POST /support/customers/{user}/instances/{instance}/vm-snapshots/{vmSnapshot}/actions/delete
POST /support/customers/{user}/instances/{instance}/vm-snapshots/{vmSnapshot}/actions/revert
POST /support/customers/{user}/invoice-refund-requests/{invoiceRefundRequest}/actions/confirm
POST /support/customers/{user}/invoice-refund-requests/{invoiceRefundRequest}/actions/decline
POST /support/customers/{user}/invoice-refund-requests/{invoiceRefundRequest}/actions/resolve
POST /support/customers/{user}/invoice-refund-requests/{invoiceRefundRequest}/actions/retry
POST /support/customers/{user}/members/{member}
POST /support/customers/{user}/members/{member}/actions/remove
POST /support/customers/{user}/networks/{network}/actions/release
POST /support/customers/{user}/password
POST /support/customers/{user}/payments/{payment}/chargebacks
POST /support/customers/{user}/profile
POST /support/customers/{user}/public-ip-addresses/{publicIPAddress}/networks/{network}/actions/move
POST /support/customers/{user}/social-accounts/{socialAccount}/actions/unlink
POST /support/customers/{user}/subscriptions/{subscription}/actions/cancel
POST /support/customers/{user}/subscriptions/{subscription}/actions/force-refund
POST /support/customers/{user}/subscriptions/{subscription}/actions/lift-suspension
POST /support/customers/{user}/subscriptions/{subscription}/actions/lock
POST /support/customers/{user}/subscriptions/{subscription}/actions/request-invoice-cancellation
POST /support/customers/{user}/subscriptions/{subscription}/actions/unlock
POST /support/customers/{user}/subscriptions/{subscription}/actions/unstage-resize
POST /support/customers/{user}/tickets/{ticket}/actions/close
POST /support/customers/{user}/tickets/{ticket}/comments
POST /support/customers/{user}/volumes/{volume}/snapshot-policies
POST /support/customers/{user}/volumes/{volume}/snapshots
POST /support/customers/{user}/volumes/{volume}/snapshots/{snapshot}/actions/delete
POST /support/customers/{user}/volumes/{volume}/snapshots/{snapshot}/actions/restore
POST /support/customers/{user}/vpn
POST /support/customers/{user}/vpn/users
POST /support/customers/{user}/vpn/users/{vpnUser}/actions/delete
|