Reference
API reference
175 operations in 16 areas. Every route is the console's own, with the same rules: roles, prices, approvals and the payment gate.
JSON in and out over HTTPS. Send a CLI session's access token as Authorization: Bearer (Authentication); errors are { "error", "message" } with a stable code (Errors and references). Each operation says the scope it needs, its fields as the API checks them, the codes it refuses with, and the same call with the CLI where there is one.
curl https://api.rykloud.com/v1/me/organisations \
-H "Authorization: Bearer $RYKLOUD_TOKEN"Areas
CLI sessions
6 operations
- GETThe session making this request and who it is
- DELSign out: revoke the session making this request
- GETThe person's signed-in CLI sessions
- POSTRevoke one of the person's CLI sessions
- POSTExchange a Rykon account ID token (client rykloud-cli) for a CLI session
- POSTA refresh token for a new pair (the refresh token is spent)
Organisations, people and invitations
37 operations
- GETOrganisations the person belongs to
- GETAn organisation, its people and invitations
- PATCHRename an organisation (owner)
- GETWhat the organisation has set up and the next step, from real state
- PUTWhat the organisation wants to set up (owner or admin), or hide the checklist
- GETHow the organisation's products are connected to each other: every link, its state, who allowed it and what it allows
Projects and access
9 operations
- GETProjects of an organisation
- POSTCreate a project
- GETA project and its environments
- PATCHRename or describe a project, or require approval in production
- DELDelete an empty project
- GETWho may do what in a project
Environments
25 operations
- GETClouds, regions, sizes and products on offer
- GETWhat this organisation may ask for, with prices
- POSTThe price of a size and place before asking
- GETEnvironments of an organisation
- POSTAsk for an environment: it is planned and priced, then waits for an owner
- GETAn environment, its plan, timeline and activity
Environment settings: networking, backups, schedules
15 operations
- GETNetworking, backups, scaling and schedule
- POSTPreview a settings change with its price
- POSTApply a previewed settings change
- POSTWithdraw a previewed settings change
- POSTAsk for a private link to another environment
- POSTAccept a private link
Resources and changes
11 operations
- GETAn environment's resources (the canvas)
- GETA resource with its status, settings and backups
- GETA resource's logs
- POSTBack up a database now
- POSTReveal a database's connection details (audited)
- GETChanges in an environment and their state
Services: builds and deploys
9 operations
- GETA service's builds
- POSTBuild a service from its branch head or a commit
- GETA build
- GETA build's log lines after a sequence number
- POSTCancel a build
- GETA service's deploys
Secret groups and variables
6 operations
Custom domains
4 operations
Global views
9 operations
- GETDatabases across projects and environments
- GETServices across projects and environments
- GETBuckets across projects and environments
- GETSecret groups across projects and environments
- GETCustom domains across projects and environments
- POSTBack up several databases
Activity and notifications
6 operations
Prices and billing
5 operations
Git connections
4 operations
Terms of service
1 operations
The cloud terminal
8 operations
- GETTerminal sessions: the person's own, or every one for owners and admins
- DELEnd a terminal session
- GETCloud shell hours this month, per person
- GETThe organisation's terminal settings
- PUTSet the idle timeout, the longest session and recording (owners and admins)
- GETA production environment's shell approvals
Agents and agent keys
20 operations
- GETThe organisation's agents and their keys: who each acts for, scope, expiry, last use
- POSTRevoke an agent and every key it holds
- POSTRevoke one agent key
- PATCHShorten a key's expiry, lower its spend cap or set its IP allow-list
- GETOne key's record: what its requests did, and its use per day
- GETAgent keys that act for the person, across organisations