Client API: Catalog

Browse sellable products and plan options. Listing is public and needs no auth.

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Client API reference.

GET /api/v1/client/containers/catalog

Browse platform specializations available for deploy composition.

Carries the same icons, colours and grouping as the org storefront's storefront/specializations and the panel's Software tab, so the platform order page does not have to draw a Paper server with a generic terminal glyph. The MCJars lookup is cached and never blocks once warm.

Authentication: an access token, sent as Authorization: Bearer <token>.

A 200 response is a list; each item has these fields:

GET /api/v1/client/containers/catalog/{slug}/compose

Get software versions + recommended runtimes for a specialization.

Authentication: an access token, sent as Authorization: Bearer <token>.

Fields of a 200 response:

GET /api/v1/locations

List the locations you can order a server in, by airport code.

A location is listed once it has servers, even when every one of them is full: GET /locations/availability says which of them can take an order. A network location with no servers, and a location we are still setting up, are left out unless include_pops is true.

A 200 response is a list; each item has these fields:

GET /api/v1/locations/availability

Say which locations can take an order of this size right now.

Lists the same locations as GET /locations: each has servers, and available is false with reason "Sold out for this plan" when none of them has room for the memory and disk asked for. Refuses a module other than vps or container with 400.

A 200 response is a list; each item has these fields:

GET /api/v1/price-book

Every price the cost estimator needs, in one answer. No sign in needed.

It holds the rate card for servers and web services billed by use (the price of memory, CPU, disk, requests and data out, and the amounts every account gets free each month), each size's memory, vCPUs and disk, the account plans with their limits, Object Storage's rates, the SMTP Relay plans, the price of an extra mailbox and the domain price list. Prices are strings in US dollars. Products we no longer sell, the free server plan and the plans a plan includes are left out, as they are from the product list.

The answer is the same for every visitor and is kept for thirty seconds, so a price you change in the admin console reaches the site within a minute.

Fields of a 200 response:

GET /api/v1/products/

List the products you can order, with their prices. No sign in needed.

Each product carries its product group, whether it is the plan we highlight (popular), whether it can be ordered (orderable) and, for a capacity add-on, its addon block. The list leaves out what you cannot order: services a plan includes, products we no longer sell and the free server plan. A plan sold only through our sales team is listed with orderable false. Filter by group, product_group or hardware tier; the list is sorted by position, then name, and paged with page and per_page (at most 200).

What you can order depends on whether the Free, Pro and Business plans apply to you: to your account when the request carries your session, and otherwise to someone who signs up now, as GET /api/v1/features answers. Until they do, the standalone mail plans and the free SMTP relay are listed and orderable, as they were before the plans.

A Cloud Compute plan (RX) or game server plan (CX) other than the free server is billed by the second when you order it, from the memory, vCPUs and disk it holds. Its entry has billing_model usage and a usage block: the price of one hour and of a 730-hour month with the CPU idle (hourly_idle, monthly_idle), at 10% of the vCPUs (hourly_typical, monthly_typical) and with every vCPU busy (hourly_max, monthly_max), and the part of the month that is disk (disk_monthly). Performance plans cost 1.5 times as much for memory, CPU and disk. The flat pricing stays in the entry for brand storefronts and for services that keep their flat terms, and it is not what an order on coritan.com costs. Every other product, and the free server plan, has neither field.

pricing holds the prices a customer can pay now. A price we switched off, such as a billing cycle we stopped selling, is left out.

A 200 response is a list; each item has these fields:

GET /api/v1/products/{product_id}

Get one product by its ID, with its prices. No sign in needed.

This answers for a product the list leaves out too, such as one we no longer sell or one a plan includes, so a customer with a service on it can still read its plan. orderable says whether we would accept a new order for it from you, decided as the list decides it. An unknown ID answers 404. A size billed by the second has billing_model and usage as the list describes. pricing leaves out a price we switched off, as the list does.

Fields of a 200 response: