Organization API: Org Cloud Compute

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

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

GET /api/v1/orgs/{org_slug}/vps

The organization's instances, newest first; terminated ones are left out.

Each row carries ipv6_address (the address the guest holds in its IPv6 /64) and ipv6_prefix, both null until the instance has IPv6. The search, location and power filters run in the query, before the page is cut. Each row's power_state is the one the platform recorded at its last start, stop, restart, suspension or rebuild: nothing reads it back from the hosts on a schedule, so a guest shut down from inside still says running until /vps/{uuid}/status asks its host.

Without with_total the answer is the bare list it always was. With it, total is counted from the clause the page is cut from; counts has all and each power state for the search and the location, locations ([{location, count}]) each place for the search and the power state, and totals the whole fleet's instances, running, cpu_cores, memory_mb and disk_gb, whatever the filters.

GET /api/v1/orgs/{org_slug}/vps/templates

Templates offered and ready on at least one active host.

ready_nodes counts those hosts across the fleet. Pass uuid to learn which templates a rebuild of that instance accepts.

GET /api/v1/orgs/{org_slug}/vps/{uuid}

GET /api/v1/orgs/{org_slug}/vps/{uuid}/backups

POST /api/v1/orgs/{org_slug}/vps/{uuid}/backups

application/json

DELETE /api/v1/orgs/{org_slug}/vps/{uuid}/backups/{backup_id}

POST /api/v1/orgs/{org_slug}/vps/{uuid}/backups/{backup_id}/restore

GET /api/v1/orgs/{org_slug}/vps/{uuid}/bandwidth

POST /api/v1/orgs/{org_slug}/vps/{uuid}/cloud-init/regenerate

GET /api/v1/orgs/{org_slug}/vps/{uuid}/config

GET /api/v1/orgs/{org_slug}/vps/{uuid}/console

A display console session with keyboard control, for the owner and org admins.

The organization's audit log records who opened each session before the session is handed out. The answer carries the fields of GET /api/v1/client/vps/{uuid}/console: display reads serial or pending until the instance is restarted once with the reboot power action, and vga once the console shows its screen.

GET /api/v1/orgs/{org_slug}/vps/{uuid}/graphs

GET /api/v1/orgs/{org_slug}/vps/{uuid}/guest

PATCH /api/v1/orgs/{org_slug}/vps/{uuid}/hostname

application/json (required)

GET /api/v1/orgs/{org_slug}/vps/{uuid}/ips

POST /api/v1/orgs/{org_slug}/vps/{uuid}/power

application/json (required)

POST /api/v1/orgs/{org_slug}/vps/{uuid}/rebuild

application/json (required)

POST /api/v1/orgs/{org_slug}/vps/{uuid}/rescue/enter

application/json (required)

POST /api/v1/orgs/{org_slug}/vps/{uuid}/rescue/exit

GET /api/v1/orgs/{org_slug}/vps/{uuid}/rescue/media

POST /api/v1/orgs/{org_slug}/vps/{uuid}/reset-password

GET /api/v1/orgs/{org_slug}/vps/{uuid}/snapshots

POST /api/v1/orgs/{org_slug}/vps/{uuid}/snapshots

application/json (required)

DELETE /api/v1/orgs/{org_slug}/vps/{uuid}/snapshots/{snapshot_id}

POST /api/v1/orgs/{org_slug}/vps/{uuid}/snapshots/{snapshot_id}/rollback

GET /api/v1/orgs/{org_slug}/vps/{uuid}/ssh-keys

The public keys on the instance, so a PUT can start from them: the PUT replaces them all.

PUT /api/v1/orgs/{org_slug}/vps/{uuid}/ssh-keys

application/json (required)

GET /api/v1/orgs/{org_slug}/vps/{uuid}/status