{ "openapi": "3.1.0", "info": { "title": "CDNFoundry Control Plane API", "version": "1.0.0" }, "servers": [ { "url": "/api" } ], "paths": { "/admin/analytics/compression": { "get": { "operationId": "get.admin.analytics.compression", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/analytics/dns": { "get": { "operationId": "get.admin.analytics.dns", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/analytics/summary": { "get": { "operationId": "get.admin.analytics.summary", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/analytics/traffic": { "get": { "operationId": "get.admin.analytics.traffic", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/audit-logs": { "get": { "operationId": "get.admin.audit-logs", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/backups": { "get": { "operationId": "get.admin.backups", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.admin.backups", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/backups/{backup}": { "delete": { "operationId": "delete.admin.backups.backup", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "backup", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "get": { "operationId": "get.admin.backups.backup", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "backup", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/backups/{backup}/restore": { "post": { "operationId": "post.admin.backups.backup.restore", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "backup", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/dns/clusters": { "get": { "operationId": "get.admin.dns.clusters", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.admin.dns.clusters", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/dns/clusters/{cluster}": { "get": { "operationId": "get.admin.dns.clusters.cluster", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cluster", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.admin.dns.clusters.cluster", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cluster", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/dns/clusters/{cluster}/disable": { "post": { "operationId": "post.admin.dns.clusters.cluster.disable", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cluster", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/dns/clusters/{cluster}/enable": { "post": { "operationId": "post.admin.dns.clusters.cluster.enable", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cluster", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/dns/clusters/{cluster}/test": { "post": { "operationId": "post.admin.dns.clusters.cluster.test", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cluster", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/dns/deployments": { "get": { "operationId": "get.admin.dns.deployments", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/dns/failed-deployments": { "get": { "operationId": "get.admin.dns.failed-deployments", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/dns/reconcile": { "post": { "operationId": "post.admin.dns.reconcile", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/domains/{domain}/force-verify": { "post": { "operationId": "post.admin.domains.domain.force-verify", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/domains/{domain}/isolation": { "get": { "operationId": "get.admin.domains.domain.isolation", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.admin.domains.domain.isolation", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/domains/{domain}/move": { "post": { "operationId": "post.admin.domains.domain.move", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/domains/{domain}/protect": { "post": { "operationId": "post.admin.domains.domain.protect", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/domains/{domain}/quarantine": { "post": { "operationId": "post.admin.domains.domain.quarantine", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/domains/{domain}/return-to-normal": { "post": { "operationId": "post.admin.domains.domain.return-to-normal", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/domains/{domain}/users": { "get": { "operationId": "get.admin.domains.domain.users", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.admin.domains.domain.users", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/domains/{domain}/users/{user}": { "delete": { "operationId": "delete.admin.domains.domain.users.user", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-cells": { "get": { "operationId": "get.admin.edge-cells", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/edge-cells/{cell}": { "get": { "operationId": "get.admin.edge-cells.cell", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cell", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/edge-cells/{cell}/drain": { "post": { "operationId": "post.admin.edge-cells.cell.drain", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cell", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-cells/{cell}/restart": { "post": { "operationId": "post.admin.edge-cells.cell.restart", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cell", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-cells/{cell}/undrain": { "post": { "operationId": "post.admin.edge-cells.cell.undrain", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cell", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-deployments": { "get": { "operationId": "get.admin.edge-deployments", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/edge-deployments/reconcile": { "post": { "operationId": "post.admin.edge-deployments.reconcile", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools": { "get": { "operationId": "get.admin.edge-pools", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.admin.edge-pools", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}": { "delete": { "operationId": "delete.admin.edge-pools.pool", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "get": { "operationId": "get.admin.edge-pools.pool", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.admin.edge-pools.pool", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}/cells/{cell}": { "delete": { "operationId": "delete.admin.edge-pools.pool.cells.cell", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cell", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "put": { "operationId": "put.admin.edge-pools.pool.cells.cell", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "cell", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}/disable": { "post": { "operationId": "post.admin.edge-pools.pool.disable", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}/edges/{edge}/endpoint": { "post": { "operationId": "post.admin.edge-pools.pool.edges.edge.endpoint", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}/enable": { "post": { "operationId": "post.admin.edge-pools.pool.enable", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}/endpoints/{endpoint}": { "delete": { "operationId": "delete.admin.edge-pools.pool.endpoints.endpoint", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "endpoint", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "patch": { "operationId": "patch.admin.edge-pools.pool.endpoints.endpoint", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "endpoint", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}/maintenance": { "delete": { "operationId": "delete.admin.edge-pools.pool.maintenance", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "post": { "operationId": "post.admin.edge-pools.pool.maintenance", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}/restore": { "post": { "operationId": "post.admin.edge-pools.pool.restore", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-pools/{pool}/withdraw": { "post": { "operationId": "post.admin.edge-pools.pool.withdraw", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pool", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edge-routing": { "get": { "operationId": "get.admin.edge-routing", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/edges": { "get": { "operationId": "get.admin.edges", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.admin.edges", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edges/{edge}": { "delete": { "operationId": "delete.admin.edges.edge", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "get": { "operationId": "get.admin.edges.edge", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.admin.edges.edge", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edges/{edge}/disable": { "post": { "operationId": "post.admin.edges.edge.disable", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edges/{edge}/drain": { "post": { "operationId": "post.admin.edges.edge.drain", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edges/{edge}/enable": { "post": { "operationId": "post.admin.edges.edge.enable", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edges/{edge}/rotate-identity": { "post": { "operationId": "post.admin.edges.edge.rotate-identity", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/edges/{edge}/undrain": { "post": { "operationId": "post.admin.edges.edge.undrain", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "edge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/fleet/releases": { "get": { "operationId": "get.admin.fleet.releases", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.admin.fleet.releases", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/fleet/rollouts": { "get": { "operationId": "get.admin.fleet.rollouts", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.admin.fleet.rollouts", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/fleet/rollouts/{rollout}": { "get": { "operationId": "get.admin.fleet.rollouts.rollout", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "rollout", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/fleet/rollouts/{rollout}/resume": { "post": { "operationId": "post.admin.fleet.rollouts.rollout.resume", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "rollout", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/fleet/rollouts/{rollout}/rollback": { "post": { "operationId": "post.admin.fleet.rollouts.rollout.rollback", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "rollout", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/jobs/failed": { "get": { "operationId": "get.admin.jobs.failed", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/jobs/failed/{job}": { "delete": { "operationId": "delete.admin.jobs.failed.job", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "job", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/jobs/failed/{job}/retry": { "post": { "operationId": "post.admin.jobs.failed.job.retry", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "job", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/logs/edges": { "get": { "operationId": "get.admin.logs.edges", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/logs/errors": { "get": { "operationId": "get.admin.logs.errors", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/logs/security": { "get": { "operationId": "get.admin.logs.security", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/operations": { "get": { "operationId": "get.admin.operations", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/operations/{operation}": { "get": { "operationId": "get.admin.operations.operation", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "operation", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/operations/{operation}/retry": { "post": { "operationId": "post.admin.operations.operation.retry", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "operation", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/reconcile/{scope}": { "post": { "operationId": "post.admin.reconcile.scope", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "scope", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "dns", "edges", "tls", "purges", "usage" ] } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/system/components": { "get": { "operationId": "get.admin.system.components", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/system/health": { "get": { "operationId": "get.admin.system.health", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/system/settings": { "get": { "operationId": "get.admin.system.settings", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.admin.system.settings", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/system/settings/dns": { "get": { "operationId": "get.admin.system.settings.dns", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.admin.system.settings.dns", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/system/settings/dns/validate": { "post": { "operationId": "post.admin.system.settings.dns.validate", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/system/settings/{group}": { "get": { "operationId": "get.admin.system.settings.group", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "operations", "telemetry", "dns_lifecycle", "revision_history", "rate_limits", "edge_runtime", "origin_safety", "proxy_defaults" ] } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.admin.system.settings.group", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "operations", "telemetry", "dns_lifecycle", "revision_history", "rate_limits", "edge_runtime", "origin_safety", "proxy_defaults" ] } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/system/status": { "get": { "operationId": "get.admin.system.status", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/usage": { "get": { "operationId": "get.admin.usage", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/usage/export": { "get": { "operationId": "get.admin.usage.export", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/usage/rebuild": { "post": { "operationId": "post.admin.usage.rebuild", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/users": { "get": { "operationId": "get.admin.users", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.admin.users", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/users/{user}": { "delete": { "operationId": "delete.admin.users.user", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "get": { "operationId": "get.admin.users.user", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.admin.users.user", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/users/{user}/disable": { "post": { "operationId": "post.admin.users.user.disable", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/admin/users/{user}/domains": { "get": { "operationId": "get.admin.users.user.domains", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/admin/users/{user}/enable": { "post": { "operationId": "post.admin.users.user.enable", "tags": [ "Administrator" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/auth/login": { "post": { "operationId": "post.auth.login", "tags": [ "Account" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/auth/logout": { "post": { "operationId": "post.auth.logout", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains": { "get": { "operationId": "get.domains", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.domains", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}": { "delete": { "operationId": "delete.domains.domain", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "get": { "operationId": "get.domains.domain", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.domains.domain", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/activate": { "post": { "operationId": "post.domains.domain.activate", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/analytics/cache": { "get": { "operationId": "get.domains.domain.analytics.cache", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/compression": { "get": { "operationId": "get.domains.domain.analytics.compression", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/countries": { "get": { "operationId": "get.domains.domain.analytics.countries", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/dns": { "get": { "operationId": "get.domains.domain.analytics.dns", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/edges": { "get": { "operationId": "get.domains.domain.analytics.edges", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/hostnames": { "get": { "operationId": "get.domains.domain.analytics.hostnames", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/origin": { "get": { "operationId": "get.domains.domain.analytics.origin", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/status-codes": { "get": { "operationId": "get.domains.domain.analytics.status-codes", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/summary": { "get": { "operationId": "get.domains.domain.analytics.summary", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/timeseries": { "get": { "operationId": "get.domains.domain.analytics.timeseries", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/analytics/top-urls": { "get": { "operationId": "get.domains.domain.analytics.top-urls", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/cache": { "get": { "operationId": "get.domains.domain.cache", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.domains.domain.cache", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/cache/development-mode": { "delete": { "operationId": "delete.domains.domain.cache.development-mode", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "post": { "operationId": "post.domains.domain.cache.development-mode", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/cache/purge": { "post": { "operationId": "post.domains.domain.cache.purge", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/cache/purges": { "get": { "operationId": "get.domains.domain.cache.purges", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/cache/purges/{purge}": { "get": { "operationId": "get.domains.domain.cache.purges.purge", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "purge", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/deploy": { "post": { "operationId": "post.domains.domain.deploy", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/deployment": { "get": { "operationId": "get.domains.domain.deployment", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/disable": { "post": { "operationId": "post.domains.domain.disable", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/deployment": { "get": { "operationId": "get.domains.domain.dns.deployment", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/dns/export": { "get": { "operationId": "get.domains.domain.dns.export", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/dns/import": { "post": { "operationId": "post.domains.domain.dns.import", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/reconcile": { "post": { "operationId": "post.domains.domain.dns.reconcile", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/records": { "get": { "operationId": "get.domains.domain.dns.records", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.domains.domain.dns.records", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/records/bulk": { "post": { "operationId": "post.domains.domain.dns.records.bulk", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/records/{record}": { "delete": { "operationId": "delete.domains.domain.dns.records.record", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "get": { "operationId": "get.domains.domain.dns.records.record", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.domains.domain.dns.records.record", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/records/{record}/geo": { "get": { "operationId": "get.domains.domain.dns.records.record.geo", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "put": { "operationId": "put.domains.domain.dns.records.record.geo", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/records/{record}/geo/preview": { "post": { "operationId": "post.domains.domain.dns.records.record.geo.preview", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/records/{record}/origin": { "get": { "operationId": "get.domains.domain.dns.records.record.origin", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "put": { "operationId": "put.domains.domain.dns.records.record.origin", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/dns/records/{record}/origin/health": { "get": { "operationId": "get.domains.domain.dns.records.record.origin.health", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/dns/records/{record}/origin/test": { "post": { "operationId": "post.domains.domain.dns.records.record.origin.test", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/logs/dns": { "get": { "operationId": "get.domains.domain.logs.dns", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/logs/errors": { "get": { "operationId": "get.domains.domain.logs.errors", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/logs/requests": { "get": { "operationId": "get.domains.domain.logs.requests", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/logs/security": { "get": { "operationId": "get.domains.domain.logs.security", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/proxy": { "get": { "operationId": "get.domains.domain.proxy", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.domains.domain.proxy", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/revisions": { "get": { "operationId": "get.domains.domain.revisions", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/rollback": { "post": { "operationId": "post.domains.domain.rollback", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/security": { "get": { "operationId": "get.domains.domain.security", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.domains.domain.security", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/security/ddos": { "get": { "operationId": "get.domains.domain.security.ddos", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.domains.domain.security.ddos", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/security/ddos/events": { "get": { "operationId": "get.domains.domain.security.ddos.events", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/security/ddos/status": { "get": { "operationId": "get.domains.domain.security.ddos.status", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/security/events": { "get": { "operationId": "get.domains.domain.security.events", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/security/rules": { "get": { "operationId": "get.domains.domain.security.rules", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.domains.domain.security.rules", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/security/rules/import": { "post": { "operationId": "post.domains.domain.security.rules.import", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/security/rules/{rule}": { "delete": { "operationId": "delete.domains.domain.security.rules.rule", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "rule", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } }, "patch": { "operationId": "patch.domains.domain.security.rules.rule", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "rule", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/status": { "get": { "operationId": "get.domains.domain.status", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/tls": { "get": { "operationId": "get.domains.domain.tls", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.domains.domain.tls", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/tls/custom-certificate": { "delete": { "operationId": "delete.domains.domain.tls.custom-certificate", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/tls/reissue": { "post": { "operationId": "post.domains.domain.tls.reissue", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/tls/renew": { "post": { "operationId": "post.domains.domain.tls.renew", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/tls/status": { "get": { "operationId": "get.domains.domain.tls.status", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/tls/upload": { "post": { "operationId": "post.domains.domain.tls.upload", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/usage": { "get": { "operationId": "get.domains.domain.usage", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/usage/export": { "get": { "operationId": "get.domains.domain.usage.export", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/domains/{domain}/verify-nameservers": { "post": { "operationId": "post.domains.domain.verify-nameservers", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/waf": { "get": { "operationId": "get.domains.domain.waf", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.domains.domain.waf", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/waf/exclusions": { "get": { "operationId": "get.domains.domain.waf.exclusions", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.domains.domain.waf.exclusions", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/domains/{domain}/waf/exclusions/{exclusion}": { "delete": { "operationId": "delete.domains.domain.waf.exclusions.exclusion", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "exclusion", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/health": { "get": { "operationId": "get.health", "tags": [ "Account" ], "responses": { "200": { "$ref": "#/components/responses/Success" } } } }, "/me": { "get": { "operationId": "get.me", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "patch": { "operationId": "patch.me", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/me/password": { "put": { "operationId": "put.me.password", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/me/tokens": { "get": { "operationId": "get.me.tokens", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } }, "post": { "operationId": "post.me.tokens", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 100, "additionalProperties": true } } } }, "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/me/tokens/{token}": { "delete": { "operationId": "delete.me.tokens.token", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "201": { "$ref": "#/components/responses/Created" }, "202": { "$ref": "#/components/responses/Accepted" }, "204": { "description": "The mutation completed with no response body." }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" }, "409": { "$ref": "#/components/responses/StableError" }, "422": { "$ref": "#/components/responses/ValidationError" } } } }, "/nameservers": { "get": { "operationId": "get.nameservers", "tags": [ "Account" ], "responses": { "200": { "$ref": "#/components/responses/Success" } } } }, "/operations/{operation}": { "get": { "operationId": "get.operations.operation", "tags": [ "Account" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "operation", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/Success" }, "401": { "$ref": "#/components/responses/StableError" }, "403": { "$ref": "#/components/responses/StableError" } } } }, "/ready": { "get": { "operationId": "get.ready", "tags": [ "Account" ], "responses": { "200": { "$ref": "#/components/responses/Success" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": false, "description": "UUID used to safely replay a mutation with the same method, path, and body.", "schema": { "type": "string", "format": "uuid" } }, "Cursor": { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor returned by the preceding page.", "schema": { "type": "string", "maxLength": 2048 } } }, "responses": { "Success": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope" } } } }, "Created": { "description": "A desired-state resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope" } } } }, "Accepted": { "description": "Asynchronous work was accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEnvelope" } } } }, "StableError": { "description": "A stable machine-readable API error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StableError" } } } }, "ValidationError": { "description": "The provided data is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } } }, "schemas": { "DataEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": true, "meta": { "type": "object", "additionalProperties": true }, "links": { "type": "object", "additionalProperties": true } }, "additionalProperties": false }, "StableError": { "type": "object", "required": [ "message", "code", "details" ], "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } }, "additionalProperties": false }, "ValidationError": { "type": "object", "required": [ "message", "code", "errors" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "validation_failed" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } } }