Client API reference
Every operation of the Client API, generated from the API: 876 operations in 41 areas.
Every operation of the Client API, by area. Base URL: https://api.coritan.com/api/v1.
To try requests in the browser, open the interactive Client API reference.
| Area | Operations | What it covers |
|---|---|---|
| Authentication | 21 | Register, sign in, refresh tokens and manage your profile, and see or sign out the devices signed in to your account. |
| Authentication MFA | 6 | Two-factor authentication: set up an authenticator app, turn it on or off, make new recovery codes, and send the code that completes a sign in. |
| Account settings | 10 | Change the address you sign in with, choose which optional emails you get, and close your account. |
| Account team | 8 | Invite people to your account, give each a role and remove them. |
| Account plan | 7 | Your account's plan (Free, Pro, Business or Enterprise), its limits and what the account uses, including what Object Storage used of its free amounts this month. |
| Account activity | 1 | The account's activity log: what its owner changed and each request its team members sent for it, newest first. |
| Features | 4 | The dashboard areas this storefront shows, and whether account plans apply to your account. |
| Catalog | 7 | Browse sellable products and plan options. |
| Checkout | 1 | Price an order before you place it: the first invoice's lines, a promo code's discount, what is due now and what renews. |
| Services | 13 | Order and manage provisioned services (lifecycle, actions, cancel, plan changes) and the add-ons on each one. |
| Resource Tags | 5 | User-defined labels on services, Cloud Compute instances, deployment servers, and other resources. |
| Billing | 40 | Invoices and their PDFs, credit balance, top-ups, refund requests and hourly billing controls, and how each deployment is billed: its metered use, its cost this month, pay as you go or a commit, overa |
| Usage and budgets | 12 | What your services used and cost: a month by service and day, hourly rows, credit activity, budgets, billing events and questions about a charge. |
| Payments | 24 | Payment methods, checkout sessions, and available gateways. |
| Promotions | 2 | Check a promo code before you order, and read your referral link, its terms and the accounts that signed up with it. |
| DNS | 41 | Authoritative DNS zones, records, DNSSEC, and per-zone query stats. |
| SSL | 8 | Certificate inventory and issuance, plus HTTP-01 / DNS challenge workflows for domain validation. |
| Domains | 17 | Domain search, registration, renewals, nameservers, and locks. |
| Reverse Proxy | 19 | User-managed reverse-proxy routes (TLS, upstreams, WAF settings). |
| Game Shield | 11 | Join addresses on the platform's join domain: names, branding and custom domains. |
| External Servers | 10 | Put a server you host yourself behind Game Shield: connection, tests and branding. |
| Platform Domains | 5 | Names claimed under the platform's customer suffixes, such as example.coritan.gg. |
| Deployments | 83 | App Deployment: every deployment the account runs, whether it runs software from the catalog (a game server, MariaDB, Redis) or an app built from git, an image or static files. |
| Deployment servers | 157 | The servers of deployments that run software from the catalog, one at a time: power, console, files, SFTP, backups, schedules, databases, startup variables and settings. |
| GitHub | 5 | Connect the Coritan GitHub App so deployments build from private repositories on every push: start an installation, record it, list the installations and the repositories each reaches, and remove one. |
| App Deployment | 4 | The starters a deployment can begin from, and the dashboard link a Deploy button opens for a public repository. |
| Apps | 22 | The Apps API, which App Deployment replaces: every app it made is a deployment, and new integrations use Deployments. |
| Cloud Compute | 37 | Cloud Compute VM instances (power, console, backups, and details). |
| Cloud Compute images | 8 | Your own ISOs and disk images for Cloud Compute: upload in parts, import from an https link, list, rename and delete. |
| Cloud Compute alerts | 4 | Monitoring alerts on an instance: CPU, disk, data transfer this month and down, each emailed when it fires and when it clears. |
| Floating IPs | 12 | Allocate and attach floating IPs to eligible services. |
| Wicket | 10 | Wicket checks that a person is filling in a form. |
| Shield | 9 | Client-facing DDoS scrubber status and attack events for your IPs. |
| Object Storage | 61 | S3-compatible buckets, access keys, objects and usage for Object Storage services. |
| 167 | Mail Hosting (domains, mailboxes, aliases), SMTP Relay (credentials, API keys, webhooks, suppressions, events) and the mail tenants an account owns. | |
| Mail Send API | 4 | Send a message through an SMTP Relay service over HTTPS. |
| Support | 13 | Conversational support chat (threads and messages). |
| Help | 3 | The docs site's guides for a page of the dashboard, and a search over them. |
| Email preferences | 2 | |
| Notices | 2 | |
| Partners | 1 |