{ "openapi": "3.0.3", "info": { "title": "SeaGit API", "version": "1.47.0", "description": "Try the SeaGit platform API from your browser.\n\n**Authenticate**\n1. Sign in to SeaGit in this browser.\n2. Get a token — either an **API key** (`sgt_…`, long-lived, create one under *Settings → API keys* at `/settings/api-keys`) or your **Firebase ID token** (expires after about an hour).\n3. Click **Authorize** and paste the token **exactly as-is — do not add a `Bearer ` prefix**. SeaGit reads the raw `Authorization` header value.\n\nRequests are sent to the same origin you are viewing, with your token, and act on **real resources in your account**. There is no sandbox: `DELETE`, `terminate` and `deploy` calls do what they say.\n\n_This reference is generated from the route files. Request/response bodies are free-form JSON; field names shown in examples are the ones the handler reads._" }, "servers": [ { "url": "/api", "description": "This deployment" } ], "tags": [ { "name": "API Keys" }, { "name": "AWS" }, { "name": "Account" }, { "name": "Action Rules" }, { "name": "Applications" }, { "name": "Audit Logs" }, { "name": "Auth" }, { "name": "Billing" }, { "name": "Clusters" }, { "name": "Deployments" }, { "name": "Domains" }, { "name": "Environments" }, { "name": "GitHub" }, { "name": "Groups" }, { "name": "Helm" }, { "name": "Instances" }, { "name": "Members" }, { "name": "Networks" }, { "name": "Org Keys" }, { "name": "Organization" }, { "name": "Policies" }, { "name": "Providers" }, { "name": "Scheduling" }, { "name": "Spaces" }, { "name": "Support Tickets" }, { "name": "System" }, { "name": "Templates" } ], "paths": { "/accounts": { "get": { "tags": [ "Account" ], "summary": "List accounts", "operationId": "get_accounts", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}": { "patch": { "tags": [ "Account" ], "summary": "Update accounts", "operationId": "patch_accounts_accid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "plan": "" } } } } } }, "/accounts/{accid}/api-keys": { "get": { "tags": [ "API Keys" ], "summary": "List api keys", "operationId": "get_accounts_accid_api_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "API Keys" ], "summary": "Create api keys", "operationId": "post_accounts_accid_api_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "name": "", "expires_at": "", "policies": "", "store_as_provider": "" } } } } } }, "/accounts/{accid}/api-keys/{kid}": { "post": { "tags": [ "API Keys" ], "summary": "Run action on api keys", "operationId": "post_accounts_accid_api_keys_kid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "scopes": "" } } } } }, "patch": { "tags": [ "API Keys" ], "summary": "Update api keys", "operationId": "patch_accounts_accid_api_keys_kid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "scopes": "" } } } } }, "delete": { "tags": [ "API Keys" ], "summary": "Delete api keys", "operationId": "delete_accounts_accid_api_keys_kid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps": { "get": { "tags": [ "Applications" ], "summary": "List apps", "operationId": "get_accounts_accid_apps", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "spcid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "src", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Applications" ], "summary": "Create apps", "operationId": "post_accounts_accid_apps", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "spcid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "src", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "app_name": "", "description": "", "source_type": "", "container": "", "git": "", "request": "", "replicas": "", "storage": "", "dns": "", "limit": "" } } } } } }, "/accounts/{accid}/apps/{appid}": { "get": { "tags": [ "Applications" ], "summary": "Get apps", "operationId": "get_accounts_accid_apps_appid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Applications" ], "summary": "Update apps", "operationId": "put_accounts_accid_apps_appid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "app_name": "", "description": "", "source_type": "", "container": "", "git": "", "request": "", "limit": "", "replicas": "", "storage": "", "port": "", "dns": "" } } } } }, "delete": { "tags": [ "Applications" ], "summary": "Delete apps", "operationId": "delete_accounts_accid_apps_appid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/deployments": { "get": { "tags": [ "Deployments" ], "summary": "List deployments", "operationId": "get_accounts_accid_apps_appid_deployments", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}": { "delete": { "tags": [ "Deployments" ], "summary": "Delete deployments", "operationId": "delete_accounts_accid_apps_appid_deployments_depid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/cancel": { "post": { "tags": [ "Deployments" ], "summary": "Create cancel", "operationId": "post_accounts_accid_apps_appid_deployments_depid_cancel", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/cancel-build": { "post": { "tags": [ "Deployments" ], "summary": "Create cancel build", "operationId": "post_accounts_accid_apps_appid_deployments_depid_cancel_build", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/clusters": { "get": { "tags": [ "Deployments" ], "summary": "List clusters", "operationId": "get_accounts_accid_apps_appid_deployments_depid_clusters", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/delete": { "post": { "tags": [ "Deployments" ], "summary": "Create delete", "operationId": "post_accounts_accid_apps_appid_deployments_depid_delete", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/deploy": { "post": { "tags": [ "Deployments" ], "summary": "Create deploy", "operationId": "post_accounts_accid_apps_appid_deployments_depid_deploy", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clone", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "promote", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dest", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "syncinstance", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/keys": { "get": { "tags": [ "Deployments" ], "summary": "List keys", "operationId": "get_accounts_accid_apps_appid_deployments_depid_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/logs": { "get": { "tags": [ "Deployments" ], "summary": "List logs", "operationId": "get_accounts_accid_apps_appid_deployments_depid_logs", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/main": { "get": { "tags": [ "Deployments" ], "summary": "List main", "operationId": "get_accounts_accid_apps_appid_deployments_depid_main", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Deployments" ], "summary": "Create main", "operationId": "post_accounts_accid_apps_appid_deployments_depid_main", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/name": { "put": { "tags": [ "Deployments" ], "summary": "Update name", "operationId": "put_accounts_accid_apps_appid_deployments_depid_name", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "old_value": "", "new_value": "" } } } } } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/status": { "get": { "tags": [ "Deployments" ], "summary": "List status", "operationId": "get_accounts_accid_apps_appid_deployments_depid_status", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/stop": { "post": { "tags": [ "Deployments" ], "summary": "Create stop", "operationId": "post_accounts_accid_apps_appid_deployments_depid_stop", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/apps/{appid}/deployments/{depid}/terminate": { "post": { "tags": [ "Deployments" ], "summary": "Create terminate", "operationId": "post_accounts_accid_apps_appid_deployments_depid_terminate", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/apps/{appid}/domains": { "get": { "tags": [ "Applications" ], "summary": "List domains", "operationId": "get_accounts_accid_apps_appid_domains", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instance", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "domain_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Applications" ], "summary": "Create domains", "operationId": "post_accounts_accid_apps_appid_domains", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instance", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "domain_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "name": "" } } } } }, "delete": { "tags": [ "Applications" ], "summary": "Delete domains", "operationId": "delete_accounts_accid_apps_appid_domains", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instance", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "domain_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/instances": { "get": { "tags": [ "Instances" ], "summary": "List instances", "operationId": "get_accounts_accid_apps_appid_instances", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Instances" ], "summary": "Create instances", "operationId": "post_accounts_accid_apps_appid_instances", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "env_id": "", "app_name": "", "container": "", "git": "", "limit": "", "replicas": "", "request": "", "source_type": "", "storage": "", "space_id": "", "deployment_strategy": "", "dns": "", "port": "", "ecr_create": "", "temp_app_id": "", "deploy_later": "" } } } } } }, "/accounts/{accid}/apps/{appid}/instances/{insid}": { "get": { "tags": [ "Instances" ], "summary": "Get instances", "operationId": "get_accounts_accid_apps_appid_instances_insid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Instances" ], "summary": "Update instances", "operationId": "put_accounts_accid_apps_appid_instances_insid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "app_name": "", "description": "", "source_type": "", "container": "", "git": "", "request": "", "limit": "", "replicas": "", "storage": "", "port": "", "dns": "" } } } } }, "delete": { "tags": [ "Instances" ], "summary": "Delete instances", "operationId": "delete_accounts_accid_apps_appid_instances_insid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/instances/{insid}/access": { "get": { "tags": [ "Instances" ], "summary": "List access", "operationId": "get_accounts_accid_apps_appid_instances_insid_access", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Instances" ], "summary": "Create access", "operationId": "post_accounts_accid_apps_appid_instances_insid_access", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "actions": "", "resources": "", "effect": "" } } } } } }, "/accounts/{accid}/apps/{appid}/instances/{insid}/access/{acsid}": { "get": { "tags": [ "Instances" ], "summary": "Get access", "operationId": "get_accounts_accid_apps_appid_instances_insid_access_acsid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "acsid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Instances" ], "summary": "Update access", "operationId": "put_accounts_accid_apps_appid_instances_insid_access_acsid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "acsid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "actions": "", "resources": "", "effect": "" } } } } }, "delete": { "tags": [ "Instances" ], "summary": "Delete access", "operationId": "delete_accounts_accid_apps_appid_instances_insid_access_acsid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "acsid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/instances/{insid}/branch-validate": { "get": { "tags": [ "Instances" ], "summary": "List branch validate", "operationId": "get_accounts_accid_apps_appid_instances_insid_branch_validate", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "branch", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/instances/{insid}/deploy": { "post": { "tags": [ "Instances" ], "summary": "Create deploy", "operationId": "post_accounts_accid_apps_appid_instances_insid_deploy", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "branch", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sha", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/apps/{appid}/instances/{insid}/deployments": { "get": { "tags": [ "Instances" ], "summary": "List deployments", "operationId": "get_accounts_accid_apps_appid_instances_insid_deployments", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/{appid}/instances/{insid}/env": { "put": { "tags": [ "Instances" ], "summary": "Update env", "operationId": "put_accounts_accid_apps_appid_instances_insid_env", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "insid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "env_id": "", "space_id": "", "deployment_strategy": "", "disable_build_cache": "" } } } } } }, "/accounts/{accid}/apps/{appid}/keys": { "get": { "tags": [ "Applications" ], "summary": "List keys", "operationId": "get_accounts_accid_apps_appid_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Applications" ], "summary": "Create keys", "operationId": "post_accounts_accid_apps_appid_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } } }, "/accounts/{accid}/apps/{appid}/keys/{kid}": { "put": { "tags": [ "Applications" ], "summary": "Update keys", "operationId": "put_accounts_accid_apps_appid_keys_kid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "kname", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } }, "delete": { "tags": [ "Applications" ], "summary": "Delete keys", "operationId": "delete_accounts_accid_apps_appid_keys_kid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "kname", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/temp/keys": { "get": { "tags": [ "Applications" ], "summary": "List keys", "operationId": "get_accounts_accid_apps_temp_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "temp_app_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Applications" ], "summary": "Create keys", "operationId": "post_accounts_accid_apps_temp_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "temp_app_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } }, "put": { "tags": [ "Applications" ], "summary": "Update keys", "operationId": "put_accounts_accid_apps_temp_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "temp_app_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } }, "delete": { "tags": [ "Applications" ], "summary": "Delete keys", "operationId": "delete_accounts_accid_apps_temp_keys", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "temp_app_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/apps/temp/keys/{params}": { "get": { "tags": [ "Applications" ], "summary": "Get keys", "operationId": "get_accounts_accid_apps_temp_keys_params", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "temp_app_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Applications" ], "summary": "Run action on keys", "operationId": "post_accounts_accid_apps_temp_keys_params", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "temp_app_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } }, "put": { "tags": [ "Applications" ], "summary": "Update keys", "operationId": "put_accounts_accid_apps_temp_keys_params", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "temp_app_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } }, "delete": { "tags": [ "Applications" ], "summary": "Delete keys", "operationId": "delete_accounts_accid_apps_temp_keys_params", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "temp_app_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/arules": { "get": { "tags": [ "Action Rules" ], "summary": "List arules", "operationId": "get_accounts_accid_arules", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Action Rules" ], "summary": "Create arules", "operationId": "post_accounts_accid_arules", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "cron": "", "custom": "", "rule_name": "", "rule_description": "", "resource_filter": "" } } } } } }, "/accounts/{accid}/arules/{arid}": { "get": { "tags": [ "Action Rules" ], "summary": "Get arules", "operationId": "get_accounts_accid_arules_arid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "arid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Action Rules" ], "summary": "Update arules", "operationId": "put_accounts_accid_arules_arid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "arid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "rule_name": "", "rule_description": "", "resource_filter": "", "cron": "", "custom": "" } } } } }, "delete": { "tags": [ "Action Rules" ], "summary": "Delete arules", "operationId": "delete_accounts_accid_arules_arid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "arid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/arules/{arid}/actions": { "get": { "tags": [ "Action Rules" ], "summary": "List actions", "operationId": "get_accounts_accid_arules_arid_actions", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "arid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Action Rules" ], "summary": "Create actions", "operationId": "post_accounts_accid_arules_arid_actions", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "arid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "order": "", "resource_type": "", "action": "", "resource_filter": "", "srn": "" } } } } } }, "/accounts/{accid}/arules/{arid}/actions/{actid}": { "get": { "tags": [ "Action Rules" ], "summary": "Get actions", "operationId": "get_accounts_accid_arules_arid_actions_actid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "arid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "actid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Action Rules" ], "summary": "Update actions", "operationId": "put_accounts_accid_arules_arid_actions_actid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "arid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "actid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "order": "", "resource_type": "", "action": "", "resource_filter": "", "srn": "" } } } } }, "delete": { "tags": [ "Action Rules" ], "summary": "Delete actions", "operationId": "delete_accounts_accid_arules_arid_actions_actid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "arid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "actid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/audit-logs": { "get": { "tags": [ "Audit Logs" ], "summary": "List audit logs", "operationId": "get_accounts_accid_audit_logs", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "action", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains": { "get": { "tags": [ "Domains" ], "summary": "List domains", "operationId": "get_accounts_accid_domains", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "addon", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Domains" ], "summary": "Create domains", "operationId": "post_accounts_accid_domains", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "addon", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "domain_name": "", "enabled": "", "provider_id": "", "is_default": "", "create_aws_zone": "", "issue_aws_cert": "" } } } } } }, "/accounts/{accid}/domains/{did}": { "get": { "tags": [ "Domains" ], "summary": "Get domains", "operationId": "get_accounts_accid_domains_did", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Domains" ], "summary": "Update domains", "operationId": "put_accounts_accid_domains_did", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "domain_name": "", "enabled": "", "provider_id": "", "is_default": "", "create_aws_zone": "", "issue_aws_cert": "" } } } } }, "delete": { "tags": [ "Domains" ], "summary": "Delete domains", "operationId": "delete_accounts_accid_domains_did", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains/{did}/action": { "post": { "tags": [ "Domains" ], "summary": "Create action", "operationId": "post_accounts_accid_domains_did_action", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/domains/{did}/logs": { "get": { "tags": [ "Domains" ], "summary": "List logs", "operationId": "get_accounts_accid_domains_did_logs", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains/{did}/used-by": { "get": { "tags": [ "Domains" ], "summary": "List used by", "operationId": "get_accounts_accid_domains_did_used_by", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains/{did}/used-by/certificates": { "get": { "tags": [ "Domains" ], "summary": "List certificates", "operationId": "get_accounts_accid_domains_did_used_by_certificates", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains/{did}/used-by/deployments": { "get": { "tags": [ "Domains" ], "summary": "List deployments", "operationId": "get_accounts_accid_domains_did_used_by_deployments", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains/{did}/used-by/edns": { "get": { "tags": [ "Domains" ], "summary": "List edns", "operationId": "get_accounts_accid_domains_did_used_by_edns", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains/{did}/used-by/environments": { "get": { "tags": [ "Domains" ], "summary": "List environments", "operationId": "get_accounts_accid_domains_did_used_by_environments", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains/{did}/used-by/meta": { "get": { "tags": [ "Domains" ], "summary": "List meta", "operationId": "get_accounts_accid_domains_did_used_by_meta", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "did", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/domains/active": { "get": { "tags": [ "Domains" ], "summary": "List active", "operationId": "get_accounts_accid_domains_active", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/groups": { "get": { "tags": [ "Groups" ], "summary": "List groups", "operationId": "get_accounts_accid_groups", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Groups" ], "summary": "Create groups", "operationId": "post_accounts_accid_groups", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "group_name": "", "description": "" } } } } } }, "/accounts/{accid}/groups/{gid}": { "get": { "tags": [ "Groups" ], "summary": "Get groups", "operationId": "get_accounts_accid_groups_gid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "gid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Groups" ], "summary": "Update groups", "operationId": "put_accounts_accid_groups_gid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "gid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "group_name": "", "description": "" } } } } }, "delete": { "tags": [ "Groups" ], "summary": "Delete groups", "operationId": "delete_accounts_accid_groups_gid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "gid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/groups/{gid}/policies": { "get": { "tags": [ "Groups" ], "summary": "List policies", "operationId": "get_accounts_accid_groups_gid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "gid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Groups" ], "summary": "Create policies", "operationId": "post_accounts_accid_groups_gid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "gid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "child_policy_id": "" } } } } }, "delete": { "tags": [ "Groups" ], "summary": "Delete policies", "operationId": "delete_accounts_accid_groups_gid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "gid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/info": { "get": { "tags": [ "Account" ], "summary": "List info", "operationId": "get_accounts_accid_info", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/info/apps": { "get": { "tags": [ "Account" ], "summary": "List apps", "operationId": "get_accounts_accid_info_apps", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "patch": { "tags": [ "Account" ], "summary": "Update apps", "operationId": "patch_accounts_accid_info_apps", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "providerId": "" } } } } } }, "/accounts/{accid}/info/business": { "get": { "tags": [ "Account" ], "summary": "List business", "operationId": "get_accounts_accid_info_business", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Account" ], "summary": "Update business", "operationId": "put_accounts_accid_info_business", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "business_name": "", "address1": "", "address2": "", "city": "", "state": "", "country": "", "zipCode": "", "contactPhone": "", "contactEmail": "", "enableBooking": "", "booking": "" } } } } } }, "/accounts/{accid}/info/feedback": { "post": { "tags": [ "Account" ], "summary": "Create feedback", "operationId": "post_accounts_accid_info_feedback", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "score": "", "comment": "" } } } } } }, "/accounts/{accid}/info/notifications": { "get": { "tags": [ "Account" ], "summary": "List notifications", "operationId": "get_accounts_accid_info_notifications", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/info/notifications/{ntid}/read": { "post": { "tags": [ "Account" ], "summary": "Create read", "operationId": "post_accounts_accid_info_notifications_ntid_read", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ntid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/info/plan": { "get": { "tags": [ "Account" ], "summary": "List plan", "operationId": "get_accounts_accid_info_plan", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/members": { "get": { "tags": [ "Members" ], "summary": "List members", "operationId": "get_accounts_accid_members", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enabled", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Members" ], "summary": "Create members", "operationId": "post_accounts_accid_members", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enabled", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "member_name": "", "member_email": "", "send_invite": "" } } } } } }, "/accounts/{accid}/members/{mid}": { "get": { "tags": [ "Members" ], "summary": "Get members", "operationId": "get_accounts_accid_members_mid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Members" ], "summary": "Update members", "operationId": "put_accounts_accid_members_mid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "member_name": "", "member_email": "", "enabled": "" } } } } }, "delete": { "tags": [ "Members" ], "summary": "Delete members", "operationId": "delete_accounts_accid_members_mid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/members/{mid}/disable": { "post": { "tags": [ "Members" ], "summary": "Create disable", "operationId": "post_accounts_accid_members_mid_disable", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/members/{mid}/enable": { "post": { "tags": [ "Members" ], "summary": "Create enable", "operationId": "post_accounts_accid_members_mid_enable", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/members/{mid}/policies": { "get": { "tags": [ "Members" ], "summary": "List policies", "operationId": "get_accounts_accid_members_mid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Members" ], "summary": "Create policies", "operationId": "post_accounts_accid_members_mid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "child_policy_id": "" } } } } }, "delete": { "tags": [ "Members" ], "summary": "Delete policies", "operationId": "delete_accounts_accid_members_mid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/networks": { "get": { "tags": [ "Networks" ], "summary": "List networks", "operationId": "get_accounts_accid_networks", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "action", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Networks" ], "summary": "Create networks", "operationId": "post_accounts_accid_networks", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "action", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "network_name": "", "description": "", "cidr": "", "region": "", "public_subnets": "", "private_subnets": "", "provider_id": "", "azs": "", "nat_strategy": "", "az_config": "" } } } } } }, "/accounts/{accid}/networks/{ntid}": { "get": { "tags": [ "Networks" ], "summary": "Get networks", "operationId": "get_accounts_accid_networks_ntid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ntid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Networks" ], "summary": "Update networks", "operationId": "put_accounts_accid_networks_ntid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ntid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "delete": { "tags": [ "Networks" ], "summary": "Delete networks", "operationId": "delete_accounts_accid_networks_ntid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ntid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/networks/{ntid}/action": { "post": { "tags": [ "Networks" ], "summary": "Create action", "operationId": "post_accounts_accid_networks_ntid_action", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ntid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/networks/{ntid}/clusters": { "get": { "tags": [ "Networks" ], "summary": "List clusters", "operationId": "get_accounts_accid_networks_ntid_clusters", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ntid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/networks/{ntid}/logs": { "get": { "tags": [ "Networks" ], "summary": "List logs", "operationId": "get_accounts_accid_networks_ntid_logs", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ntid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/networks/{ntid}/status": { "get": { "tags": [ "Networks" ], "summary": "List status", "operationId": "get_accounts_accid_networks_ntid_status", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ntid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/networks/import": { "post": { "tags": [ "Networks" ], "summary": "Create import", "operationId": "post_accounts_accid_networks_import", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "providerId": "", "region": "", "vpcImportMethod": "", "vpcId": "", "vpcName": "", "vpcCidr": "", "publicSubnetImportMethod": "", "publicSubnetIds": "", "publicSubnetCidrs": "", "publicSubnetTag": "", "privateSubnetImportMethod": "", "privateSubnetIds": "", "privateSubnetCidrs": "", "privateSubnetTag": "" } } } } } }, "/accounts/{accid}/onboarding/org": { "post": { "tags": [ "Account" ], "summary": "Create org", "operationId": "post_accounts_accid_onboarding_org", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "name": "" } } } } } }, "/accounts/{accid}/payment/cancel": { "post": { "tags": [ "Billing" ], "summary": "Create cancel", "operationId": "post_accounts_accid_payment_cancel", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/payment/checkout-session": { "get": { "tags": [ "Billing" ], "summary": "List checkout session", "operationId": "get_accounts_accid_payment_checkout_session", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "plan", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sub", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "seats", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Billing" ], "summary": "Create checkout session", "operationId": "post_accounts_accid_payment_checkout_session", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "plan", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sub", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "seats", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/payment/history": { "get": { "tags": [ "Billing" ], "summary": "List history", "operationId": "get_accounts_accid_payment_history", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/payment/reactivate": { "post": { "tags": [ "Billing" ], "summary": "Create reactivate", "operationId": "post_accounts_accid_payment_reactivate", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/payment/session-status": { "get": { "tags": [ "Billing" ], "summary": "List session status", "operationId": "get_accounts_accid_payment_session_status", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/payment/set-account-type": { "patch": { "tags": [ "Billing" ], "summary": "Update set account type", "operationId": "patch_accounts_accid_payment_set_account_type", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "account_type": "", "seats": "" } } } } } }, "/accounts/{accid}/payment/setup-intent": { "post": { "tags": [ "Billing" ], "summary": "Create setup intent", "operationId": "post_accounts_accid_payment_setup_intent", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/payment/switch-to-annual": { "patch": { "tags": [ "Billing" ], "summary": "Update switch to annual", "operationId": "patch_accounts_accid_payment_switch_to_annual", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/payment/update-method": { "post": { "tags": [ "Billing" ], "summary": "Create update method", "operationId": "post_accounts_accid_payment_update_method", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "paymentMethodId": "" } } } } } }, "/accounts/{accid}/payment/update-seats": { "patch": { "tags": [ "Billing" ], "summary": "Update update seats", "operationId": "patch_accounts_accid_payment_update_seats", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "seats": "" } } } } } }, "/accounts/{accid}/policies": { "get": { "tags": [ "Policies" ], "summary": "List policies", "operationId": "get_accounts_accid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "managed", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Policies" ], "summary": "Create policies", "operationId": "post_accounts_accid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "managed", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "policy_name": "", "description": "" } } } } } }, "/accounts/{accid}/policies/{pcid}": { "get": { "tags": [ "Policies" ], "summary": "Get policies", "operationId": "get_accounts_accid_policies_pcid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Policies" ], "summary": "Update policies", "operationId": "put_accounts_accid_policies_pcid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "delete": { "tags": [ "Policies" ], "summary": "Delete policies", "operationId": "delete_accounts_accid_policies_pcid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/policies/{pcid}/policies": { "get": { "tags": [ "Policies" ], "summary": "List policies", "operationId": "get_accounts_accid_policies_pcid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Policies" ], "summary": "Create policies", "operationId": "post_accounts_accid_policies_pcid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "child_policy_id": "" } } } } }, "delete": { "tags": [ "Policies" ], "summary": "Delete policies", "operationId": "delete_accounts_accid_policies_pcid_policies", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policy_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/policies/{pcid}/policies/{chpcid}": { "delete": { "tags": [ "Policies" ], "summary": "Delete policies", "operationId": "delete_accounts_accid_policies_pcid_policies_chpcid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "chpcid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/policies/{pcid}/statements": { "get": { "tags": [ "Policies" ], "summary": "List statements", "operationId": "get_accounts_accid_policies_pcid_statements", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Policies" ], "summary": "Create statements", "operationId": "post_accounts_accid_policies_pcid_statements", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pcid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "service": "", "actions": "", "effect": "", "resource": "" } } } } } }, "/accounts/{accid}/policies/statements/{sid}": { "put": { "tags": [ "Policies" ], "summary": "Update statements", "operationId": "put_accounts_accid_policies_statements_sid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "service": "", "effect": "", "resource": "", "actions": "" } } } } }, "delete": { "tags": [ "Policies" ], "summary": "Delete statements", "operationId": "delete_accounts_accid_policies_statements_sid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/tickets": { "get": { "tags": [ "Support Tickets" ], "summary": "List tickets", "operationId": "get_accounts_accid_tickets", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Support Tickets" ], "summary": "Create tickets", "operationId": "post_accounts_accid_tickets", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "summary": "", "description": "", "ticket_type": "" } } } } } }, "/accounts/{accid}/tickets/{tid}": { "get": { "tags": [ "Support Tickets" ], "summary": "Get tickets", "operationId": "get_accounts_accid_tickets_tid", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/{accid}/tickets/{tid}/close": { "post": { "tags": [ "Support Tickets" ], "summary": "Create close", "operationId": "post_accounts_accid_tickets_tid_close", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/{accid}/tickets/{tid}/messages": { "get": { "tags": [ "Support Tickets" ], "summary": "List messages", "operationId": "get_accounts_accid_tickets_tid_messages", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Support Tickets" ], "summary": "Create messages", "operationId": "post_accounts_accid_tickets_tid_messages", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "content": "" } } } } } }, "/accounts/{accid}/unsubscribe": { "post": { "tags": [ "Account" ], "summary": "Create unsubscribe", "operationId": "post_accounts_accid_unsubscribe", "parameters": [ { "name": "accid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "email": "", "notifications": "" } } } } } }, "/accounts/appointments": { "get": { "tags": [ "Scheduling" ], "summary": "List appointments", "operationId": "get_accounts_appointments", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "description": "GET /api/accounts/appointments ?accid= &status= (default: scheduled) &date= (single-day filter) &from= (range start, inclusive) &to= (range end, inclusive) &page= (1-based, default 1) &perPage= (default 25, max 100) Response: { success: true, data: BookingInfo[], // paginated results total: number, // total matching this filter page: number, perPage: number, summary: { // global counts (no date filter, all statuses) upcoming: number, // scheduled & start_ts >= now today: number, // scheduled & start_ts is" } }, "/accounts/events": { "get": { "tags": [ "Scheduling" ], "summary": "List events", "operationId": "get_accounts_events", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Scheduling" ], "summary": "Create events", "operationId": "post_accounts_events", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "event_title": "", "event_desc": "", "timezone": "", "slotDuration": "", "hashed_key": "" } } } } } }, "/accounts/events/{evid}": { "get": { "tags": [ "Scheduling" ], "summary": "Get events", "operationId": "get_accounts_events_evid", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "delete": { "tags": [ "Scheduling" ], "summary": "Delete events", "operationId": "delete_accounts_events_evid", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/events/{evid}/bookings": { "get": { "tags": [ "Scheduling" ], "summary": "List bookings", "operationId": "get_accounts_events_evid_bookings", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Scheduling" ], "summary": "Create bookings", "operationId": "post_accounts_events_evid_bookings", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "start_ts": "", "end_ts": "", "customer_id": "", "customer_name": "", "customer_phone": "", "customer_email": "", "customer_notes": "", "timezone": "" } } } } } }, "/accounts/events/{evid}/bookings/{bkid}": { "get": { "tags": [ "Scheduling" ], "summary": "Get bookings", "operationId": "get_accounts_events_evid_bookings_bkid", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bkid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "patch": { "tags": [ "Scheduling" ], "summary": "Update bookings", "operationId": "patch_accounts_events_evid_bookings_bkid", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bkid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "status": "" } } } } }, "delete": { "tags": [ "Scheduling" ], "summary": "Delete bookings", "operationId": "delete_accounts_events_evid_bookings_bkid", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bkid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/events/{evid}/bookings/available": { "get": { "tags": [ "Scheduling" ], "summary": "List available", "operationId": "get_accounts_events_evid_bookings_available", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tmz", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/accounts/events/{evid}/mybookings": { "get": { "tags": [ "Scheduling" ], "summary": "List mybookings", "operationId": "get_accounts_events_evid_mybookings", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Scheduling" ], "summary": "Create mybookings", "operationId": "post_accounts_events_evid_mybookings", "parameters": [ { "name": "evid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "show", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "start_ts": "", "end_ts": "", "customer_notes": "", "timezone": "" } } } } } }, "/accounts/invite/{invid}": { "get": { "tags": [ "Members" ], "summary": "Get invite", "operationId": "get_accounts_invite_invid", "parameters": [ { "name": "invid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Members" ], "summary": "Run action on invite", "operationId": "post_accounts_invite_invid", "parameters": [ { "name": "invid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/accounts/unsubscribe": { "post": { "tags": [ "Account" ], "summary": "Create unsubscribe", "operationId": "post_accounts_unsubscribe", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "email": "", "notifications": "" } } } } } }, "/auth/check-access": { "get": { "tags": [ "Auth" ], "summary": "List check access", "operationId": "get_auth_check_access", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/auth/me": { "get": { "tags": [ "Auth" ], "summary": "List me", "operationId": "get_auth_me", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/auth/profile": { "get": { "tags": [ "Auth" ], "summary": "List profile", "operationId": "get_auth_profile", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/aws/availability-zones": { "get": { "tags": [ "AWS" ], "summary": "List availability zones", "operationId": "get_aws_availability_zones", "parameters": [ { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "description": "API endpoint to get availability zones for a given AWS region Query params: - region: AWS region code (e.g., \"us-east-1\") - provider_id: Provider ID to get credentials from Returns: - List of AZ names for the region" } }, "/deployments": { "get": { "tags": [ "Deployments" ], "summary": "List deployments", "operationId": "get_deployments", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "spcid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "appid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/deployments/{id}": { "get": { "tags": [ "Deployments" ], "summary": "Get deployments", "operationId": "get_deployments_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/gh/repos": { "get": { "tags": [ "GitHub" ], "summary": "List repos", "operationId": "get_gh_repos", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/health": { "get": { "tags": [ "System" ], "summary": "Health check", "operationId": "get_health", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "security": [] } }, "/helm/dkr": { "get": { "tags": [ "Helm" ], "summary": "List dkr", "operationId": "get_helm_dkr", "parameters": [ { "name": "pid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "repo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/helm/https": { "get": { "tags": [ "Helm" ], "summary": "List https", "operationId": "get_helm_https", "parameters": [ { "name": "repo", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org": { "get": { "tags": [ "Organization" ], "summary": "List org", "operationId": "get_org", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "all", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Organization" ], "summary": "Create org", "operationId": "post_org", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "all", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "name": "" } } } } } }, "/org/{id}": { "get": { "tags": [ "Organization" ], "summary": "Get org", "operationId": "get_org_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Organization" ], "summary": "Update org", "operationId": "put_org_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "name": "" } } } } }, "delete": { "tags": [ "Organization" ], "summary": "Delete org", "operationId": "delete_org_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/apps": { "get": { "tags": [ "Organization" ], "summary": "List apps", "operationId": "get_org_id_apps", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Organization" ], "summary": "Create apps", "operationId": "post_org_id_apps", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "app_name": "", "description": "", "source_type": "", "container": "", "git": "", "request": "", "replicas": "", "storage": "", "port": "", "dns": "", "limit": "" } } } } } }, "/org/{id}/clusters": { "get": { "tags": [ "Clusters" ], "summary": "List clusters", "operationId": "get_org_id_clusters", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Clusters" ], "summary": "Create clusters", "operationId": "post_org_id_clusters", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "network_id": "", "cluster_name": "", "description": "", "api_version": "", "on_demand": "", "spot": "", "disk_size_gb": "", "executer": "" } } } } } }, "/org/{id}/clusters/{cid}": { "get": { "tags": [ "Clusters" ], "summary": "Get clusters", "operationId": "get_org_id_clusters_cid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Clusters" ], "summary": "Update clusters", "operationId": "put_org_id_clusters_cid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "cluster_name": "", "description": "", "api_version": "", "on_demand": "", "spot": "", "disk_size_gb": "", "active": "" } } } } }, "delete": { "tags": [ "Clusters" ], "summary": "Delete clusters", "operationId": "delete_org_id_clusters_cid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/action": { "post": { "tags": [ "Clusters" ], "summary": "Create action", "operationId": "post_org_id_clusters_cid_action", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "confirm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/org/{id}/clusters/{cid}/addons": { "get": { "tags": [ "Clusters" ], "summary": "List addons", "operationId": "get_org_id_clusters_cid_addons", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/addons/{adid}": { "get": { "tags": [ "Clusters" ], "summary": "Get addons", "operationId": "get_org_id_clusters_cid_addons_adid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Clusters" ], "summary": "Run action on addons", "operationId": "post_org_id_clusters_cid_addons_adid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "domains_filter": "", "iss_request": "" } } } } }, "delete": { "tags": [ "Clusters" ], "summary": "Delete addons", "operationId": "delete_org_id_clusters_cid_addons_adid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/addons/{adid}/certs": { "get": { "tags": [ "Clusters" ], "summary": "List certs", "operationId": "get_org_id_clusters_cid_addons_adid_certs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Clusters" ], "summary": "Create certs", "operationId": "post_org_id_clusters_cid_addons_adid_certs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "cert_name": "", "cert_namespace": "", "secret_name": "", "issuer_id": "", "domain_name": "", "issue_wildcard": "" } } } } } }, "/org/{id}/clusters/{cid}/addons/{adid}/certs/{certid}": { "delete": { "tags": [ "Clusters" ], "summary": "Delete certs", "operationId": "delete_org_id_clusters_cid_addons_adid_certs_certid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "certid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/addons/{adid}/issuers": { "get": { "tags": [ "Clusters" ], "summary": "List issuers", "operationId": "get_org_id_clusters_cid_addons_adid_issuers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Clusters" ], "summary": "Create issuers", "operationId": "post_org_id_clusters_cid_addons_adid_issuers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "issuer_name": "", "issuer_server": "", "admin_email": "", "issuer_namespace": "", "issuer_type": "", "delete_secrets": "", "challenge_type": "", "http_solvers": "", "dns_provider_id": "", "allowed_zones": "", "provider_creds_namespaces": "" } } } } } }, "/org/{id}/clusters/{cid}/addons/{adid}/issuers/{issid}": { "delete": { "tags": [ "Clusters" ], "summary": "Delete issuers", "operationId": "delete_org_id_clusters_cid_addons_adid_issuers_issid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "issid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/addons/{adid}/logs": { "get": { "tags": [ "Clusters" ], "summary": "List logs", "operationId": "get_org_id_clusters_cid_addons_adid_logs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/apps": { "get": { "tags": [ "Clusters" ], "summary": "List apps", "operationId": "get_org_id_clusters_cid_apps", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/envs": { "get": { "tags": [ "Clusters" ], "summary": "List envs", "operationId": "get_org_id_clusters_cid_envs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/keys": { "get": { "tags": [ "Clusters" ], "summary": "List keys", "operationId": "get_org_id_clusters_cid_keys", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Clusters" ], "summary": "Create keys", "operationId": "post_org_id_clusters_cid_keys", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } } }, "/org/{id}/clusters/{cid}/keys/{kid}": { "put": { "tags": [ "Clusters" ], "summary": "Update keys", "operationId": "put_org_id_clusters_cid_keys_kid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } }, "delete": { "tags": [ "Clusters" ], "summary": "Delete keys", "operationId": "delete_org_id_clusters_cid_keys_kid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/logs": { "get": { "tags": [ "Clusters" ], "summary": "List logs", "operationId": "get_org_id_clusters_cid_logs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/nodes": { "get": { "tags": [ "Clusters" ], "summary": "List nodes", "operationId": "get_org_id_clusters_cid_nodes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dnode", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Clusters" ], "summary": "Create nodes", "operationId": "post_org_id_clusters_cid_nodes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dnode", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "node_name": "", "disk_size_gb": "", "on_demand": "", "spot": "", "enforce_instance_refresh": "" } } } } } }, "/org/{id}/clusters/{cid}/nodes/{nid}": { "put": { "tags": [ "Clusters" ], "summary": "Update nodes", "operationId": "put_org_id_clusters_cid_nodes_nid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "nid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "node_name": "", "disk_size_gb": "", "on_demand": "", "spot": "", "enforce_instance_refresh": "" } } } } }, "delete": { "tags": [ "Clusters" ], "summary": "Delete nodes", "operationId": "delete_org_id_clusters_cid_nodes_nid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "nid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/{cid}/nodes/apply": { "post": { "tags": [ "Clusters" ], "summary": "Create apply", "operationId": "post_org_id_clusters_cid_nodes_apply", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/org/{id}/clusters/{cid}/status": { "get": { "tags": [ "Clusters" ], "summary": "List status", "operationId": "get_org_id_clusters_cid_status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/addons/{adid}": { "get": { "tags": [ "Clusters" ], "summary": "Get addons", "operationId": "get_org_id_clusters_addons_adid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "adid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/clusters/withaddons": { "post": { "tags": [ "Clusters" ], "summary": "Create withaddons", "operationId": "post_org_id_clusters_withaddons", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "network_id": "", "cluster_name": "", "description": "", "api_version": "", "on_demand": "", "spot": "", "disk_size_gb": "", "executer": "", "alb": "", "nginx": "" } } } } } }, "/org/{id}/envs": { "get": { "tags": [ "Environments" ], "summary": "List envs", "operationId": "get_org_id_envs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Environments" ], "summary": "Create envs", "operationId": "post_org_id_envs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "env_name": "", "description": "", "domain_id": "", "routing_policy": "", "executer": "", "primary_failover": "", "ingress_class": "", "ingress_annotations": "", "node_labels": "" } } } } } }, "/org/{id}/envs/{envid}": { "get": { "tags": [ "Environments" ], "summary": "Get envs", "operationId": "get_org_id_envs_envid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Environments" ], "summary": "Update envs", "operationId": "put_org_id_envs_envid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "description": "", "ingress_class": "", "domain_id": "", "routing_policy": "", "primary_failover": "", "executer": "", "node_labels": "", "ingress_annotations": "" } } } } }, "delete": { "tags": [ "Environments" ], "summary": "Delete envs", "operationId": "delete_org_id_envs_envid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/apps": { "get": { "tags": [ "Environments" ], "summary": "List apps", "operationId": "get_org_id_envs_envid_apps", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/builds": { "get": { "tags": [ "Environments" ], "summary": "List builds", "operationId": "get_org_id_envs_envid_builds", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "description": "GET /org/[id]/envs/[envid]/builds?accid= Returns the builds Map values as a flat array, always prepended with the system \"Embedded\" build server entry. POST /org/[id]/envs/[envid]/builds?accid= Body: { server_type, server_name, provider_id } server_type — addon id (e.g. \"65affeceaa0001401cabb4ff\") | \"custom\" server_name — cluster_id (required when server_type !== \"custom\") provider_id — provider_id (required when server_type === \"custom\") Map key = server_type → naturally enforces one entry per build type." }, "post": { "tags": [ "Environments" ], "summary": "Create builds", "operationId": "post_org_id_envs_envid_builds", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "description": "GET /org/[id]/envs/[envid]/builds?accid= Returns the builds Map values as a flat array, always prepended with the system \"Embedded\" build server entry. POST /org/[id]/envs/[envid]/builds?accid= Body: { server_type, server_name, provider_id } server_type — addon id (e.g. \"65affeceaa0001401cabb4ff\") | \"custom\" server_name — cluster_id (required when server_type !== \"custom\") provider_id — provider_id (required when server_type === \"custom\") Map key = server_type → naturally enforces one entry per build type.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "server_type": "", "server_name": "", "provider_id": "", "build_server_type_custom": "" } } } } } }, "/org/{id}/envs/{envid}/builds/{bid}": { "delete": { "tags": [ "Environments" ], "summary": "Delete builds", "operationId": "delete_org_id_envs_envid_builds_bid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "description": "DELETE /org/[id]/envs/[envid]/builds/[bid]?accid= [bid] = server_type (the map key): addon id or \"custom\". Mirrors spaces/[name].ts — simple $unset on the builds map entry." } }, "/org/{id}/envs/{envid}/clusters": { "get": { "tags": [ "Environments" ], "summary": "List clusters", "operationId": "get_org_id_envs_envid_clusters", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "term", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/clusters/{cid}": { "put": { "tags": [ "Environments" ], "summary": "Update clusters", "operationId": "put_org_id_envs_envid_clusters_cid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "delete": { "tags": [ "Environments" ], "summary": "Delete clusters", "operationId": "delete_org_id_envs_envid_clusters_cid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/keys": { "get": { "tags": [ "Environments" ], "summary": "List keys", "operationId": "get_org_id_envs_envid_keys", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Environments" ], "summary": "Create keys", "operationId": "post_org_id_envs_envid_keys", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } } }, "/org/{id}/envs/{envid}/keys/{kid}": { "put": { "tags": [ "Environments" ], "summary": "Update keys", "operationId": "put_org_id_envs_envid_keys_kid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } }, "delete": { "tags": [ "Environments" ], "summary": "Delete keys", "operationId": "delete_org_id_envs_envid_keys_kid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/node-pools": { "get": { "tags": [ "Environments" ], "summary": "List node pools", "operationId": "get_org_id_envs_envid_node_pools", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/settings": { "get": { "tags": [ "Environments" ], "summary": "List settings", "operationId": "get_org_id_envs_envid_settings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dns", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ingress", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "evidence", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Environments" ], "summary": "Update settings", "operationId": "put_org_id_envs_envid_settings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dns", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ingress", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "evidence", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "executer": "", "code_build_type": "", "enforced_build_server": "", "trigger_deployment_strategy": "", "max_deployments_per_instance": "", "trigger_specific_deployment": "", "max_deployments_exceed_strategy": "", "deployment_trigger_scope": "" } } } } } }, "/org/{id}/envs/{envid}/share": { "post": { "tags": [ "Environments" ], "summary": "Create share", "operationId": "post_org_id_envs_envid_share", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "owner", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "account_id": "", "spaces": "" } } } } } }, "/org/{id}/envs/{envid}/shares": { "get": { "tags": [ "Environments" ], "summary": "List shares", "operationId": "get_org_id_envs_envid_shares", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/shares/{shid}": { "get": { "tags": [ "Environments" ], "summary": "Get shares", "operationId": "get_org_id_envs_envid_shares_shid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "shid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "delete": { "tags": [ "Environments" ], "summary": "Delete shares", "operationId": "delete_org_id_envs_envid_shares_shid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "shid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/shares/{shid}/spaces": { "get": { "tags": [ "Environments" ], "summary": "List spaces", "operationId": "get_org_id_envs_envid_shares_shid_spaces", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "shid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/{envid}/spaces": { "get": { "tags": [ "Environments" ], "summary": "List spaces", "operationId": "get_org_id_envs_envid_spaces", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Environments" ], "summary": "Create spaces", "operationId": "post_org_id_envs_envid_spaces", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/org/{id}/envs/{envid}/spaces/{name}": { "delete": { "tags": [ "Environments" ], "summary": "Delete spaces", "operationId": "delete_org_id_envs_envid_spaces_name", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "envid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/counts": { "get": { "tags": [ "Environments" ], "summary": "List counts", "operationId": "get_org_id_envs_counts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/counts/all": { "get": { "tags": [ "Environments" ], "summary": "List all", "operationId": "get_org_id_envs_counts_all", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/counts/apps": { "get": { "tags": [ "Environments" ], "summary": "List apps", "operationId": "get_org_id_envs_counts_apps", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/envs/counts/cls": { "get": { "tags": [ "Environments" ], "summary": "List cls", "operationId": "get_org_id_envs_counts_cls", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/keys": { "get": { "tags": [ "Org Keys" ], "summary": "List keys", "operationId": "get_org_id_keys", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Org Keys" ], "summary": "Create keys", "operationId": "post_org_id_keys", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } } }, "/org/{id}/keys/{kid}": { "put": { "tags": [ "Org Keys" ], "summary": "Update keys", "operationId": "put_org_id_keys_kid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "key_name": "", "key_value": "" } } } } }, "delete": { "tags": [ "Org Keys" ], "summary": "Delete keys", "operationId": "delete_org_id_keys_kid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ktype", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/spaces": { "get": { "tags": [ "Spaces" ], "summary": "List spaces", "operationId": "get_org_id_spaces", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Spaces" ], "summary": "Create spaces", "operationId": "post_org_id_spaces", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "envid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "space_name": "" } } } } } }, "/org/{id}/spaces/{spcid}": { "get": { "tags": [ "Spaces" ], "summary": "Get spaces", "operationId": "get_org_id_spaces_spcid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "spcid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Spaces" ], "summary": "Update spaces", "operationId": "put_org_id_spaces_spcid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "spcid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "delete": { "tags": [ "Spaces" ], "summary": "Delete spaces", "operationId": "delete_org_id_spaces_spcid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "spcid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/org/{id}/stats": { "get": { "tags": [ "Organization" ], "summary": "List stats", "operationId": "get_org_id_stats", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/providers": { "get": { "tags": [ "Providers" ], "summary": "List providers", "operationId": "get_providers", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "gh_app", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "post": { "tags": [ "Providers" ], "summary": "Create providers", "operationId": "post_providers", "parameters": [ { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "output", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "gh_app", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "provider_type": "", "aws": "", "github": "", "cflare": "", "pdns": "", "docker": "", "helm": "", "slk": "", "basic": "", "token_apikey": "", "sgt_apikey": "", "active": "", "provider_name": "" } } } } } }, "/providers/{pid}": { "get": { "tags": [ "Providers" ], "summary": "Get providers", "operationId": "get_providers_pid", "parameters": [ { "name": "pid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] }, "put": { "tags": [ "Providers" ], "summary": "Update providers", "operationId": "put_providers_pid", "parameters": [ { "name": "pid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "provider_name": "", "description": "", "active": "" } } } } }, "delete": { "tags": [ "Providers" ], "summary": "Delete providers", "operationId": "delete_providers_pid", "parameters": [ { "name": "pid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/providers/{pid}/clusters": { "get": { "tags": [ "Providers" ], "summary": "List clusters", "operationId": "get_providers_pid_clusters", "parameters": [ { "name": "pid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/sgt/actions": { "get": { "tags": [ "Templates" ], "summary": "List actions", "operationId": "get_sgt_actions", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } }, "/sgt/templates": { "get": { "tags": [ "Templates" ], "summary": "List templates", "operationId": "get_sgt_templates", "parameters": [ { "name": "owner", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accid", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "security": [ { "sgtToken": [] } ] } } }, "components": { "securitySchemes": { "sgtToken": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Paste an API key (`sgt_…`) or a Firebase ID token. Raw value only — **no `Bearer ` prefix**." } }, "responses": { "Unauthorized": { "description": "Missing, invalid or expired token", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "Forbidden": { "description": "Authenticated, but not allowed to perform this action", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } } } } }