Skip to content
Coritan Docs

Coritan API

Automate what the dashboard does with the Coritan REST API, and find its base URL, credentials, formats and full reference.

View as Markdown

The Coritan API lets a script or an agent do what you do in the dashboard: order and manage services, pay invoices, edit DNS records and write to support. It is a REST API over HTTPS that takes and returns JSON, and the dashboard is built on the same endpoints.

Every request goes to one base URL:

Text
https://api.coritan.com/api/v1

The two APIs

Section titled The two APIs
Client API
Your own account: services, billing, DNS, support and everything else the dashboard shows you. Its paths start with /api/v1, such as /api/v1/services/, and it takes the access token you get by signing in.
Organization API
An organization that sells Coritan services under its own brand. Its members manage it with their own access token, and its storefront and its customers use it too. Its paths start with /api/v1/orgs/{org_slug}, where {org_slug} is the organization's short name.

Authentication lists which credential each part of either API accepts.

Make a first request

Section titled Make a first request

Sign in with POST /auth/login to get an access token, as Make your first API request shows step by step. Put the token in CORITAN_TOKEN, then read your account:

Shell
curl https://api.coritan.com/api/v1/auth/me \
  -H "Authorization: Bearer $CORITAN_TOKEN"
JSON
{
  "id": 4821,
  "email": "alex@example.com",
  "first_name": "Alex",
  "last_name": "Morgan",
  "status": "active",
  "credit_balance": 25.0,
  "currency": "USD"
}

A request without a valid token answers 401 or 403 with a detail that says why (Errors).

How the API behaves

Section titled How the API behaves
  • Authentication: access and refresh tokens, how long they last, and the keys some parts of the Organization API take.
  • Errors: the status codes and the shapes of detail.
  • Rate limits: how many requests you can send, and what to do with a 429.
  • Pagination and filtering: how lists are paged and filtered.
  • Idempotent requests: the Idempotency-Key header, so a retried payment or order happens once.

Reference

Section titled Reference

The API reference lists every operation with its parameters, request body and responses, generated from the API itself:

Each API also has an interactive reference, where you can send requests from the browser: the Client API and the Organization API.

Read these docs as text

Section titled Read these docs as text

Every page of these docs is also plain Markdown, for a script or an AI agent to read:

What Where
One page as Markdown Add index.md to the page's address, such as /docs/api/rate-limits/index.md
A list of every page /docs/llms.txt
Every guide in one file /docs/llms-full.txt
The API guides and the whole reference in one file /docs/api/llms-full.txt
A search https://www.coritan.com/docs/search.json?q=backups answers with up to 12 results, each with its title, url, section and a snippet

Billing and availability

Section titled Billing and availability

The API is free to use. You pay for the services you order through it, exactly as in the dashboard (Billing). The API is open to every account, and an organization's API is open to its members.