{ "openapi": "3.0.3", "info": { "title": "Release.com Platform API", "version": "1.0.0", "description": "The Release.com Platform API provides REST endpoints for managing\nephemeral environments, deployments, builds, clusters, and related\ninfrastructure.\n\n**V1 scope:** Platform endpoints only. AI sandbox endpoints (`/ai/**`)\nare excluded from this version and will be added in a future iteration.\n", "contact": { "name": "Release.com", "url": "https://release.com" }, "x-logo": { "url": "https://api.release.com/release-logo.png", "backgroundColor": "#FFFFFF", "altText": "Release" } }, "externalDocs": { "description": "Release Documentation", "url": "https://docs.release.com" }, "servers": [ { "url": "https://api.release.com", "description": "Production" } ], "security": [ { "userEmail": [], "userToken": [] } ], "components": { "securitySchemes": { "userEmail": { "type": "apiKey", "in": "header", "name": "X-User-Email", "description": "User's email address for authentication" }, "userToken": { "type": "apiKey", "in": "header", "name": "X-User-Token", "description": "User's authentication token (from ~/.release.yaml)" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } }, "Account": { "type": "object", "properties": { "id": { "type": "integer" }, "hashid": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "address": { "type": "string" }, "avatar_url": { "type": "string" }, "onboarded": { "type": "boolean" }, "release_domains": { "type": "array", "items": { "type": "object" } }, "plan": { "type": "string" }, "on_premise_enabled": { "type": "boolean" }, "account_id": { "type": "integer" }, "email": { "type": "string" }, "owner": { "type": "boolean" }, "allow_cluster_add": { "type": "boolean" }, "credit_card_required": { "type": "boolean" }, "payment_valid": { "type": "boolean" }, "datadog_api_key": { "type": "string" }, "datadog_site": { "type": "string" }, "user_count": { "type": "integer" }, "owner_email": { "type": "string" }, "owner_deactivated": { "type": "string" }, "gitops_enabled": { "type": "string" }, "role": { "type": "string" }, "flags": { "type": "string" } } }, "App": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "default_branch": { "type": "string" }, "on_premise": { "type": "boolean" }, "disabled": { "type": "boolean" } } }, "Space": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "permanent": { "type": "boolean" }, "tracking_branch": { "type": "string" }, "tracking_tag": { "type": "string" }, "namespace": { "type": "string" }, "mode": { "type": "string" }, "deployment_strategy": { "type": "string" }, "error_message": { "type": "string" }, "production": { "type": "boolean" }, "dependencies_status": { "type": "string" }, "pool_id": { "type": "string" }, "pool_cluster_id": { "type": "string" }, "pool_name": { "type": "string" }, "current_snapshot_id": { "type": "string" }, "newest_snapshot_id": { "type": "string" }, "aasm_state": { "type": "string" }, "latest_deploy_id": { "type": "integer" }, "env_id": { "type": "string" }, "version": { "type": "string" }, "latest_version": { "type": "string" }, "digest_version": { "type": "string" }, "latest_digest_version": { "type": "string" }, "last_deployed_at": { "type": "string" }, "connected": { "type": "boolean" }, "expires_at": { "type": "string" }, "expires_at_in_seconds": { "type": "integer" }, "pull_request_title": { "type": "string" }, "pull_request_url": { "type": "string" }, "primary_display_url": { "type": "string" }, "enabled": { "type": "string" }, "orphaned_connected_space": { "type": "boolean" } } }, "Build": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "branch": { "type": "string" }, "tag": { "type": "string" }, "aasm_state": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string" }, "started_at": { "type": "string" }, "total_duration": { "type": "number" }, "commit_long": { "type": "string" }, "commit_short": { "type": "string" }, "commit_date": { "type": "string" }, "commit_message": { "type": "string" }, "commit_user": { "type": "string" } } }, "Pipeline": { "type": "object", "properties": { "id": { "type": "integer" }, "aasm_state": { "type": "string" }, "status_reason": { "type": "string" }, "started_at": { "type": "string" }, "total_duration": { "type": "number" }, "error_message": { "type": "string" }, "name": { "type": "string" }, "commit_long": { "type": "string" }, "commit_short": { "type": "string" }, "commit_date": { "type": "string" } } }, "BuildIndex": { "type": "object", "properties": { "total_count": { "type": "integer" }, "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total_pages": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Build" } } } } } }, "paths": { "/configs/validate": { "post": { "tags": [ "Configs" ], "summary": "Validate Config", "operationId": "configs_validate", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/instances/{identifier}": { "get": { "tags": [ "Instances" ], "summary": "Get Instance", "operationId": "instances_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier" } ] } }, "/apps/{id}/clone": { "post": { "tags": [ "Apps" ], "summary": "Clone app", "operationId": "apps_clone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{id}/branches_and_tags": { "get": { "tags": [ "Apps" ], "summary": "List branches and tags", "operationId": "apps_branches_and_tags", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/builds/{id}/log": { "get": { "tags": [ "Builds" ], "summary": "Log Build", "operationId": "builds_log", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/builds/{id}/rebuild": { "post": { "tags": [ "Builds" ], "summary": "Rebuild", "operationId": "builds_rebuild", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/builds/{id}/cancel": { "put": { "tags": [ "Builds" ], "summary": "Cancel build", "operationId": "builds_cancel", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/builds": { "get": { "tags": [ "Builds" ], "summary": "List Builds", "operationId": "builds_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildIndex" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25 }, "description": "Items per page" }, { "name": "branch", "in": "query", "schema": { "type": "string" }, "description": "Filter by branch" }, { "name": "tag", "in": "query", "schema": { "type": "string" }, "description": "Filter by tag" } ] }, "post": { "tags": [ "Builds" ], "summary": "Create Build", "operationId": "builds_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/apps/{app_id}/builds/{id}": { "get": { "tags": [ "Builds" ], "summary": "Get Build", "operationId": "builds_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{space_id}/serialized_configs": { "get": { "tags": [ "Configs" ], "summary": "List Serialized configs", "operationId": "serialized_configs_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ] }, "post": { "tags": [ "Configs" ], "summary": "Create Serialized config", "operationId": "serialized_configs_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/apps/{app_id}/spaces/{space_id}/serialized_configs/{id}": { "get": { "tags": [ "Configs" ], "summary": "Get Serialized config", "operationId": "serialized_configs_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{space_id}/latest_config": { "get": { "tags": [ "Configs" ], "summary": "Get latest app config", "operationId": "serialized_configs_latest_config", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{space_id}/latest_env_config": { "get": { "tags": [ "Configs" ], "summary": "Get latest env config", "operationId": "serialized_configs_latest_env_config", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{id}/extend_expiration": { "put": { "tags": [ "Environments" ], "summary": "Extend environment expiration", "operationId": "spaces_extend_expiration", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Space" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{id}/pause": { "post": { "tags": [ "Environments" ], "summary": "Pause environment", "operationId": "spaces_pause", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Space" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{id}/resume": { "post": { "tags": [ "Environments" ], "summary": "Resume environment", "operationId": "spaces_resume", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Space" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{id}/override_schedule": { "post": { "tags": [ "Environments" ], "summary": "Override environment schedule", "operationId": "spaces_override_schedule", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Space" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{space_id}/pipelines/{id}/abort": { "put": { "tags": [ "Deploys" ], "summary": "Abort deploy", "operationId": "pipelines_abort", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{space_id}/pipelines": { "get": { "tags": [ "Deploys" ], "summary": "List Pipelines", "operationId": "pipelines_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ] }, "post": { "tags": [ "Deploys" ], "summary": "Create Pipeline", "operationId": "pipelines_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/apps/{app_id}/spaces/{space_id}/pipelines/{id}": { "get": { "tags": [ "Deploys" ], "summary": "Get Pipeline", "operationId": "pipelines_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{space_id}/instances": { "get": { "tags": [ "Instances" ], "summary": "List Instances", "operationId": "instances_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{space_id}/remote_development/kubeconfig": { "get": { "tags": [ "Remote Development" ], "summary": "Download kubeconfig", "operationId": "remote_developments_kubeconfig", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ] } }, "/apps/{app_id}/spaces/{space_id}/remote_development": { "get": { "tags": [ "Remote Development" ], "summary": "Get Remote development", "operationId": "remote_developments_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ] }, "delete": { "tags": [ "Remote Development" ], "summary": "Delete Remote development", "operationId": "remote_developments_destroy", "responses": { "200": { "description": "Deleted" }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ] }, "post": { "tags": [ "Remote Development" ], "summary": "Create Remote development", "operationId": "remote_developments_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Environment ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/apps/{app_id}/spaces": { "get": { "tags": [ "Environments" ], "summary": "List Spaces", "operationId": "spaces_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Space" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "sort_key", "in": "query", "schema": { "type": "string" }, "description": "Sort field" }, { "name": "sort_order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "Sort direction" } ] }, "post": { "tags": [ "Environments" ], "summary": "Create Space", "operationId": "spaces_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/apps/{app_id}/spaces/{id}": { "get": { "tags": [ "Environments" ], "summary": "Get Space", "operationId": "spaces_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Space" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] }, "delete": { "tags": [ "Environments" ], "summary": "Delete Space", "operationId": "spaces_destroy", "responses": { "200": { "description": "Deleted" }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/check_app_name": { "get": { "tags": [ "Apps" ], "summary": "Check app name App", "operationId": "apps_check_app_name", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/apps/{id}/services": { "get": { "tags": [ "Apps" ], "summary": "List app services", "operationId": "apps_services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/serialized_configs": { "get": { "tags": [ "Configs" ], "summary": "List Serialized configs", "operationId": "serialized_configs_get_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" } ] }, "post": { "tags": [ "Configs" ], "summary": "Create Serialized config", "operationId": "serialized_configs_post_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/apps/{app_id}/serialized_configs/{id}": { "get": { "tags": [ "Configs" ], "summary": "Get Serialized config", "operationId": "serialized_configs_get_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{app_id}/latest_config": { "get": { "tags": [ "Configs" ], "summary": "Get latest app config", "operationId": "serialized_configs_get_latest_config", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" } ] } }, "/apps/{app_id}/latest_env_config": { "get": { "tags": [ "Configs" ], "summary": "Get latest env config", "operationId": "serialized_configs_get_latest_env_config", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" } ] } }, "/apps/{app_id}/pipelines": { "get": { "tags": [ "Deploys" ], "summary": "List Pipelines", "operationId": "pipelines_get_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" } ] } }, "/apps/{app_id}/pipelines/{id}": { "get": { "tags": [ "Deploys" ], "summary": "Get Pipeline", "operationId": "pipelines_get_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "App ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps": { "get": { "tags": [ "Apps" ], "summary": "List Apps", "operationId": "apps_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/App" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [] }, "post": { "tags": [ "Apps" ], "summary": "Create App", "operationId": "apps_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/apps/new": { "get": { "tags": [ "Apps" ], "summary": "New App", "operationId": "apps_new", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/apps/{id}/edit": { "get": { "tags": [ "Apps" ], "summary": "Edit App", "operationId": "apps_edit", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/apps/{id}": { "get": { "tags": [ "Apps" ], "summary": "Get App", "operationId": "apps_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] }, "patch": { "tags": [ "Apps" ], "summary": "Update App", "operationId": "apps_update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } }, "put": { "tags": [ "Apps" ], "summary": "Update App", "operationId": "apps_put_update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Apps" ], "summary": "Delete App", "operationId": "apps_destroy", "responses": { "200": { "description": "Deleted" }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/settings": { "post": { "tags": [ "Accounts" ], "summary": "Create or update Account", "operationId": "settings_accounts_create_or_update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" } ] }, "get": { "tags": [ "Accounts" ], "summary": "List Accounts", "operationId": "settings_accounts_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" } ] } }, "/accounts/{account_id}/settings/delete_all": { "delete": { "tags": [ "Accounts" ], "summary": "Delete all Account", "operationId": "settings_accounts_delete_all", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" } ] } }, "/accounts/validate": { "post": { "tags": [ "Accounts" ], "summary": "Validate Account", "operationId": "accounts_validate", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/accounts/{id}/avatar": { "post": { "tags": [ "Accounts" ], "summary": "Avatar Account", "operationId": "accounts_avatar", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{id}/resources": { "get": { "tags": [ "Accounts" ], "summary": "Resources Account", "operationId": "accounts_resources", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{id}/invite_users": { "put": { "tags": [ "Accounts" ], "summary": "Invite users Account", "operationId": "accounts_invite_users", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters/{id}/kubeconfig": { "get": { "tags": [ "Clusters" ], "summary": "Download kubeconfig", "operationId": "clusters_kubeconfig", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters/{id}/database_snapshots": { "get": { "tags": [ "Clusters" ], "summary": "List database snapshots", "operationId": "clusters_database_snapshots", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters/{id}/verify": { "get": { "tags": [ "Clusters" ], "summary": "Verify cluster", "operationId": "clusters_verify", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters/{id}/certificate": { "post": { "tags": [ "Clusters" ], "summary": "Generate cluster certificate", "operationId": "clusters_certificate", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters/{id}/upgrade": { "post": { "tags": [ "Clusters" ], "summary": "Upgrade cluster", "operationId": "clusters_upgrade", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters/{id}/patch_refresh_node_groups": { "patch": { "tags": [ "Clusters" ], "summary": "Patch refresh node groups Cluster", "operationId": "clusters_patch_refresh_node_groups", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters": { "get": { "tags": [ "Clusters" ], "summary": "List Clusters", "operationId": "clusters_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" } ] }, "post": { "tags": [ "Clusters" ], "summary": "Create Cluster", "operationId": "clusters_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/accounts/{account_id}/clusters/new": { "get": { "tags": [ "Clusters" ], "summary": "New Cluster", "operationId": "clusters_new", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters/{id}/edit": { "get": { "tags": [ "Clusters" ], "summary": "Edit Cluster", "operationId": "clusters_edit", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{account_id}/clusters/{id}": { "get": { "tags": [ "Clusters" ], "summary": "Get Cluster", "operationId": "clusters_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] }, "patch": { "tags": [ "Clusters" ], "summary": "Update Cluster", "operationId": "clusters_update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } }, "put": { "tags": [ "Clusters" ], "summary": "Update Cluster", "operationId": "clusters_put_update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Clusters" ], "summary": "Delete Cluster", "operationId": "clusters_destroy", "responses": { "200": { "description": "Deleted" }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account ID (integer or hashid)" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts": { "get": { "tags": [ "Accounts" ], "summary": "List Accounts", "operationId": "accounts_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [] }, "post": { "tags": [ "Accounts" ], "summary": "Create Account", "operationId": "accounts_create", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/accounts/new": { "get": { "tags": [ "Accounts" ], "summary": "New Account", "operationId": "accounts_new", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/accounts/{id}/edit": { "get": { "tags": [ "Accounts" ], "summary": "Edit Account", "operationId": "accounts_edit", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/accounts/{id}": { "get": { "tags": [ "Accounts" ], "summary": "Get Account", "operationId": "accounts_show", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] }, "patch": { "tags": [ "Accounts" ], "summary": "Update Account", "operationId": "accounts_update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } }, "put": { "tags": [ "Accounts" ], "summary": "Update Account", "operationId": "accounts_put_update", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete Account", "operationId": "accounts_destroy", "responses": { "200": { "description": "Deleted" }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource ID (integer or hashid)" } ] } }, "/": { "get": { "tags": [ "Accounts" ], "summary": "List Accounts", "operationId": "admin_accounts_index", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [] } } } }