{"openapi":"3.1.0","info":{"title":"Rykloud API","version":"2026-11-05","description":"The public Rykloud API (ADR 0005). Every route is the console's own, with the same rules. AI agents: start at https://rykloud.com/agent-signup.md."},"servers":[{"url":"https://api.rykloud.com"}],"tags":[{"name":"session","description":"CLI sessions"},{"name":"organisations","description":"Organisations, people and invitations"},{"name":"projects","description":"Projects and access"},{"name":"environments","description":"Environments"},{"name":"settings","description":"Environment settings: networking, backups, schedules"},{"name":"resources","description":"Resources and changes"},{"name":"services","description":"Services: builds and deploys"},{"name":"secrets","description":"Secret groups and variables"},{"name":"domains","description":"Custom domains"},{"name":"views","description":"Global views"},{"name":"activity","description":"Activity and notifications"},{"name":"pricing","description":"Prices and billing"},{"name":"git","description":"Git connections"},{"name":"terms","description":"Terms of service"},{"name":"terminal","description":"The cloud terminal"},{"name":"agents","description":"Agents and agent keys"}],"paths":{"/v1/cli/sessions/current":{"get":{"operationId":"session.current","summary":"The session making this request and who it is","tags":["session"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud auth status","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"session.signOut","summary":"Sign out: revoke the session making this request","tags":["session"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud auth logout","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/cli-sessions":{"get":{"operationId":"session.list","summary":"The person's signed-in CLI sessions","tags":["session"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud auth sessions","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/cli-sessions/{sid}/revoke":{"post":{"operationId":"session.revoke","summary":"Revoke one of the person's CLI sessions","tags":["session"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"sid","in":"path","required":true,"description":"sid","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud auth revoke","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/organisations":{"get":{"operationId":"organisations.list","summary":"Organisations the person belongs to","tags":["organisations"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[],"x-rykloud-agent":"sandbox","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs list","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}":{"get":{"operationId":"organisations.get","summary":"An organisation, its people and invitations","tags":["organisations"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"sandbox","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs get","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"organisations.rename","summary":"Rename an organisation (owner)","tags":["organisations"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs rename","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/checklist":{"get":{"operationId":"organisations.checklist","summary":"What the organisation has set up and the next step, from real state","tags":["organisations"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"sandbox","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/onboarding":{"put":{"operationId":"organisations.onboarding","summary":"What the organisation wants to set up (owner or admin), or hide the checklist","tags":["organisations"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/connections":{"get":{"operationId":"organisations.connections","summary":"How the organisation's products are connected to each other: every link, its state, who allowed it and what it allows","tags":["organisations"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"sandbox","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/nudges/{nudge}":{"put":{"operationId":"organisations.dismissNudge","summary":"Dismiss a suggestion to connect two products, for yourself","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"nudge","in":"path","required":true,"description":"nudge","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"organisations.restoreNudge","summary":"Bring a dismissed suggestion back","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"nudge","in":"path","required":true,"description":"nudge","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/also-products/{product}":{"put":{"operationId":"organisations.alsoProduct","summary":"Add a product made by Rykon outside Rykloud (Swift Paybooks) to the organisation's home and menu, or hide it (owner or admin)","tags":["organisations"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"product","in":"path","required":true,"description":"product","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/members/{memberId}":{"delete":{"operationId":"organisations.removeMember","summary":"Remove a person from the organisation","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"memberId","in":"path","required":true,"description":"memberId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs members remove","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"organisations.setRole","summary":"Change a person's role (admin, member, billing)","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"memberId","in":"path","required":true,"description":"memberId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs members role","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/invitations":{"post":{"operationId":"organisations.invite","summary":"Invite a person by address","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs invite","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/invitations/{invitationId}":{"delete":{"operationId":"organisations.revokeInvitation","summary":"Withdraw an invitation","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"invitationId","in":"path","required":true,"description":"invitationId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/invitations":{"get":{"operationId":"invitations.mine","summary":"Invitations waiting for the person","tags":["organisations"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs invitations","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/invitations/{id}/accept":{"post":{"operationId":"invitations.accept","summary":"Accept an invitation","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs accept","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations":{"post":{"operationId":"organisations.create","summary":"Create an organisation; you are its owner","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs create","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/leave":{"post":{"operationId":"organisations.leave","summary":"Leave the organisation (never its last owner)","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs leave","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/invitations/{invitationId}/resend":{"post":{"operationId":"organisations.resendInvitation","summary":"Send an invitation again, with a new expiry","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"invitationId","in":"path","required":true,"description":"invitationId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs invitations resend","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/transfers":{"post":{"operationId":"organisations.offerOwnership","summary":"Offer ownership to a person in the organisation (owner); it changes when they accept","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs transfer","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/transfers/{transferId}":{"delete":{"operationId":"organisations.cancelOwnershipOffer","summary":"Withdraw an ownership offer (owner)","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"transferId","in":"path","required":true,"description":"transferId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs transfer cancel","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/transfers":{"get":{"operationId":"organisations.ownershipOffers","summary":"Ownership offers waiting for the person","tags":["organisations"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs transfers","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/transfers/{id}/accept":{"post":{"operationId":"organisations.acceptOwnership","summary":"Accept an ownership offer","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs transfer accept","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/transfers/{id}/decline":{"post":{"operationId":"organisations.declineOwnership","summary":"Decline an ownership offer","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs transfer decline","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/closure":{"get":{"operationId":"organisations.closurePreview","summary":"What deleting the organisation would do, and what stands in the way (owner)","tags":["organisations"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs delete --preview","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"organisations.requestClosure","summary":"Delete the organisation after the grace period, confirmed by its name (owner)","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs delete","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"organisations.cancelClosure","summary":"Cancel a deletion during the grace period (owner)","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs delete --cancel","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/closed-organisations":{"get":{"operationId":"organisations.closed","summary":"Deleted organisations the person owned (their audit record stays exportable)","tags":["organisations"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs closed","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/audit":{"get":{"operationId":"organisations.audit","summary":"The organisation's audit record, JSON pages or CSV (owners, and owners at the close)","tags":["organisations"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs audit","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/product-transfers":{"post":{"operationId":"organisations.transferProduct","summary":"Offer one of the organisation's product accounts to a confirmed address (owner)","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs transfer-product","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"operationId":"organisations.productTransfers","summary":"The organisation's product transfers, both directions (owners and admins)","tags":["organisations"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs product-transfers --org","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/product-transfers":{"get":{"operationId":"productTransfers.mine","summary":"Product transfers offered to the person, and those they made","tags":["organisations"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs product-transfers","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/product-transfers/{id}":{"get":{"operationId":"productTransfers.get","summary":"One product transfer (either side's owners and admins, the recipient)","tags":["organisations"],"security":[{"cliSession":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs product-transfers show","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/product-transfers/{id}/accept":{"post":{"operationId":"productTransfers.accept","summary":"Accept a product transfer into an organisation you own, or a new one","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs product-transfers accept","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/product-transfers/{id}/decline":{"post":{"operationId":"productTransfers.decline","summary":"Decline a product transfer offered to you","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs product-transfers decline","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/product-transfers/{id}/withdraw":{"post":{"operationId":"productTransfers.withdraw","summary":"Withdraw a product transfer before it moves (owner of the source)","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud orgs product-transfers withdraw","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects":{"get":{"operationId":"projects.list","summary":"Projects of an organisation","tags":["projects"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud projects list","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"projects.create","summary":"Create a project","tags":["projects"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud projects create","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}":{"get":{"operationId":"projects.get","summary":"A project and its environments","tags":["projects"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud projects get","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"projects.update","summary":"Rename or describe a project, or require approval in production","tags":["projects"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"projects.delete","summary":"Delete an empty project","tags":["projects"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud projects delete","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}/access":{"get":{"operationId":"projects.access","summary":"Who may do what in a project","tags":["projects"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}/access/{subject}":{"put":{"operationId":"projects.grant","summary":"Give a member a role in a project","tags":["projects"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}},{"name":"subject","in":"path","required":true,"description":"subject","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"projects.revoke","summary":"Take back a project role","tags":["projects"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}},{"name":"subject","in":"path","required":true,"description":"subject","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}/transfer":{"post":{"operationId":"projects.transfer","summary":"Offer a project, with its environments, to another organisation (owner)","tags":["projects"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud projects transfer","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/environments/catalogue":{"get":{"operationId":"environments.catalogue","summary":"Clouds, regions, sizes and products on offer","tags":["environments"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[],"x-rykloud-agent":"sandbox","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/options":{"get":{"operationId":"environments.options","summary":"What this organisation may ask for, with prices","tags":["environments"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs options","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/quote":{"post":{"operationId":"environments.quote","summary":"The price of a size and place before asking","tags":["environments"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments":{"get":{"operationId":"environments.list","summary":"Environments of an organisation","tags":["environments"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs list","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"environments.create","summary":"Ask for an environment: it is planned and priced, then waits for an owner","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs create","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}":{"get":{"operationId":"environments.get","summary":"An environment, its plan, timeline and activity","tags":["environments"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs get","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"environments.move","summary":"Move an environment to another project or stage","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/approve":{"post":{"operationId":"environments.approve","summary":"Approve the plan at its stated price (owner)","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"money","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs approve","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/cancel":{"post":{"operationId":"environments.cancel","summary":"Cancel an environment that has not started","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs cancel","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/stop":{"post":{"operationId":"environments.stop","summary":"Stop and keep its data; nothing runs or bills at the cloud","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs stop","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/restore":{"post":{"operationId":"environments.restore","summary":"Start a stopped environment from its kept data","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs restore","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/retry":{"post":{"operationId":"environments.retry","summary":"Try a failed step again","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs retry","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/destroy":{"post":{"operationId":"environments.destroy","summary":"Destroy an environment and everything in it","tags":["environments"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs destroy","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/drift/reconcile":{"post":{"operationId":"environments.reconcile","summary":"Put back what changed outside Rykloud","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/drift/keep":{"post":{"operationId":"environments.keepDrift","summary":"Keep what changed outside Rykloud","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/versions":{"get":{"operationId":"environments.versions","summary":"What it runs and what it could run","tags":["environments"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs versions","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/update/review":{"post":{"operationId":"environments.reviewUpdate","summary":"Review an update: planned and priced, then waits for an owner","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs update","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/update/approve":{"post":{"operationId":"environments.approveUpdate","summary":"Approve an update at its stated price (owner)","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"money","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs update --approve","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/update/withdraw":{"post":{"operationId":"environments.withdrawUpdate","summary":"Withdraw an update on its way","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/maintenance":{"post":{"operationId":"environments.maintenance","summary":"Set the maintenance window updates wait for","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/logs":{"get":{"operationId":"environments.logs","summary":"The environment's own workloads' logs","tags":["environments"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs logs","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/access":{"get":{"operationId":"environments.access","summary":"Who may do what in an environment","tags":["environments"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/access/{subject}":{"put":{"operationId":"environments.grant","summary":"Give a member a role in an environment","tags":["environments"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"subject","in":"path","required":true,"description":"subject","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"environments.revoke","summary":"Take back an environment role","tags":["environments"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"subject","in":"path","required":true,"description":"subject","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/settings":{"get":{"operationId":"settings.get","summary":"Networking, backups, scaling and schedule","tags":["settings"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs settings","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/settings/preview":{"post":{"operationId":"settings.preview","summary":"Preview a settings change with its price","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/settings/changes/{changeId}/apply":{"post":{"operationId":"settings.apply","summary":"Apply a previewed settings change","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"changeId","in":"path","required":true,"description":"changeId","schema":{"type":"string"}}],"x-rykloud-agent":"money","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/settings/changes/{changeId}/withdraw":{"post":{"operationId":"settings.withdraw","summary":"Withdraw a previewed settings change","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"changeId","in":"path","required":true,"description":"changeId","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/links":{"post":{"operationId":"settings.linkAsk","summary":"Ask for a private link to another environment","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/links/{linkId}/accept":{"post":{"operationId":"settings.linkAccept","summary":"Accept a private link","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"linkId","in":"path","required":true,"description":"linkId","schema":{"type":"string"}}],"x-rykloud-agent":"money","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/links/{linkId}/remove":{"post":{"operationId":"settings.linkRemove","summary":"Remove a private link","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"linkId","in":"path","required":true,"description":"linkId","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/vpn/keys":{"post":{"operationId":"settings.vpnKey","summary":"Register a WireGuard public key for the person","tags":["settings"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/vpn/keys/{keyId}/revoke":{"post":{"operationId":"settings.vpnRevoke","summary":"Revoke a WireGuard key","tags":["settings"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"keyId","in":"path","required":true,"description":"keyId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/backups/now":{"post":{"operationId":"settings.backupNow","summary":"Back up the environment now","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs backup","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/backups/test":{"post":{"operationId":"settings.backupTest","summary":"Test a restore of the latest backup now","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/backups/{backupId}/restore":{"get":{"operationId":"settings.restorePreview","summary":"What restoring a backup would do","tags":["settings"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"backupId","in":"path","required":true,"description":"backupId","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"settings.restore","summary":"Restore a backup (owner, typing the name)","tags":["settings"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"backupId","in":"path","required":true,"description":"backupId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/schedule":{"put":{"operationId":"settings.schedule","summary":"Set the scheduled stop and start","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"settings.unschedule","summary":"Remove the scheduled stop and start","tags":["settings"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/wake":{"post":{"operationId":"environments.wake","summary":"Wake a stopped environment","tags":["environments"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud envs wake","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources":{"get":{"operationId":"resources.list","summary":"An environment's resources (the canvas)","tags":["resources"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud resources list","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}":{"get":{"operationId":"resources.get","summary":"A resource with its status, settings and backups","tags":["resources"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud resources get","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/logs":{"get":{"operationId":"resources.logs","summary":"A resource's logs","tags":["resources"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud resources logs","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/backup":{"post":{"operationId":"resources.backup","summary":"Back up a database now","tags":["resources"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud resources backup","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/credentials":{"post":{"operationId":"resources.credentials","summary":"Reveal a database's connection details (audited)","tags":["resources"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud resources credentials","x-rykloud-sensitive":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/changes":{"get":{"operationId":"changes.list","summary":"Changes in an environment and their state","tags":["resources"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud changes list","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/changes/preview":{"post":{"operationId":"changes.preview","summary":"Preview a resource change with its price","tags":["resources"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud resources add|update|remove","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/changes/{cid}/apply":{"post":{"operationId":"changes.apply","summary":"Apply a previewed change at its stated price","tags":["resources"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"cid","in":"path","required":true,"description":"The change (or Git connection) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"money","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud changes apply","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/changes/{cid}/approve":{"post":{"operationId":"changes.approve","summary":"Approve a change (owner, or a second maintainer in production)","tags":["resources"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"cid","in":"path","required":true,"description":"The change (or Git connection) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"money","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud changes approve","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/changes/{cid}/reject":{"post":{"operationId":"changes.reject","summary":"Reject a change waiting for approval","tags":["resources"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"cid","in":"path","required":true,"description":"The change (or Git connection) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud changes reject","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/changes/{cid}/withdraw":{"post":{"operationId":"changes.withdraw","summary":"Withdraw a change","tags":["resources"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"cid","in":"path","required":true,"description":"The change (or Git connection) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud changes withdraw","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/builds":{"get":{"operationId":"services.builds","summary":"A service's builds","tags":["services"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud services builds","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"services.build","summary":"Build a service from its branch head or a commit","tags":["services"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud services deploy","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/builds/{bid}":{"get":{"operationId":"services.buildGet","summary":"A build","tags":["services"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}},{"name":"bid","in":"path","required":true,"description":"bid","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/builds/{bid}/logs":{"get":{"operationId":"services.buildLogs","summary":"A build's log lines after a sequence number","tags":["services"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}},{"name":"bid","in":"path","required":true,"description":"bid","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud services build-logs","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/builds/{bid}/cancel":{"post":{"operationId":"services.buildCancel","summary":"Cancel a build","tags":["services"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}},{"name":"bid","in":"path","required":true,"description":"bid","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/deploys":{"get":{"operationId":"services.deploys","summary":"A service's deploys","tags":["services"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud services deploys","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/deploys/{did}/rollback":{"post":{"operationId":"services.rollback","summary":"Preview a rollback to a kept deploy","tags":["services"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}},{"name":"did","in":"path","required":true,"description":"did","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud services rollback","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/source":{"patch":{"operationId":"services.source","summary":"Change a service's branch or automatic deploys","tags":["services"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/restart":{"post":{"operationId":"services.restart","summary":"Restart a service","tags":["services"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud services restart","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/secrets/{name}/reveal":{"post":{"operationId":"secrets.reveal","summary":"Reveal one secret value (audited)","tags":["secrets"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}},{"name":"name","in":"path","required":true,"description":"name","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud secrets reveal","x-rykloud-sensitive":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/resources/{rid}/variables":{"get":{"operationId":"secrets.variables","summary":"A service's variables and where each comes from","tags":["secrets"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"rid","in":"path","required":true,"description":"The resource id (or name, where the route accepts one).","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud services variables","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/secrets/import":{"post":{"operationId":"secrets.import","summary":"Preview importing a .env file into a secret group","tags":["secrets"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud secrets import","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}/secrets":{"get":{"operationId":"secrets.projectList","summary":"A project's secret definitions","tags":["secrets"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}/secrets/{name}":{"put":{"operationId":"secrets.projectSet","summary":"Set a project secret definition","tags":["secrets"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}},{"name":"name","in":"path","required":true,"description":"name","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"secrets.projectDelete","summary":"Delete a project secret definition","tags":["secrets"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}},{"name":"name","in":"path","required":true,"description":"name","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/domains":{"get":{"operationId":"domains.list","summary":"An environment's custom domains","tags":["domains"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud domains list","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"domains.add","summary":"Add a custom domain to a service; answers the TXT record to create","tags":["domains"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud domains add","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/domains/{did}/verify":{"post":{"operationId":"domains.verify","summary":"Check a domain's TXT record now","tags":["domains"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"did","in":"path","required":true,"description":"did","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud domains verify","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/domains/{did}":{"delete":{"operationId":"domains.remove","summary":"Remove a custom domain","tags":["domains"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"did","in":"path","required":true,"description":"did","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud domains remove","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/databases":{"get":{"operationId":"views.databases","summary":"Databases across projects and environments","tags":["views"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud resources list --all --kind postgres","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/applications":{"get":{"operationId":"views.applications","summary":"Services across projects and environments","tags":["views"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud resources list --all --kind service","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/storage":{"get":{"operationId":"views.storage","summary":"Buckets across projects and environments","tags":["views"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/secrets":{"get":{"operationId":"views.secrets","summary":"Secret groups across projects and environments","tags":["views"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/domains":{"get":{"operationId":"views.domains","summary":"Custom domains across projects and environments","tags":["views"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/databases/bulk":{"post":{"operationId":"views.databasesBulk","summary":"Back up several databases","tags":["views"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/storage/bulk":{"post":{"operationId":"views.storageBulk","summary":"Act on several buckets","tags":["views"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/secrets/bulk":{"post":{"operationId":"views.secretsBulk","summary":"Act on several secret groups","tags":["views"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/domains/bulk":{"post":{"operationId":"views.domainsBulk","summary":"Act on several domains","tags":["views"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/activity":{"get":{"operationId":"activity.list","summary":"The organisation's activity (owners and admins all, members their environments')","tags":["activity"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud activity","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/notifications":{"get":{"operationId":"notifications.list","summary":"The person's notifications","tags":["activity"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/notifications/read":{"post":{"operationId":"notifications.read","summary":"Mark notifications read","tags":["activity"],"security":[{"cliSession":["write"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/notification-preferences":{"get":{"operationId":"notifications.preferences","summary":"Notification preferences","tags":["activity"],"security":[{"cliSession":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"notifications.setPreferences","summary":"Set notification preferences","tags":["activity"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/status":{"get":{"operationId":"status.get","summary":"Rykloud's status and incidents","tags":["activity"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[],"x-rykloud-agent":"sandbox","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud status","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/terms":{"get":{"operationId":"terms.current","summary":"The current terms of service and whether the person has accepted them","tags":["terms"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/public/pricing":{"get":{"operationId":"pricing.public","summary":"The public price list","tags":["pricing"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[],"x-rykloud-agent":"sandbox","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/billing":{"get":{"operationId":"billing.get","summary":"The organisation's billing: usage, limits, payment standing","tags":["pricing"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud billing","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/billing/limits":{"put":{"operationId":"billing.limits","summary":"Set spending limits (owner or billing manager)","tags":["pricing"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/team":{"get":{"operationId":"billing.team","summary":"An environment's AI team: seats and mailboxes","tags":["pricing"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"billing.setTeam","summary":"Set an environment's seats and mailboxes, at the stated monthly price","tags":["pricing"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/mail-grants":{"get":{"operationId":"organisations.mailGrants","summary":"The organisation's mail grants: Rykon AI's agent inboxes in Rykon Mail","tags":["organisations"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/mail-grants/{grantId}":{"delete":{"operationId":"organisations.revokeMailGrant","summary":"Revoke a mail grant (owner or admin); its inboxes are paused","tags":["organisations"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"grantId","in":"path","required":true,"description":"grantId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/terminal/sessions":{"get":{"operationId":"terminal.sessions","summary":"Terminal sessions: the person's own, or every one for owners and admins","tags":["terminal"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud terminal sessions","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/terminal/sessions/{sid}":{"delete":{"operationId":"terminal.end","summary":"End a terminal session","tags":["terminal"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"sid","in":"path","required":true,"description":"sid","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud terminal end","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/terminal/usage":{"get":{"operationId":"terminal.usage","summary":"Cloud shell hours this month, per person","tags":["terminal"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/terminal/settings":{"get":{"operationId":"terminal.settings","summary":"The organisation's terminal settings","tags":["terminal"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"terminal.setSettings","summary":"Set the idle timeout, the longest session and recording (owners and admins)","tags":["terminal"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/terminal/approvals":{"get":{"operationId":"terminal.approvals","summary":"A production environment's shell approvals","tags":["terminal"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"terminal.requestApproval","summary":"Ask for production shell access, or break the glass (owners)","tags":["terminal"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud terminal approve","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/environments/{envId}/terminal/approvals/{aid}/{what}":{"post":{"operationId":"terminal.decideApproval","summary":"Approve, decline or withdraw a production shell ask","tags":["terminal"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"envId","in":"path","required":true,"description":"The environment id.","schema":{"type":"string","format":"uuid"}},{"name":"aid","in":"path","required":true,"description":"aid","schema":{"type":"string"}},{"name":"what","in":"path","required":true,"description":"what","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/git/sources":{"get":{"operationId":"git.sources","summary":"Git hosts registered for the organisation","tags":["git"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/git/connections":{"get":{"operationId":"git.connections","summary":"Git connections","tags":["git"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud git connections","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/git/connections/{cid}/repositories":{"get":{"operationId":"git.repositories","summary":"Repositories a connection can read","tags":["git"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"cid","in":"path","required":true,"description":"The change (or Git connection) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","x-rykloud-cli":"rykloud git repos","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/git/connections/{cid}/repositories/{owner}/{repo}/branches":{"get":{"operationId":"git.branches","summary":"A repository's branches","tags":["git"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"cid","in":"path","required":true,"description":"The change (or Git connection) id.","schema":{"type":"string","format":"uuid"}},{"name":"owner","in":"path","required":true,"description":"owner","schema":{"type":"string"}},{"name":"repo","in":"path","required":true,"description":"repo","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/git/connections/{cid}/branches":{"get":{"operationId":"git.branchesByPath","summary":"A repository's branches, the repository as ?repository= (GitLab paths with groups)","tags":["git"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"cid","in":"path","required":true,"description":"The change (or Git connection) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}/previews/setting":{"get":{"operationId":"previews.setting","summary":"The project's preview setting: host, size, database mode, limits, ceiling","tags":["previews"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"previews.setSetting","summary":"Turn previews on or off and set their limits (an owner states the ceiling)","tags":["previews"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}/previews":{"get":{"operationId":"previews.list","summary":"The project's previews: pull request, address, database branch, state","tags":["previews"],"security":[{"cliSession":["read"]},{"agentKey":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"key","x-rykloud-scope":"read","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/projects/{pid}/previews/{prid}/tear-down":{"post":{"operationId":"previews.tearDown","summary":"Tear a preview down now","tags":["previews"],"security":[{"cliSession":["write"]},{"agentKey":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"pid","in":"path","required":true,"description":"The project id.","schema":{"type":"string","format":"uuid"}},{"name":"prid","in":"path","required":true,"description":"prid","schema":{"type":"string"}}],"x-rykloud-agent":"key","x-rykloud-scope":"write","x-rykloud-since":"2026-11-05","x-rykloud-stability":"stable","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/agents":{"get":{"operationId":"agents.list","summary":"The organisation's agents and their keys: who each acts for, scope, expiry, last use","tags":["agents"],"security":[{"cliSession":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}}],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-cli":"rykloud agent list","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/agents/{agentId}/revoke":{"post":{"operationId":"agents.revoke","summary":"Revoke an agent and every key it holds","tags":["agents"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"agentId","in":"path","required":true,"description":"agentId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-cli":"rykloud agent revoke","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/agent-keys/{keyId}/revoke":{"post":{"operationId":"agents.keyRevoke","summary":"Revoke one agent key","tags":["agents"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"keyId","in":"path","required":true,"description":"keyId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-cli":"rykloud agent keys revoke","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/agent-keys/{keyId}":{"patch":{"operationId":"agents.keyUpdate","summary":"Shorten a key's expiry, lower its spend cap or set its IP allow-list","tags":["agents"],"security":[{"cliSession":["write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"keyId","in":"path","required":true,"description":"keyId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organisations/{id}/agent-keys/{keyId}/activity":{"get":{"operationId":"agents.keyActivity","summary":"One key's record: what its requests did, and its use per day","tags":["agents"],"security":[{"cliSession":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organisation (or invitation, or product transfer) id.","schema":{"type":"string","format":"uuid"}},{"name":"keyId","in":"path","required":true,"description":"keyId","schema":{"type":"string"}}],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/agent-keys":{"get":{"operationId":"agents.mine","summary":"Agent keys that act for the person, across organisations","tags":["agents"],"security":[{"cliSession":["read"]}],"parameters":[],"x-rykloud-agent":"person","x-rykloud-scope":"read","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-cli":"rykloud agent keys mine","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/challenges":{"post":{"operationId":"agents.challenge","summary":"A challenge to solve (sign-up) and a proof of work (sign-up and delegation)","tags":["agents"],"security":[],"parameters":[],"x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-step":1,"x-rykloud-cli":"rykloud agent signup","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"additionalProperties":false,"properties":{"purpose":{"enum":["signup","delegation"],"default":"signup"},"model":{"type":"string","description":"Your model, only if you know it for certain (shown to your person as reported)","maxLength":200}}}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/signups":{"post":{"operationId":"agents.signup","summary":"Sign up: the answer, the proof of work, a mailbox you can read and the terms; a code is mailed","tags":["agents"],"security":[],"parameters":[],"x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-step":2,"x-rykloud-cli":"rykloud agent signup","x-rykloud-sensitive":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["challengeId","answer","nonce","email","agent","acceptTerms","termsVersion"],"additionalProperties":false,"properties":{"challengeId":{"type":"string","description":"From the challenge","format":"uuid"},"answer":{"type":"string","description":"Your answer to the problem"},"nonce":{"type":"string","description":"Your proof of work: sha256(prefix + nonce) starts with the asked zero bits","maxLength":64},"email":{"type":"string","description":"A mailbox you (or your person) can read","format":"email"},"agent":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"A name your person will recognise","maxLength":80},"model":{"type":"string","description":"As you know it","maxLength":200},"purpose":{"type":"string","description":"What you will do, in a sentence","maxLength":400}}},"acceptTerms":{"const":true,"description":"You accept the terms, acceptable use policy and privacy policy named in the challenge"},"termsVersion":{"type":"string","description":"terms.version from the challenge"}}}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/signups/{signupId}/resend":{"post":{"operationId":"agents.signupResend","summary":"A new code by mail (three at most, a minute apart)","tags":["agents"],"security":[{"signupSecret":[]}],"parameters":[{"name":"signupId","in":"path","required":true,"description":"signupId","schema":{"type":"string"}}],"x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/signups/{signupId}/verify":{"post":{"operationId":"agents.signupVerify","summary":"The mailed code for your agent, its sandbox organisation, its first key (shown once) and the claim link","tags":["agents"],"security":[{"signupSecret":[]}],"parameters":[{"name":"signupId","in":"path","required":true,"description":"signupId","schema":{"type":"string"}}],"x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-step":3,"x-rykloud-cli":"rykloud agent signup","x-rykloud-sensitive":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"additionalProperties":false,"properties":{"code":{"type":"string","description":"The 8 letter code from the mail","maxLength":20}}}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/delegations":{"post":{"operationId":"agents.delegationStart","summary":"Ask an existing person for a key that acts for them (device code: they approve one screen)","tags":["agents"],"security":[],"parameters":[],"x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-cli":"rykloud agent delegate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["challengeId","nonce","agent"],"additionalProperties":false,"properties":{"challengeId":{"type":"string","description":"From a challenge with purpose delegation","format":"uuid"},"nonce":{"type":"string","description":"Your proof of work","maxLength":64},"agent":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"A name your person will recognise","maxLength":80},"model":{"type":"string","description":"As you know it","maxLength":200}}},"request":{"type":"object","required":[],"additionalProperties":false,"properties":{"scope":{"enum":["read","write"],"default":"read"},"expiresInDays":{"type":"integer","minimum":1,"maximum":90,"default":30},"spendCapUsd":{"type":"number","minimum":0,"default":0,"description":"Monthly price you may approve without asking again; 0 for none"},"ipAllow":{"type":"array","items":{"type":"string"},"description":"Addresses or CIDR ranges the key works from"}}}}}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/delegations/token":{"post":{"operationId":"agents.delegationToken","summary":"Poll for the key: authorization_pending, slow_down, access_denied, expired_token, or the key once","tags":["agents"],"security":[],"parameters":[],"x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-cli":"rykloud agent delegate","x-rykloud-sensitive":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceCode"],"additionalProperties":false,"properties":{"deviceCode":{"type":"string","description":"From the delegation request (rkd_)"}}}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/me":{"get":{"operationId":"agents.me","summary":"Who this key is, who it acts for and what it may do","tags":["agents"],"security":[{"agentKey":["read"]}],"parameters":[],"x-rykloud-scope":"read","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-step":4,"x-rykloud-cli":"rykloud agent whoami","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/me/keys":{"get":{"operationId":"agents.keys","summary":"The agent's keys, with use in the last 30 days","tags":["agents"],"security":[{"agentKey":["read"]}],"parameters":[],"x-rykloud-scope":"read","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-cli":"rykloud agent keys list","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"agents.keyCreate","summary":"Another key (never more than this one may do), shown once","tags":["agents"],"security":[{"agentKey":["write"]}],"parameters":[],"x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-cli":"rykloud agent keys create","x-rykloud-sensitive":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"What it is for","maxLength":80},"scope":{"enum":["read","write"]},"expiresInDays":{"type":"integer","minimum":1,"maximum":90},"ipAllow":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/me/keys/{keyId}/rotate":{"post":{"operationId":"agents.keyRotate","summary":"A new secret; the old one works ten more minutes","tags":["agents"],"security":[{"agentKey":["write"]}],"parameters":[{"name":"keyId","in":"path","required":true,"description":"keyId","schema":{"type":"string"}}],"x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-cli":"rykloud agent keys rotate","x-rykloud-sensitive":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/me/keys/{keyId}/revoke":{"post":{"operationId":"agents.keyRevokeOwn","summary":"Revoke one of the agent's keys","tags":["agents"],"security":[{"agentKey":["write"]}],"parameters":[{"name":"keyId","in":"path","required":true,"description":"keyId","schema":{"type":"string"}}],"x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-cli":"rykloud agent keys revoke","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/me/claim-link":{"post":{"operationId":"agents.claimLink","summary":"A fresh claim link to give your person (the last one stops working)","tags":["agents"],"security":[{"agentKey":["write"]}],"parameters":[],"x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-step":6,"x-rykloud-cli":"rykloud agent claim-link","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/me/sites/templates":{"get":{"operationId":"agents.siteTemplates","summary":"The site template library (with each template's live demo)","tags":["agents"],"security":[{"agentKey":["read"]}],"parameters":[],"x-rykloud-scope":"read","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-cli":"rykloud agent sites templates","responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/me/sites/previews":{"post":{"operationId":"agents.sitePreview","summary":"Compose a site from a template, never made: an hour's preview link","tags":["agents"],"security":[{"agentKey":["write"]}],"parameters":[],"x-rykloud-scope":"write","x-rykloud-since":"2026-11-10","x-rykloud-stability":"beta","x-rykloud-agent":"sandbox","x-rykloud-step":5,"x-rykloud-cli":"rykloud agent sites preview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template"],"additionalProperties":false,"properties":{"template":{"type":"string","description":"A template id from /v1/agents/me/sites/templates","pattern":"^[a-z][a-z0-9-]{0,39}$"},"name":{"type":"string","description":"The business name to draw it with","maxLength":60},"sentence":{"type":"string","description":"What the business does (claimed or delegated agents only: it costs model time)","maxLength":600}}}}}},"responses":{"200":{"description":"Done.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cli/sessions":{"post":{"operationId":"session.create","summary":"Exchange a Rykon account ID token (client rykloud-cli) for a CLI session","tags":["session"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idToken"],"additionalProperties":false,"properties":{"idToken":{"type":"string"},"scope":{"enum":["read","write"],"default":"write"},"device":{"type":"string","maxLength":100}}}}}},"responses":{"201":{"description":"A new session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cli/sessions/refresh":{"post":{"operationId":"session.refresh","summary":"A refresh token for a new pair (the refresh token is spent)","tags":["session"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["refreshToken"],"additionalProperties":false,"properties":{"refreshToken":{"type":"string"}}}}}},"responses":{"200":{"description":"A new pair.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}}},"default":{"description":"An error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"cliSession":{"type":"http","scheme":"bearer","description":"A CLI session access token (rkc_), scope read or write."},"agentKey":{"type":"http","scheme":"bearer","description":"An agent key (rka_), scope read or write (https://rykloud.com/agent-signup.md). x-rykloud-agent says what an agent key may do: sandbox (an unclaimed agent too), key, money (within its spend cap), person (never an agent)."},"signupSecret":{"type":"http","scheme":"bearer","description":"The sign-up secret (rksu_) answered by POST /v1/agents/signups."}},"schemas":{"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"A stable code: not_found, refused, forbidden, unauthorized, session_ended, scope_insufficient, ..."},"message":{"type":"string","description":"What happened, in customer words."},"detail":{"type":"object","additionalProperties":true}}},"Tokens":{"type":"object","required":["session","accessToken","accessExpiresAt","refreshToken","refreshExpiresAt","tokenType"],"properties":{"session":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"scope":{"enum":["read","write"]},"device":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}}},"accessToken":{"type":"string","pattern":"^rkc_"},"accessExpiresAt":{"type":"string","format":"date-time"},"refreshToken":{"type":"string","pattern":"^rkr_"},"refreshExpiresAt":{"type":"string","format":"date-time"},"tokenType":{"const":"Bearer"}}}}}}