{
  "components": {
    "schemas": {
      "Error": {
        "properties": {
          "error": {
            "properties": {
              "code": {
                "type": "string"
              },
              "fields": {
                "additionalProperties": {
                  "type": "string"
                },
                "type": "object"
              },
              "message": {
                "type": "string"
              },
              "request_id": {
                "type": "string"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Deploy apps, databases and cron jobs. Authenticate with `Authorization: Bearer \u003ctoken\u003e` (session hgr_s_, personal hgr_p_ or project hgr_t_ tokens). Lists are wrapped as {\"data\": [...]}. Errors are {\"error\": {code, message, fields, request_id}}.",
    "title": "Hangar API",
    "version": "1.0.0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/ai/{slug}/*": {
      "delete": {
        "operationId": "deleteAiByslug*",
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The gateway: DELETE routes of the providers' own APIs",
        "tags": [
          "AI Gateway"
        ]
      },
      "get": {
        "operationId": "getAiByslug*",
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The gateway: /v1/models and GET routes of the providers' own APIs",
        "tags": [
          "AI Gateway"
        ]
      },
      "post": {
        "operationId": "postAiByslug*",
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The gateway (Authorization: Bearer hga_… or x-api-key): /v1/chat/completions, /v1/embeddings, /v1/completions in OpenAI format for every provider (\"model\": \"provider/model\", fallbacks on 408/429/5xx); /v1/models; /{provider}/… the provider's own API (/anthropic for Claude Code's ANTHROPIC_BASE_URL, /openai/v1 for OPENAI_BASE_URL)",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/git/*": {
      "get": {
        "operationId": "getGit*",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "git smart HTTP (clone, fetch): /git/\u003cworkspace\u003e/\u003crepo\u003e.git/info/refs, HEAD. Basic auth, any user name, a Hangar token as the password",
        "tags": [
          "Hangar Git"
        ]
      },
      "post": {
        "operationId": "postGit*",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "git smart HTTP (git-upload-pack, git-receive-pack = push). Same authentication; project tokens reach only their project's repositories",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/healthz": {
      "get": {
        "operationId": "getHealthz",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Liveness probe",
        "tags": [
          "System"
        ]
      }
    },
    "/readyz": {
      "get": {
        "operationId": "getReadyz",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Readiness probe (database reachable)",
        "tags": [
          "System"
        ]
      }
    },
    "/sdk/workflows.js": {
      "get": {
        "operationId": "getSdkWorkflowsJs",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The JavaScript/TypeScript SDK (Workflows endpoint, client for runs, events and Jobs)",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/sdk/workflows.py": {
      "get": {
        "operationId": "getSdkWorkflowsPy",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The Python SDK",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/admin/advisories": {
      "get": {
        "operationId": "getAdminAdvisories",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Known runtime vulnerabilities the services are checked against",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/advisories/{advisoryID}": {
      "delete": {
        "operationId": "deleteAdminAdvisoriesByadvisoryID",
        "parameters": [
          {
            "in": "path",
            "name": "advisoryID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove an advisory",
        "tags": [
          "Admin"
        ]
      },
      "put": {
        "operationId": "putAdminAdvisoriesByadvisoryID",
        "parameters": [
          {
            "in": "path",
            "name": "advisoryID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add or change an advisory (services are checked right away)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/alerts": {
      "get": {
        "operationId": "getAdminAlerts",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Platform alerts: Telegram bot and chat, email, minimum level",
        "tags": [
          "Admin"
        ]
      },
      "put": {
        "operationId": "putAdminAlerts",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the alert settings: {enabled, telegram_chat_id, min_level, email, telegram_token}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/alerts/chats": {
      "get": {
        "operationId": "getAdminAlertsChats",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Chats that wrote to the bot (to pick the chat id)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/alerts/history": {
      "get": {
        "operationId": "getAdminAlertsHistory",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Alerts firing now and resolved ones",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/alerts/test": {
      "post": {
        "operationId": "postAdminAlertsTest",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send a test alert",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/announcements": {
      "get": {
        "operationId": "getAdminAnnouncements",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Announcements",
        "tags": [
          "Admin"
        ]
      },
      "post": {
        "operationId": "postAdminAnnouncements",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create an announcement: {title, body, level, starts_at, ends_at, dismissible}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/announcements/{announcementID}": {
      "delete": {
        "operationId": "deleteAdminAnnouncementsByannouncementID",
        "parameters": [
          {
            "in": "path",
            "name": "announcementID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete an announcement",
        "tags": [
          "Admin"
        ]
      },
      "put": {
        "operationId": "putAdminAnnouncementsByannouncementID",
        "parameters": [
          {
            "in": "path",
            "name": "announcementID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change an announcement",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/audit": {
      "get": {
        "operationId": "getAdminAudit",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Audit log of the platform: ?q (action prefix, actor email or an IP address), admin, workspace_id, actor_id, from, to, before, limit, format=csv. Each entry names the token (token_name: \"session\" for a sign-in) and the device (user_agent)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/backups/offsite": {
      "get": {
        "operationId": "getAdminBackupsOffsite",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Off-site copies of the backups: settings and the last runs",
        "tags": [
          "Admin"
        ]
      },
      "put": {
        "operationId": "putAdminBackupsOffsite",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the off-site settings (the bucket is checked): {enabled, endpoint, region, bucket, prefix, access_key, secret_key, keep_days, hour_utc}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/backups/offsite/run": {
      "post": {
        "operationId": "postAdminBackupsOffsiteRun",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Copy the backups off site now",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/billing-settings": {
      "get": {
        "operationId": "getAdminBillingSettings",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Billing mode and the top-up instructions customers see",
        "tags": [
          "Admin"
        ]
      },
      "put": {
        "operationId": "putAdminBillingSettings",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the top-up instructions {topup_info}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/broadcasts": {
      "get": {
        "operationId": "getAdminBroadcasts",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Emails sent to many users",
        "tags": [
          "Admin"
        ]
      },
      "post": {
        "operationId": "postAdminBroadcasts",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send an email to an audience: {subject, body, audience, dry_run, test}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/catalog": {
      "get": {
        "operationId": "getAdminCatalog",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Template catalog sync status",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/catalog/sync": {
      "post": {
        "operationId": "postAdminCatalogSync",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Sync the template catalog now",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/currencies": {
      "get": {
        "operationId": "getAdminCurrencies",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Exchange rates, default currency, auto update",
        "tags": [
          "Admin"
        ]
      },
      "put": {
        "operationId": "putAdminCurrencies",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Set {default, rates: {RUB, KZT}, auto}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/currencies/refresh": {
      "post": {
        "operationId": "postAdminCurrenciesRefresh",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Take today's rates from the public feed",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/dependency-vulnerabilities": {
      "get": {
        "operationId": "getAdminDependencyVulnerabilities",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Vulnerable dependencies of every running service",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/grants": {
      "get": {
        "operationId": "getAdminGrants",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Startup grant applications",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/grants/{grantID}": {
      "patch": {
        "operationId": "patchAdminGrantsBygrantID",
        "parameters": [
          {
            "in": "path",
            "name": "grantID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Review an application: {status (new, reviewing, approved, rejected), note}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/helpers": {
      "post": {
        "operationId": "postAdminHelpers",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a helper server to the primary location (same body as a location's server): services without a volume spread across the primary and its helpers; databases and other services with a volume stay on the primary server. Removal moves the services back first",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/hosting-plans": {
      "get": {
        "operationId": "getAdminHostingPlans",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Hosting plans, hidden ones too",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/hosting-plans/{code}": {
      "put": {
        "operationId": "putAdminHostingPlansBycode",
        "parameters": [
          {
            "in": "path",
            "name": "code",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename a hosting plan or set its price {name, price_amount, price_currency, note, public, sort}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/invoices/{invoiceID}/status": {
      "post": {
        "operationId": "postAdminInvoicesByinvoiceIDStatus",
        "parameters": [
          {
            "in": "path",
            "name": "invoiceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Mark an invoice paid, void or uncollectible",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/jobs": {
      "get": {
        "operationId": "getAdminJobs",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Background jobs by ?state= (failed, stuck, running, queued, scheduled, cancelled) and ?kind=",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/jobs/{jobID}/cancel": {
      "post": {
        "operationId": "postAdminJobsByjobIDCancel",
        "parameters": [
          {
            "in": "path",
            "name": "jobID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Cancel a queued or failed job",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/jobs/{jobID}/retry": {
      "post": {
        "operationId": "postAdminJobsByjobIDRetry",
        "parameters": [
          {
            "in": "path",
            "name": "jobID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Put a failed, cancelled or stuck job back in the queue",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/keys": {
      "get": {
        "operationId": "getAdminKeys",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Encryption key usage",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/keys/rotate": {
      "post": {
        "operationId": "postAdminKeysRotate",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Re-encrypt secrets with the active key",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/mail-domains/{mailDomainID}/block": {
      "post": {
        "operationId": "postAdminMailDomainsBymailDomainIDBlock",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Stop sending for a domain: {reason}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/mail-domains/{mailDomainID}/unblock": {
      "post": {
        "operationId": "postAdminMailDomainsBymailDomainIDUnblock",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Resume sending for a domain",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/nodes/{nodeID}": {
      "delete": {
        "operationId": "deleteAdminNodesBynodeID",
        "parameters": [
          {
            "in": "path",
            "name": "nodeID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a server from its location and the cluster",
        "tags": [
          "Admin"
        ]
      },
      "get": {
        "operationId": "getAdminNodesBynodeID",
        "parameters": [
          {
            "in": "path",
            "name": "nodeID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A server's status and installation log",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/nodes/{nodeID}/retry": {
      "post": {
        "operationId": "postAdminNodesBynodeIDRetry",
        "parameters": [
          {
            "in": "path",
            "name": "nodeID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Run the installation again",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/overview": {
      "get": {
        "operationId": "getAdminOverview",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The platform at a glance: counts, servers (Kubernetes and host reports), what needs attention, 30-day trends",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/plans": {
      "get": {
        "operationId": "getAdminPlans",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "All plans, including private ones",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/plans/{code}": {
      "put": {
        "operationId": "putAdminPlansBycode",
        "parameters": [
          {
            "in": "path",
            "name": "code",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create or update a plan",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/protection": {
      "get": {
        "operationId": "getAdminProtection",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Protection of the platform for the last 24 hours: refused attempts by kind and hour, the busiest addresses, bans (active and ended within a week), SSH of each server, the ban rules and the sign-up check settings",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/protection/bans": {
      "post": {
        "operationId": "postAdminProtectionBans",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Ban an address or a network: {cidr, reason, hours (0: until lifted)}. Never the platform's networks and servers or an address an admin worked from lately (owner admins)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/protection/bans/{banID}": {
      "delete": {
        "operationId": "deleteAdminProtectionBansBybanID",
        "parameters": [
          {
            "in": "path",
            "name": "banID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Lift a ban (owner admins)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/protection/events": {
      "get": {
        "operationId": "getAdminProtectionEvents",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Refused attempts (failed sign-ins, made-up tokens, access denied, blocked sign-ups, banned addresses): ?kind, ip, q (email, path or device), before, limit",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/protection/settings": {
      "put": {
        "operationId": "putAdminProtectionSettings",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the protection: {auto_ban, signup_pow: off/soft/required, signup_per_ip_day} (owner admins)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/regions": {
      "get": {
        "operationId": "getAdminRegions",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Locations with their servers, DNS check and the platform SSH key",
        "tags": [
          "Admin"
        ]
      },
      "post": {
        "operationId": "postAdminRegions",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a location",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/regions/{code}": {
      "delete": {
        "operationId": "deleteAdminRegionsBycode",
        "parameters": [
          {
            "in": "path",
            "name": "code",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete an empty location",
        "tags": [
          "Admin"
        ]
      },
      "patch": {
        "operationId": "patchAdminRegionsBycode",
        "parameters": [
          {
            "in": "path",
            "name": "code",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename, change the country, or disable a location",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/regions/{code}/nodes": {
      "post": {
        "operationId": "postAdminRegionsBycodeNodes",
        "parameters": [
          {
            "in": "path",
            "name": "code",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a server by SSH credentials; it is set up and joined in the background",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/security/feeds": {
      "get": {
        "operationId": "getAdminSecurityFeeds",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The public vulnerability feeds followed daily (PHP, Node.js, Python, Ruby, Go, nginx, Caddy) and their sync state",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/security/feeds/sync": {
      "post": {
        "operationId": "postAdminSecurityFeedsSync",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Sync the vulnerability feeds now (in the background)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/security/scan": {
      "post": {
        "operationId": "postAdminSecurityScan",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Check every running service now",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/services": {
      "get": {
        "operationId": "getAdminServices",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Every service of the platform: ?q= and ?filter=crashing, failed, vulnerable, suspended or node:NAME",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/services/{serviceID}/action": {
      "post": {
        "operationId": "postAdminServicesByserviceIDAction",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Restart, stop or redeploy a service: {environment_id, action}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/settings": {
      "get": {
        "operationId": "getAdminSettings",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Platform settings: sign-up, maintenance, vulnerability feeds, 2FA for admins, modules",
        "tags": [
          "Admin"
        ]
      },
      "put": {
        "operationId": "putAdminSettings",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the platform settings (owner admins)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/status": {
      "get": {
        "operationId": "getAdminStatus",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Status page: the components and the latest 100 incidents and maintenance windows",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/status/incidents": {
      "post": {
        "operationId": "postAdminStatusIncidents",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Post an incident {kind: incident, title, impact (minor, major, critical), components[], body} or maintenance {kind: maintenance, title, components[], body, starts_at, ends_at}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/status/incidents/{incidentID}": {
      "delete": {
        "operationId": "deleteAdminStatusIncidentsByincidentID",
        "parameters": [
          {
            "in": "path",
            "name": "incidentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete an incident or maintenance window",
        "tags": [
          "Admin"
        ]
      },
      "patch": {
        "operationId": "patchAdminStatusIncidentsByincidentID",
        "parameters": [
          {
            "in": "path",
            "name": "incidentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Edit an incident: {title?, impact?, components?, starts_at?, ends_at?}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/status/incidents/{incidentID}/updates": {
      "post": {
        "operationId": "postAdminStatusIncidentsByincidentIDUpdates",
        "parameters": [
          {
            "in": "path",
            "name": "incidentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add an update and move the incident: {status (investigating, identified, monitoring, resolved; maintenance: scheduled, in_progress, completed), body}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/test-email": {
      "post": {
        "operationId": "postAdminTestEmail",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send a test email to your own address: checks the platform email",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/users": {
      "get": {
        "operationId": "getAdminUsers",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Find a user by email",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/users/{userID}": {
      "get": {
        "operationId": "getAdminUsersByuserID",
        "parameters": [
          {
            "in": "path",
            "name": "userID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A user with workspaces, sessions and actions",
        "tags": [
          "Admin"
        ]
      },
      "patch": {
        "operationId": "patchAdminUsersByuserID",
        "parameters": [
          {
            "in": "path",
            "name": "userID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change email, name, admin rights and role, email verification; reset two-factor sign-in",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/users/{userID}/ban": {
      "post": {
        "operationId": "postAdminUsersByuserIDBan",
        "parameters": [
          {
            "in": "path",
            "name": "userID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Ban a user",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/users/{userID}/delete": {
      "post": {
        "operationId": "postAdminUsersByuserIDDelete",
        "parameters": [
          {
            "in": "path",
            "name": "userID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete an account: {confirm: email}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/users/{userID}/sessions/revoke": {
      "post": {
        "operationId": "postAdminUsersByuserIDSessionsRevoke",
        "parameters": [
          {
            "in": "path",
            "name": "userID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Sign a user out everywhere: {personal} also revokes API tokens",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/users/{userID}/unban": {
      "post": {
        "operationId": "postAdminUsersByuserIDUnban",
        "parameters": [
          {
            "in": "path",
            "name": "userID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Unban a user",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/vulnerabilities": {
      "get": {
        "operationId": "getAdminVulnerabilities",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Open vulnerability alerts of every project",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces": {
      "get": {
        "operationId": "getAdminWorkspaces",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Workspaces by usage (?q=)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces/{workspaceID}": {
      "get": {
        "operationId": "getAdminWorkspacesByworkspaceID",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A workspace from the inside: projects and services, members, money, history",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces/{workspaceID}/balance": {
      "get": {
        "operationId": "getAdminWorkspacesByworkspaceIDBalance",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A workspace's balance ledger",
        "tags": [
          "Admin"
        ]
      },
      "post": {
        "operationId": "postAdminWorkspacesByworkspaceIDBalance",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Top up or correct the balance (amount_cents, kind topup/refund/adjustment, reference, note)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces/{workspaceID}/credits": {
      "post": {
        "operationId": "postAdminWorkspacesByworkspaceIDCredits",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Grant credit",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces/{workspaceID}/delete": {
      "post": {
        "operationId": "postAdminWorkspacesByworkspaceIDDelete",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a workspace: {confirm: slug}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces/{workspaceID}/plan": {
      "put": {
        "operationId": "putAdminWorkspacesByworkspaceIDPlan",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Force a plan",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces/{workspaceID}/suspend": {
      "post": {
        "operationId": "postAdminWorkspacesByworkspaceIDSuspend",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Suspend a workspace",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces/{workspaceID}/transfer": {
      "post": {
        "operationId": "postAdminWorkspacesByworkspaceIDTransfer",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Make another user the owner: {email}",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/admin/workspaces/{workspaceID}/unsuspend": {
      "post": {
        "operationId": "postAdminWorkspacesByworkspaceIDUnsuspend",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Lift a suspension",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/agentics/agent/hello": {
      "post": {
        "operationId": "postAgenticsAgentHello",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The agent runner reports its state and gets its settings and repository credentials (Bearer hag_ agent token)",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/agent/next": {
      "post": {
        "operationId": "postAgenticsAgentNext",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The runner waits for its next task (long poll)",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/agent/tasks/{taskID}/finish": {
      "post": {
        "operationId": "postAgenticsAgentTasksBytaskIDFinish",
        "parameters": [
          {
            "in": "path",
            "name": "taskID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The runner reports the result: {status, branch, commit, summary, output, diff, diffstat, error}",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/agent/tasks/{taskID}/log": {
      "post": {
        "operationId": "postAgenticsAgentTasksBytaskIDLog",
        "parameters": [
          {
            "in": "path",
            "name": "taskID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The runner appends task output; the answer says whether the task was cancelled",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/agents/{agentID}": {
      "delete": {
        "operationId": "deleteAgenticsAgentsByagentID",
        "parameters": [
          {
            "in": "path",
            "name": "agentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove an agent and its home volume",
        "tags": [
          "Agentics"
        ]
      },
      "patch": {
        "operationId": "patchAgenticsAgentsByagentID",
        "parameters": [
          {
            "in": "path",
            "name": "agentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change an agent: {model, role, auth_mode}",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/agents/{agentID}/restart": {
      "post": {
        "operationId": "postAgenticsAgentsByagentIDRestart",
        "parameters": [
          {
            "in": "path",
            "name": "agentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Restart the agent's container",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/agents/{agentID}/terminal": {
      "get": {
        "description": "WebSocket endpoint (Upgrade). See docs/API.md for the framing.",
        "operationId": "getAgenticsAgentsByagentIDTerminal",
        "parameters": [
          {
            "in": "path",
            "name": "agentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Terminal in the agent's container (sign the CLI in, look around); same protocol as service exec",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/tasks/{taskID}": {
      "get": {
        "operationId": "getAgenticsTasksBytaskID",
        "parameters": [
          {
            "in": "path",
            "name": "taskID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A task with its result: branch, commit, summary, diff",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/tasks/{taskID}/logs": {
      "get": {
        "operationId": "getAgenticsTasksBytaskIDLogs",
        "parameters": [
          {
            "in": "path",
            "name": "taskID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Output of the task (?after=\u003cid\u003e for new lines)",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/tasks/{taskID}/{action}": {
      "post": {
        "operationId": "postAgenticsTasksBytaskIDByaction",
        "parameters": [
          {
            "in": "path",
            "name": "taskID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "action",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "cancel, retry or approve (accept a branch without merging)",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/teams/{teamID}": {
      "delete": {
        "operationId": "deleteAgenticsTeamsByteamID",
        "parameters": [
          {
            "in": "path",
            "name": "teamID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete the team, its agents and tasks",
        "tags": [
          "Agentics"
        ]
      },
      "get": {
        "operationId": "getAgenticsTeamsByteamID",
        "parameters": [
          {
            "in": "path",
            "name": "teamID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The team: agents (online, busy, signed in, container state), API key names, task counts",
        "tags": [
          "Agentics"
        ]
      },
      "patch": {
        "operationId": "patchAgenticsTeamsByteamID",
        "parameters": [
          {
            "in": "path",
            "name": "teamID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename or change the base branch: {name, base_branch}",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/teams/{teamID}/agents": {
      "post": {
        "operationId": "postAgenticsTeamsByteamIDAgents",
        "parameters": [
          {
            "in": "path",
            "name": "teamID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add an agent: {name, provider (claude or codex), auth_mode (subscription or api_key), model, role (lead or worker)}",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/teams/{teamID}/merge": {
      "post": {
        "operationId": "postAgenticsTeamsByteamIDMerge",
        "parameters": [
          {
            "in": "path",
            "name": "teamID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Merge the branches of reviewed tasks into the base branch: {task_ids}",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/teams/{teamID}/secrets": {
      "put": {
        "operationId": "putAgenticsTeamsByteamIDSecrets",
        "parameters": [
          {
            "in": "path",
            "name": "teamID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Store an API key for agents in api_key mode: {name (ANTHROPIC_API_KEY or OPENAI_API_KEY), value}; an empty value removes it",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/agentics/teams/{teamID}/tasks": {
      "get": {
        "operationId": "getAgenticsTeamsByteamIDTasks",
        "parameters": [
          {
            "in": "path",
            "name": "teamID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Tasks of the team, newest first",
        "tags": [
          "Agentics"
        ]
      },
      "post": {
        "operationId": "postAgenticsTeamsByteamIDTasks",
        "parameters": [
          {
            "in": "path",
            "name": "teamID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a task {title, prompt, agent_id} or a goal for the lead to plan {kind: plan, prompt}",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/ai-gateways/providers": {
      "get": {
        "operationId": "getAiGatewaysProviders",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Providers the gateway routes to (OpenAI, Anthropic, Google, Mistral, Groq, DeepSeek, xAI, OpenRouter, Together, custom)",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/v1/ai-gateways/{gatewayID}": {
      "delete": {
        "operationId": "deleteAiGatewaysBygatewayID",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a gateway with its keys, tokens and logs",
        "tags": [
          "AI Gateway"
        ]
      },
      "get": {
        "operationId": "getAiGatewaysBygatewayID",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A gateway",
        "tags": [
          "AI Gateway"
        ]
      },
      "patch": {
        "operationId": "patchAiGatewaysBygatewayID",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change a gateway",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/v1/ai-gateways/{gatewayID}/keys/{provider}": {
      "delete": {
        "operationId": "deleteAiGatewaysBygatewayIDKeysByprovider",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "provider",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a provider key",
        "tags": [
          "AI Gateway"
        ]
      },
      "put": {
        "operationId": "putAiGatewaysBygatewayIDKeysByprovider",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "provider",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Store a provider API key: {key, base_url? (custom: https://…/v1)}; kept encrypted, never shown again",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/v1/ai-gateways/{gatewayID}/logs": {
      "get": {
        "operationId": "getAiGatewaysBygatewayIDLogs",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Requests, newest first: ?status=ok",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/v1/ai-gateways/{gatewayID}/stats": {
      "get": {
        "operationId": "getAiGatewaysBygatewayIDStats",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "?hours=24: requests, errors, fallbacks, tokens, cost, p50/p95 latency, by hour and by model",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/v1/ai-gateways/{gatewayID}/tokens": {
      "get": {
        "operationId": "getAiGatewaysBygatewayIDTokens",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Gateway tokens (hga_)",
        "tags": [
          "AI Gateway"
        ]
      },
      "post": {
        "operationId": "postAiGatewaysBygatewayIDTokens",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a token: {name} → {token} once",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/v1/ai-gateways/{gatewayID}/tokens/{tokenID}": {
      "delete": {
        "operationId": "deleteAiGatewaysBygatewayIDTokensBytokenID",
        "parameters": [
          {
            "in": "path",
            "name": "gatewayID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "tokenID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Revoke a token",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/v1/announcements": {
      "get": {
        "operationId": "getAnnouncements",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Announcements of the platform shown now (maintenance first)",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/app-builds/{buildID}": {
      "delete": {
        "operationId": "deleteAppBuildsBybuildID",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a build from Hangar (not from the store)",
        "tags": [
          "Mobile releases"
        ]
      },
      "get": {
        "operationId": "getAppBuildsBybuildID",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Build with artifact info, status (uploaded, sending, processing, ready, submitted, in_review, approved, released, rejected, failed), store status, review findings and the event timeline",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/app-builds/{buildID}/download": {
      "get": {
        "operationId": "getAppBuildsBybuildIDDownload",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Download the build's .ipa, .aab or .apk",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/app-builds/{buildID}/link": {
      "post": {
        "operationId": "postAppBuildsBybuildIDLink",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A download link for testers (no sign-in, 7 days): {url, expires_at}; an .apk installs from it on the phone",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/app-builds/{buildID}/notes": {
      "put": {
        "operationId": "putAppBuildsBybuildIDNotes",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Save release notes {notes: {lang: text}}",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/app-builds/{buildID}/notes/generate": {
      "post": {
        "operationId": "postAppBuildsBybuildIDNotesGenerate",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "AI-written release notes from the build's commits: {hint?, languages?} → {notes} (not saved)",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/app-builds/{buildID}/review": {
      "post": {
        "operationId": "postAppBuildsBybuildIDReview",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Run the AI pre-check again (background; ai_review.ai_status = running until done)",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/app-builds/{buildID}/send": {
      "post": {
        "operationId": "postAppBuildsBybuildIDSend",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send to the store: {target: testflight or review (iOS) / a Play track (Android), notes?}; runs in the background, statuses are followed automatically",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/apps/{appID}": {
      "delete": {
        "operationId": "deleteAppsByappID",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete the app and its stored builds (admin)",
        "tags": [
          "Mobile releases"
        ]
      },
      "get": {
        "operationId": "getAppsByappID",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "App with settings (languages, export compliance, TestFlight groups, release type, Play track, rollout, auto-send, AI check) and store_error if the store link is broken",
        "tags": [
          "Mobile releases"
        ]
      },
      "patch": {
        "operationId": "patchAppsByappID",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Update name, integration_id, settings; {recheck: true} looks the app up in the store again",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/apps/{appID}/builds": {
      "get": {
        "operationId": "getAppsByappIDBuilds",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Uploaded builds, newest first",
        "tags": [
          "Mobile releases"
        ]
      },
      "post": {
        "operationId": "postAppsByappIDBuilds",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Upload a build (multipart/form-data: optional \"meta\" JSON {notes: {lang: text}, commit_sha, commits: [messages], send: bool, target: testflight/review/track} then \"file\" .ipa or .aab). Version and build number are read from the file and checked against Hangar and the store; rule checks run, the AI pre-check and auto-send follow if enabled",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/apps/{appID}/ci": {
      "get": {
        "operationId": "getAppsByappIDCi",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Build settings (repository, branch, folder, framework, scheme, Gradle module, flavor, auto-build on push), build variable names, ready and what is missing",
        "tags": [
          "Mobile CI"
        ]
      },
      "put": {
        "operationId": "putAppsByappIDCi",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Save build settings; env {NAME: value, or null to remove} sets or removes encrypted build variables",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/apps/{appID}/rejection": {
      "post": {
        "operationId": "postAppsByappIDRejection",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "AI analysis of a store rejection: {text, build_id?} → summary, reasons with fixes, needs_new_build, a reply for the reviewer",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/apps/{appID}/runs": {
      "get": {
        "operationId": "getAppsByappIDRuns",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Builds from source, newest first",
        "tags": [
          "Mobile CI"
        ]
      },
      "post": {
        "operationId": "postAppsByappIDRuns",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Build now: {branch?, commit?, send?, target?}. iOS waits for a Mac of the workspace, Android builds in the cloud; the signed result becomes a build of the app and goes to the store when send",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/apps/{appID}/signing": {
      "get": {
        "operationId": "getAppsByappIDSigning",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Signing material of the app without secrets: iOS certificates (name, serial, expiry, team), the Android keystore (fingerprints, expiry)",
        "tags": [
          "Mobile CI"
        ]
      },
      "post": {
        "operationId": "postAppsByappIDSigning",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Upload {file (base64), password, kind?, alias?, key_password?}: an iOS .p12 certificate or an Android keystore (.jks, .keystore, .p12)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/apps/{appID}/signing/android/generate": {
      "post": {
        "operationId": "postAppsByappIDSigningAndroidGenerate",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Generate an upload keystore (RSA 4096, 30 years); {replace: true} replaces the existing one",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/apps/{appID}/signing/android/keystore": {
      "get": {
        "operationId": "getAppsByappIDSigningAndroidKeystore",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Download the keystore with its passwords (admins; keep a copy)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/apps/{appID}/signing/ios/create": {
      "post": {
        "operationId": "postAppsByappIDSigningIosCreate",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create (or renew) the Apple Development and Apple Distribution certificates through the app's App Store Connect key",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/apps/{appID}/signing/{kind}": {
      "delete": {
        "operationId": "deleteAppsByappIDSigningBykind",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "kind",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove ios_development, ios_distribution or android_keystore (certificates Hangar made are revoked at Apple)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/apps/{appID}/store": {
      "get": {
        "operationId": "getAppsByappIDStore",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Live store state: TestFlight groups and latest build number (iOS), tracks with releases and max versionCode (Android)",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/auth/challenge": {
      "get": {
        "operationId": "getAuthChallenge",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The sign-up check: {challenge, bits, expires_at, mode}. Find a nonce (a decimal number as text) whose SHA-256 of \"challenge:nonce\" starts with \"bits\" zero bits; each challenge works once, for 10 minutes",
        "tags": [
          "Auth"
        ]
      }
    },
    "/v1/auth/login": {
      "post": {
        "operationId": "postAuthLogin",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Log in with email and password; returns a session token, or {mfa_required, mfa_token} when the account has two-factor sign-in. The account is emailed a sign-in alert (time, IP, device)",
        "tags": [
          "Auth"
        ]
      }
    },
    "/v1/auth/login/mfa": {
      "post": {
        "operationId": "postAuthLoginMfa",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Finish a two-factor sign-in: {mfa_token, code} (authenticator code or a recovery code)",
        "tags": [
          "Auth"
        ]
      }
    },
    "/v1/auth/logout": {
      "post": {
        "operationId": "postAuthLogout",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Revoke the token used for this request",
        "tags": [
          "Auth"
        ]
      }
    },
    "/v1/auth/signup": {
      "post": {
        "operationId": "postAuthSignup",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Create an account (and a personal workspace); returns a session token. Send the solved check as {pow: {challenge, nonce}} (GET /v1/auth/challenge); without it an address gets one account a day, or none when the platform requires the check. Disposable mailboxes are refused",
        "tags": [
          "Auth"
        ]
      }
    },
    "/v1/auth/verify-email": {
      "get": {
        "operationId": "getAuthVerifyEmail",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Confirm an email address (link from the email)",
        "tags": [
          "Auth"
        ]
      },
      "post": {
        "operationId": "postAuthVerifyEmail",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Confirm an email address with {token}",
        "tags": [
          "Auth"
        ]
      }
    },
    "/v1/backups/{backupID}": {
      "delete": {
        "operationId": "deleteBackupsBybackupID",
        "parameters": [
          {
            "in": "path",
            "name": "backupID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a backup",
        "tags": [
          "Data"
        ]
      }
    },
    "/v1/backups/{backupID}/restore": {
      "post": {
        "operationId": "postBackupsBybackupIDRestore",
        "parameters": [
          {
            "in": "path",
            "name": "backupID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Restore a backup into its volume",
        "tags": [
          "Data"
        ]
      }
    },
    "/v1/billing/return": {
      "get": {
        "operationId": "getBillingReturn",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Landing page after adding a card",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/billing/stripe/webhook": {
      "post": {
        "operationId": "postBillingStripeWebhook",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Stripe webhook receiver (signed)",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/buckets/{bucketID}": {
      "delete": {
        "operationId": "deleteBucketsBybucketID",
        "parameters": [
          {
            "in": "path",
            "name": "bucketID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a bucket and its objects",
        "tags": [
          "Data"
        ]
      }
    },
    "/v1/builders/{builderID}": {
      "delete": {
        "operationId": "deleteBuildersBybuilderID",
        "parameters": [
          {
            "in": "path",
            "name": "builderID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Disconnect a Mac (its running build fails)",
        "tags": [
          "Mobile CI"
        ]
      },
      "patch": {
        "operationId": "patchBuildersBybuilderID",
        "parameters": [
          {
            "in": "path",
            "name": "builderID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename {name} or issue a new token {rotate_token: true}",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/cdn-zones/{zoneID}": {
      "delete": {
        "operationId": "deleteCdnZonesByzoneID",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a zone",
        "tags": [
          "CDN"
        ]
      },
      "get": {
        "operationId": "getCdnZonesByzoneID",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A zone with its domains and recent purges",
        "tags": [
          "CDN"
        ]
      },
      "patch": {
        "operationId": "patchCdnZonesByzoneID",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the origin or cache settings (default_ttl, respect_origin, ignore_query, cache_static, rules, disabled)",
        "tags": [
          "CDN"
        ]
      }
    },
    "/v1/cdn-zones/{zoneID}/domains": {
      "post": {
        "operationId": "postCdnZonesByzoneIDDomains",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a custom domain (TXT + CNAME records to create)",
        "tags": [
          "CDN"
        ]
      }
    },
    "/v1/cdn-zones/{zoneID}/domains/{domainID}": {
      "delete": {
        "operationId": "deleteCdnZonesByzoneIDDomainsBydomainID",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "domainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a custom domain",
        "tags": [
          "CDN"
        ]
      }
    },
    "/v1/cdn-zones/{zoneID}/domains/{domainID}/check": {
      "post": {
        "operationId": "postCdnZonesByzoneIDDomainsBydomainIDCheck",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "domainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Check a domain's DNS now",
        "tags": [
          "CDN"
        ]
      }
    },
    "/v1/cdn-zones/{zoneID}/purge": {
      "post": {
        "operationId": "postCdnZonesByzoneIDPurge",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Purge the cache: {all: true} or {paths: [\"/static/\"]}",
        "tags": [
          "CDN"
        ]
      }
    },
    "/v1/cdn-zones/{zoneID}/stats": {
      "get": {
        "operationId": "getCdnZonesByzoneIDStats",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Hourly requests, hits, misses, traffic (range 24h, 7d, 30d)",
        "tags": [
          "CDN"
        ]
      }
    },
    "/v1/cdnedge/config": {
      "get": {
        "operationId": "getCdnedgeConfig",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The zones for the CDN edges (edge token; If-None-Match)",
        "tags": [
          "CDN edge"
        ]
      }
    },
    "/v1/cdnedge/stats": {
      "post": {
        "operationId": "postCdnedgeStats",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "An edge's counters and cache use",
        "tags": [
          "CDN edge"
        ]
      }
    },
    "/v1/cdnedge/wake": {
      "post": {
        "operationId": "postCdnedgeWake",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Wake a zone's sleeping service origin",
        "tags": [
          "CDN edge"
        ]
      }
    },
    "/v1/ci-runs/{runID}": {
      "get": {
        "operationId": "getCiRunsByrunID",
        "parameters": [
          {
            "in": "path",
            "name": "runID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A build: status (queued, running, success, failed, cancelled), step, source commit, build number, result build_id, error",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/ci-runs/{runID}/cancel": {
      "post": {
        "operationId": "postCiRunsByrunIDCancel",
        "parameters": [
          {
            "in": "path",
            "name": "runID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Stop a build",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/ci-runs/{runID}/logs": {
      "get": {
        "operationId": "getCiRunsByrunIDLogs",
        "parameters": [
          {
            "in": "path",
            "name": "runID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Build log lines after ?after=\u003cid\u003e, with the run's status and step (poll while running)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/cli": {
      "get": {
        "operationId": "getCli",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Version, platforms, sizes and SHA-256 of the downloadable hangar CLI",
        "tags": [
          "CLI"
        ]
      }
    },
    "/v1/cli/install.ps1": {
      "get": {
        "operationId": "getCliInstallPs1",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Installer script for Windows PowerShell (pipe it to iex)",
        "tags": [
          "CLI"
        ]
      }
    },
    "/v1/cli/install.sh": {
      "get": {
        "operationId": "getCliInstallSh",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Installer script for macOS and Linux (pipe it to sh)",
        "tags": [
          "CLI"
        ]
      }
    },
    "/v1/cli/{file}": {
      "get": {
        "operationId": "getCliByfile",
        "parameters": [
          {
            "in": "path",
            "name": "file",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Download a CLI binary; append .sha256 for its checksum",
        "tags": [
          "CLI"
        ]
      }
    },
    "/v1/currencies": {
      "get": {
        "operationId": "getCurrencies",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Exchange rates per 1 USD and the currency list; ?workspace= adds that workspace's display currency",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/dependency-vulnerabilities/{vulnID}/ignore": {
      "post": {
        "operationId": "postDependencyVulnerabilitiesByvulnIDIgnore",
        "parameters": [
          {
            "in": "path",
            "name": "vulnID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Hide a vulnerable dependency",
        "tags": [
          "Security"
        ]
      }
    },
    "/v1/dependency-vulnerabilities/{vulnID}/unignore": {
      "post": {
        "operationId": "postDependencyVulnerabilitiesByvulnIDUnignore",
        "parameters": [
          {
            "in": "path",
            "name": "vulnID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Show it again",
        "tags": [
          "Security"
        ]
      }
    },
    "/v1/deployments/{deploymentID}": {
      "get": {
        "operationId": "getDeploymentsBydeploymentID",
        "parameters": [
          {
            "in": "path",
            "name": "deploymentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Get a deployment",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/deployments/{deploymentID}/cancel": {
      "post": {
        "operationId": "postDeploymentsBydeploymentIDCancel",
        "parameters": [
          {
            "in": "path",
            "name": "deploymentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Cancel an in-progress deployment",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/deployments/{deploymentID}/logs": {
      "get": {
        "description": "Add follow=true or Accept: text/event-stream to stream server-sent events.",
        "operationId": "getDeploymentsBydeploymentIDLogs",
        "parameters": [
          {
            "in": "path",
            "name": "deploymentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Build and deploy logs (follow streams until done)",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/deployments/{deploymentID}/redeploy": {
      "post": {
        "operationId": "postDeploymentsBydeploymentIDRedeploy",
        "parameters": [
          {
            "in": "path",
            "name": "deploymentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Redeploy the image with current variables",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/deployments/{deploymentID}/rollback": {
      "post": {
        "operationId": "postDeploymentsBydeploymentIDRollback",
        "parameters": [
          {
            "in": "path",
            "name": "deploymentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Restore this deployment exactly",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/dns": {
      "get": {
        "operationId": "getDns",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Hangar DNS: whether it is enabled and the name servers to set at the registrar",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-changes/{changeID}/revert": {
      "post": {
        "operationId": "postDnsChangesBychangeIDRevert",
        "parameters": [
          {
            "in": "path",
            "name": "changeID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Undo one change",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-records/{recordID}": {
      "delete": {
        "operationId": "deleteDnsRecordsByrecordID",
        "parameters": [
          {
            "in": "path",
            "name": "recordID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a record",
        "tags": [
          "DNS"
        ]
      },
      "patch": {
        "operationId": "patchDnsRecordsByrecordID",
        "parameters": [
          {
            "in": "path",
            "name": "recordID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Replace a record (same fields as create)",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-templates": {
      "get": {
        "operationId": "getDnsTemplates",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Record templates: Google Workspace, Yandex 360, Microsoft 365, Vercel, GitHub Pages…",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}": {
      "delete": {
        "operationId": "deleteDnsZonesByzoneID",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a domain with all its records (the name servers stop answering for it)",
        "tags": [
          "DNS"
        ]
      },
      "get": {
        "operationId": "getDnsZonesByzoneID",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A zone",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}/changes": {
      "get": {
        "operationId": "getDnsZonesByzoneIDChanges",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "History of the zone's record changes (?before= id)",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}/check": {
      "post": {
        "operationId": "postDnsZonesByzoneIDCheck",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Check the delegation now (status becomes active once the registry points at Hangar's name servers)",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}/dnssec": {
      "get": {
        "operationId": "getDnsZonesByzoneIDDnssec",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "DNSSEC state: DS record for the registrar, whether the registry publishes it",
        "tags": [
          "DNS"
        ]
      },
      "put": {
        "operationId": "putDnsZonesByzoneIDDnssec",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Turn DNSSEC on or off: {enabled, force}",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}/dnssec/check": {
      "post": {
        "operationId": "postDnsZonesByzoneIDDnssecCheck",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Check the DS at the registry now",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}/import": {
      "post": {
        "operationId": "postDnsZonesByzoneIDImport",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Copy common records from the domain's current public DNS; returns {imported}",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}/records": {
      "get": {
        "operationId": "getDnsZonesByzoneIDRecords",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The zone's records",
        "tags": [
          "DNS"
        ]
      },
      "post": {
        "operationId": "postDnsZonesByzoneIDRecords",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a record: {name ('@', 'www', '*.dev'), type A/AAAA/CNAME/MX/TXT/NS/SRV/CAA, content, ttl (60–86400, 0 = auto 300), priority, weight, port, comment}",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}/stats": {
      "get": {
        "operationId": "getDnsZonesByzoneIDStats",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Hourly queries and NXDOMAIN answers (range 24h, 7d, 30d)",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dns-zones/{zoneID}/templates/{code}": {
      "post": {
        "operationId": "postDnsZonesByzoneIDTemplatesBycode",
        "parameters": [
          {
            "in": "path",
            "name": "zoneID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "code",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a template's records: {params, replace}",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/dnsedge/config": {
      "get": {
        "operationId": "getDnsedgeConfig",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Every zone for the name servers (servers' token; ?since=\u003cversion\u003e, 204 when unchanged)",
        "tags": [
          "DNS servers"
        ]
      }
    },
    "/v1/dnsedge/stats": {
      "post": {
        "operationId": "postDnsedgeStats",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A name server's query counters per zone",
        "tags": [
          "DNS servers"
        ]
      }
    },
    "/v1/domains/{domainID}": {
      "delete": {
        "operationId": "deleteDomainsBydomainID",
        "parameters": [
          {
            "in": "path",
            "name": "domainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a domain",
        "tags": [
          "Networking"
        ]
      },
      "get": {
        "operationId": "getDomainsBydomainID",
        "parameters": [
          {
            "in": "path",
            "name": "domainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Get a domain (with required DNS records)",
        "tags": [
          "Networking"
        ]
      },
      "patch": {
        "operationId": "patchDomainsBydomainID",
        "parameters": [
          {
            "in": "path",
            "name": "domainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the target port",
        "tags": [
          "Networking"
        ]
      }
    },
    "/v1/domains/{domainID}/dns-setup": {
      "post": {
        "operationId": "postDomainsBydomainIDDnsSetup",
        "parameters": [
          {
            "in": "path",
            "name": "domainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Write the domain's records at the connected DNS provider now (done automatically when the domain is added); conflicting A/AAAA/CNAME records of the name are removed",
        "tags": [
          "Networking"
        ]
      }
    },
    "/v1/domains/{domainID}/verify": {
      "post": {
        "operationId": "postDomainsBydomainIDVerify",
        "parameters": [
          {
            "in": "path",
            "name": "domainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Check DNS now",
        "tags": [
          "Networking"
        ]
      }
    },
    "/v1/edge/preview": {
      "post": {
        "operationId": "postEdgePreview",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Render a maintenance, error or blocked page for a preview: {kind, status, title, message, eta, html}",
        "tags": [
          "Protection"
        ]
      }
    },
    "/v1/environments/{environmentID}": {
      "delete": {
        "operationId": "deleteEnvironmentsByenvironmentID",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete an environment",
        "tags": [
          "Environments"
        ]
      },
      "get": {
        "operationId": "getEnvironmentsByenvironmentID",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Get an environment",
        "tags": [
          "Environments"
        ]
      },
      "patch": {
        "operationId": "patchEnvironmentsByenvironmentID",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename an environment",
        "tags": [
          "Environments"
        ]
      }
    },
    "/v1/environments/{environmentID}/buckets": {
      "get": {
        "operationId": "getEnvironmentsByenvironmentIDBuckets",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List S3 buckets",
        "tags": [
          "Data"
        ]
      },
      "post": {
        "operationId": "postEnvironmentsByenvironmentIDBuckets",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create an S3 bucket",
        "tags": [
          "Data"
        ]
      }
    },
    "/v1/environments/{environmentID}/edge": {
      "get": {
        "operationId": "getEnvironmentsByenvironmentIDEdge",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Firewall (WAF), maintenance mode and error pages of the environment's domains",
        "tags": [
          "Protection"
        ]
      },
      "put": {
        "operationId": "putEnvironmentsByenvironmentIDEdge",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change them: {waf_enabled, waf_mode (block or log), waf_rules {scanners, injections, bad_bots, rate_limit_rpm, ip_allow, ip_deny, block_paths, block_user_agents}, maintenance, maintenance_title, maintenance_message, maintenance_eta, maintenance_html, bypass_ips, bypass_token (\"new\" makes a new one), pages_404, pages_5xx, page_404_html, page_5xx_html}. Custom pages may use {{status}}, {{title}}, {{message}}, {{eta}}, {{host}}",
        "tags": [
          "Protection"
        ]
      }
    },
    "/v1/environments/{environmentID}/edge/events": {
      "get": {
        "operationId": "getEnvironmentsByenvironmentIDEdgeEvents",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Requests the firewall stopped: the latest 100 and the last day by rule, address and path",
        "tags": [
          "Protection"
        ]
      }
    },
    "/v1/environments/{environmentID}/overview": {
      "get": {
        "operationId": "getEnvironmentsByenvironmentIDOverview",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Services with live state, usage and references (dashboard canvas)",
        "tags": [
          "Environments"
        ]
      }
    },
    "/v1/environments/{environmentID}/services/{serviceID}/variables/resolved": {
      "get": {
        "operationId": "getEnvironmentsByenvironmentIDServicesByserviceIDVariablesResolved",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Variables a service runs with, references expanded",
        "tags": [
          "Variables"
        ]
      }
    },
    "/v1/environments/{environmentID}/traffic": {
      "get": {
        "operationId": "getEnvironmentsByenvironmentIDTraffic",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Live traffic between services and from the internet (bytes/s each way, connections; last 20 s)",
        "tags": [
          "Environments"
        ]
      }
    },
    "/v1/environments/{environmentID}/variables": {
      "get": {
        "operationId": "getEnvironmentsByenvironmentIDVariables",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List variables (?service_id= for a service)",
        "tags": [
          "Variables"
        ]
      },
      "put": {
        "operationId": "putEnvironmentsByenvironmentIDVariables",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Set variables (references like ${{ Svc.VAR }} allowed)",
        "tags": [
          "Variables"
        ]
      }
    },
    "/v1/environments/{environmentID}/variables/import": {
      "post": {
        "operationId": "postEnvironmentsByenvironmentIDVariablesImport",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Import a .env file",
        "tags": [
          "Variables"
        ]
      }
    },
    "/v1/environments/{environmentID}/variables/{name}": {
      "delete": {
        "operationId": "deleteEnvironmentsByenvironmentIDVariablesByname",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a variable",
        "tags": [
          "Variables"
        ]
      }
    },
    "/v1/environments/{environmentID}/variables/{name}/seal": {
      "post": {
        "operationId": "postEnvironmentsByenvironmentIDVariablesBynameSeal",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Seal a variable (write-only from now on)",
        "tags": [
          "Variables"
        ]
      }
    },
    "/v1/environments/{environmentID}/vpc": {
      "get": {
        "operationId": "getEnvironmentsByenvironmentIDVpc",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Private connectors of the environment: name, hostname (vpc-\u003cslug\u003e), ports with their in-environment address, status (connected or waiting), and for writers the agent token and run commands",
        "tags": [
          "Hangar VPC"
        ]
      },
      "post": {
        "operationId": "postEnvironmentsByenvironmentIDVpc",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a connector: {name, ports: [{port, target (host:port seen from the agent, default 127.0.0.1:\u003cport\u003e), label}]}. Services of the environment reach each port at vpc-\u003cslug\u003e:\u003cport\u003e once the agent runs",
        "tags": [
          "Hangar VPC"
        ]
      }
    },
    "/v1/github/setup": {
      "get": {
        "operationId": "getGithubSetup",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "GitHub App setup callback",
        "tags": [
          "GitHub"
        ]
      }
    },
    "/v1/github/webhook": {
      "post": {
        "operationId": "postGithubWebhook",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "GitHub webhook receiver (HMAC-signed)",
        "tags": [
          "GitHub"
        ]
      }
    },
    "/v1/hosting-plugin/{panelUser}": {
      "get": {
        "operationId": "getHostingPluginBypanelUser",
        "parameters": [
          {
            "in": "path",
            "name": "panelUser",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "For the Hangar plugin in ISPmanager (Bearer = the hosting server's HANGAR_HOSTING_PLUGIN_TOKEN, header X-Panel-Client-IP for the audit log): the account of the panel user, its workspace, access level, and with view access the projects/services/running/problems counts",
        "tags": [
          "Hosting plugin"
        ]
      }
    },
    "/v1/hosting-plugin/{panelUser}/projects": {
      "get": {
        "operationId": "getHostingPluginBypanelUserProjects",
        "parameters": [
          {
            "in": "path",
            "name": "panelUser",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The workspace's projects with their state (view access)",
        "tags": [
          "Hosting plugin"
        ]
      }
    },
    "/v1/hosting-plugin/{panelUser}/projects/{projectID}/services": {
      "get": {
        "operationId": "getHostingPluginBypanelUserProjectsByprojectIDServices",
        "parameters": [
          {
            "in": "path",
            "name": "panelUser",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A project's services in its base environment: state, source, public address, last deployment (view access)",
        "tags": [
          "Hosting plugin"
        ]
      }
    },
    "/v1/hosting-plugin/{panelUser}/services/{serviceID}/deploy": {
      "post": {
        "operationId": "postHostingPluginBypanelUserServicesByserviceIDDeploy",
        "parameters": [
          {
            "in": "path",
            "name": "panelUser",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Deploy the service's source again (manage access)",
        "tags": [
          "Hosting plugin"
        ]
      }
    },
    "/v1/hosting-plugin/{panelUser}/services/{serviceID}/logs": {
      "get": {
        "operationId": "getHostingPluginBypanelUserServicesByserviceIDLogs",
        "parameters": [
          {
            "in": "path",
            "name": "panelUser",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The last ?lines= (≤500, default 150) lines of the service's output (manage access)",
        "tags": [
          "Hosting plugin"
        ]
      }
    },
    "/v1/hosting-plugin/{panelUser}/services/{serviceID}/restart": {
      "post": {
        "operationId": "postHostingPluginBypanelUserServicesByserviceIDRestart",
        "parameters": [
          {
            "in": "path",
            "name": "panelUser",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Restart the service (manage access)",
        "tags": [
          "Hosting plugin"
        ]
      }
    },
    "/v1/hosting/{hostingID}": {
      "delete": {
        "operationId": "deleteHostingByhostingID",
        "parameters": [
          {
            "in": "path",
            "name": "hostingID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete the account with its sites, databases and mail",
        "tags": [
          "Hosting"
        ]
      },
      "patch": {
        "operationId": "patchHostingByhostingID",
        "parameters": [
          {
            "in": "path",
            "name": "hostingID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the plan: {plan} (limits apply at once), and/or what the Hangar plugin in the panel may do: {panel_access: off",
        "tags": [
          "Hosting"
        ]
      }
    },
    "/v1/hosting/{hostingID}/credentials": {
      "get": {
        "operationId": "getHostingByhostingIDCredentials",
        "parameters": [
          {
            "in": "path",
            "name": "hostingID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Login and password for FTP, phpMyAdmin and the panel",
        "tags": [
          "Hosting"
        ]
      }
    },
    "/v1/hosting/{hostingID}/login": {
      "post": {
        "operationId": "postHostingByhostingIDLogin",
        "parameters": [
          {
            "in": "path",
            "name": "hostingID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A one-time link that signs in to the ISPmanager panel of the account",
        "tags": [
          "Hosting"
        ]
      }
    },
    "/v1/hosting/{hostingID}/password": {
      "post": {
        "operationId": "postHostingByhostingIDPassword",
        "parameters": [
          {
            "in": "path",
            "name": "hostingID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Issue a new password",
        "tags": [
          "Hosting"
        ]
      }
    },
    "/v1/image-tags": {
      "get": {
        "operationId": "getImageTags",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Published versions (tags) of an image, newest first (?image=)",
        "tags": [
          "Templates"
        ]
      }
    },
    "/v1/integrations/{integrationID}": {
      "delete": {
        "operationId": "deleteIntegrationsByintegrationID",
        "parameters": [
          {
            "in": "path",
            "name": "integrationID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove an integration",
        "tags": [
          "Mobile releases"
        ]
      },
      "patch": {
        "operationId": "patchIntegrationsByintegrationID",
        "parameters": [
          {
            "in": "path",
            "name": "integrationID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename or replace credentials (empty secret fields keep the stored ones)",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/integrations/{integrationID}/refresh-zones": {
      "post": {
        "operationId": "postIntegrationsByintegrationIDRefreshZones",
        "parameters": [
          {
            "in": "path",
            "name": "integrationID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Reload the domains a DNS provider integration manages",
        "tags": [
          "Networking"
        ]
      }
    },
    "/v1/internal/edge": {
      "get": {
        "operationId": "getInternalEdge",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Firewall and maintenance check of a request to a protected domain (Traefik forwardAuth)",
        "tags": [
          "Protection"
        ]
      }
    },
    "/v1/internal/errorpage": {
      "get": {
        "operationId": "getInternalErrorpage",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Error page of a domain (Traefik errors middleware; ?status=)",
        "tags": [
          "Protection"
        ]
      }
    },
    "/v1/internal/git/pushed": {
      "post": {
        "operationId": "postInternalGitPushed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The git service's push notice (service token)",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/v1/internal/moq/auth": {
      "post": {
        "operationId": "postInternalMoqAuth",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Session check for the MoQ relay (its auth-url; key in the query)",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/internal/netflow": {
      "post": {
        "operationId": "postInternalNetflow",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Live pod-to-pod traffic report from the netflow agent (node agent token)",
        "tags": [
          "Regions"
        ]
      }
    },
    "/v1/internal/node-report": {
      "post": {
        "operationId": "postInternalNodeReport",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Host report of a server for the admin overview: disk, load, updates, firewall, SSH (node agent token)",
        "tags": [
          "Regions"
        ]
      }
    },
    "/v1/internal/peers": {
      "get": {
        "operationId": "getInternalPeers",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Server IPs for the node firewall agent (node agent token)",
        "tags": [
          "Regions"
        ]
      }
    },
    "/v1/internal/registry/keep": {
      "get": {
        "operationId": "getInternalRegistryKeep",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Image digests the registry cleanup keeps (node agent token)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/internal/registry/report": {
      "post": {
        "operationId": "postInternalRegistryReport",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Registry cleanup result and server disk usage; alerts admins near full (node agent token)",
        "tags": [
          "Admin"
        ]
      }
    },
    "/v1/internal/wake": {
      "get": {
        "operationId": "getInternalWake",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Wake page for sleeping services (ingress error middleware)",
        "tags": [
          "System"
        ]
      }
    },
    "/v1/invites/accept": {
      "post": {
        "operationId": "postInvitesAccept",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Accept a workspace invitation",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/jobs/keys/{keyID}": {
      "delete": {
        "operationId": "deleteJobsKeysBykeyID",
        "parameters": [
          {
            "in": "path",
            "name": "keyID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Revoke a key",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/messages/{messageID}": {
      "get": {
        "operationId": "getJobsMessagesBymessageID",
        "parameters": [
          {
            "in": "path",
            "name": "messageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A run with its body, the last response and every attempt",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/messages/{messageID}/cancel": {
      "post": {
        "operationId": "postJobsMessagesBymessageIDCancel",
        "parameters": [
          {
            "in": "path",
            "name": "messageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Cancel a message waiting in its queue",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/messages/{messageID}/retry": {
      "post": {
        "operationId": "postJobsMessagesBymessageIDRetry",
        "parameters": [
          {
            "in": "path",
            "name": "messageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Run a finished message again",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/publish/{queue}": {
      "post": {
        "operationId": "postJobsPublishByqueue",
        "parameters": [
          {
            "in": "path",
            "name": "queue",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "From a backend: Authorization: Bearer hjk_…; the request body is the message (Content-Type kept); ?delay=90s",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/queues/{queueID}": {
      "delete": {
        "operationId": "deleteJobsQueuesByqueueID",
        "parameters": [
          {
            "in": "path",
            "name": "queueID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a queue with its messages and schedules",
        "tags": [
          "Jobs"
        ]
      },
      "get": {
        "operationId": "getJobsQueuesByqueueID",
        "parameters": [
          {
            "in": "path",
            "name": "queueID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A queue",
        "tags": [
          "Jobs"
        ]
      },
      "patch": {
        "operationId": "patchJobsQueuesByqueueID",
        "parameters": [
          {
            "in": "path",
            "name": "queueID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change a queue (paused: true stops deliveries, messages wait)",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/queues/{queueID}/messages": {
      "post": {
        "operationId": "postJobsQueuesByqueueIDMessages",
        "parameters": [
          {
            "in": "path",
            "name": "queueID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send a message from the panel: the request body is the message, ?delay=90s",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/queues/{queueID}/secret": {
      "get": {
        "operationId": "getJobsQueuesByqueueIDSecret",
        "parameters": [
          {
            "in": "path",
            "name": "queueID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The signing secret: requests carry Hangar-Timestamp and Hangar-Signature: v1=hex(HMAC-SHA256(secret, timestamp + \".\" + body))",
        "tags": [
          "Jobs"
        ]
      },
      "post": {
        "operationId": "postJobsQueuesByqueueIDSecret",
        "parameters": [
          {
            "in": "path",
            "name": "queueID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Issue a new signing secret",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/schedules/{scheduleID}": {
      "delete": {
        "operationId": "deleteJobsSchedulesByscheduleID",
        "parameters": [
          {
            "in": "path",
            "name": "scheduleID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a schedule",
        "tags": [
          "Jobs"
        ]
      },
      "patch": {
        "operationId": "patchJobsSchedulesByscheduleID",
        "parameters": [
          {
            "in": "path",
            "name": "scheduleID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change a schedule (paused)",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/schedules/{scheduleID}/run": {
      "post": {
        "operationId": "postJobsSchedulesByscheduleIDRun",
        "parameters": [
          {
            "in": "path",
            "name": "scheduleID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Run a schedule now",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/jobs/status/{messageID}": {
      "get": {
        "operationId": "getJobsStatusBymessageID",
        "parameters": [
          {
            "in": "path",
            "name": "messageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "From a backend (hjk_ key): a message's status and last error",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/mail-domains/{mailDomainID}": {
      "delete": {
        "operationId": "deleteMailDomainsBymailDomainID",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Stop handling mail for the domain",
        "tags": [
          "Email"
        ]
      },
      "get": {
        "operationId": "getMailDomainsBymailDomainID",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Domain with DNS records (ok per record), can_send, can_receive, problems, relay settings, client settings (mail.\u003cdomain\u003e, IMAP 993, SMTP 465), usage today and the plan's daily limit",
        "tags": [
          "Email"
        ]
      },
      "patch": {
        "operationId": "patchMailDomainsBymailDomainID",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the mail server, environment, inbound or ports",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/mail-domains/{mailDomainID}/check": {
      "post": {
        "operationId": "postMailDomainsBymailDomainIDCheck",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Look the DNS records up now (also done every 10 minutes)",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/mail-domains/{mailDomainID}/dns-setup": {
      "post": {
        "operationId": "postMailDomainsBymailDomainIDDnsSetup",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Write the records at the connected DNS provider (Cloudflare, Namecheap...) now; an existing SPF record is extended, an existing DMARC policy kept",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/mail-domains/{mailDomainID}/mailboxes": {
      "get": {
        "operationId": "getMailDomainsBymailDomainIDMailboxes",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Mailboxes of a Hangar mail server (managed: true)",
        "tags": [
          "Email"
        ]
      },
      "post": {
        "operationId": "postMailDomainsBymailDomainIDMailboxes",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a mailbox: {name (before @), password (8-128)}",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/mail-domains/{mailDomainID}/mailboxes/{name}": {
      "delete": {
        "operationId": "deleteMailDomainsBymailDomainIDMailboxesByname",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a mailbox and its mail",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/mail-domains/{mailDomainID}/mailboxes/{name}/password": {
      "put": {
        "operationId": "putMailDomainsBymailDomainIDMailboxesBynamePassword",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change a mailbox password: {password}",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/mail-domains/{mailDomainID}/queue": {
      "get": {
        "operationId": "getMailDomainsBymailDomainIDQueue",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Last 100 outgoing messages: status (queued: not tried yet, deferred: retrying, sent, partial, bounced), recipients, pending, results per recipient {status: delivered/deferred/bounced, response: the receiving server's answer, host, at}, attempts, last_error",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/mail-domains/{mailDomainID}/relay-password": {
      "get": {
        "operationId": "getMailDomainsBymailDomainIDRelayPassword",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The relay password (also in the service's HANGAR_SMTP_PASSWORD)",
        "tags": [
          "Email"
        ]
      },
      "post": {
        "operationId": "postMailDomainsBymailDomainIDRelayPassword",
        "parameters": [
          {
            "in": "path",
            "name": "mailDomainID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Issue a new relay password and update the variables",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/me": {
      "get": {
        "operationId": "getMe",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Current user and workspaces",
        "tags": [
          "Users"
        ]
      },
      "patch": {
        "operationId": "patchMe",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Update name or password",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/2fa": {
      "get": {
        "operationId": "getMe2fa",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Two-factor sign-in state: enabled, recovery codes left, required for admins",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/2fa/disable": {
      "post": {
        "operationId": "postMe2faDisable",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Turn two-factor sign-in off: {code}",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/2fa/enable": {
      "post": {
        "operationId": "postMe2faEnable",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Confirm the authenticator with {code}; returns 10 recovery codes once",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/2fa/recovery": {
      "post": {
        "operationId": "postMe2faRecovery",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "New recovery codes: {code}",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/2fa/setup": {
      "post": {
        "operationId": "postMe2faSetup",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Start two-factor sign-in: secret, otpauth URI and QR code",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/devices": {
      "get": {
        "operationId": "getMeDevices",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The user's devices registered for push notifications, and whether push is enabled",
        "tags": [
          "Push"
        ]
      },
      "post": {
        "operationId": "postMeDevices",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Register (or move to this user) an APNs device token",
        "tags": [
          "Push"
        ]
      }
    },
    "/v1/me/devices/{deviceID}": {
      "delete": {
        "operationId": "deleteMeDevicesBydeviceID",
        "parameters": [
          {
            "in": "path",
            "name": "deviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Unregister a device (sign-out in the app)",
        "tags": [
          "Push"
        ]
      }
    },
    "/v1/me/devices/{deviceID}/test": {
      "post": {
        "operationId": "postMeDevicesBydeviceIDTest",
        "parameters": [
          {
            "in": "path",
            "name": "deviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send a test notification to a device",
        "tags": [
          "Push"
        ]
      }
    },
    "/v1/me/sessions": {
      "get": {
        "operationId": "getMeSessions",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Where the account is signed in: address, device, created and last used; current marks this session",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/sessions/{sessionID}": {
      "delete": {
        "operationId": "deleteMeSessionsBysessionID",
        "parameters": [
          {
            "in": "path",
            "name": "sessionID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Sign one session out (not the current one: use logout)",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/tokens": {
      "get": {
        "operationId": "getMeTokens",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List personal access tokens (with where each was created and last used, and its allowed addresses)",
        "tags": [
          "Users"
        ]
      },
      "post": {
        "operationId": "postMeTokens",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a personal access token: {name, expires_in_days, allowed_ips} — allowed_ips limits it to addresses or networks (up to 20). The account is emailed about every new token",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/tokens/{tokenID}": {
      "delete": {
        "operationId": "deleteMeTokensBytokenID",
        "parameters": [
          {
            "in": "path",
            "name": "tokenID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Revoke a personal access token",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/verify-code": {
      "post": {
        "operationId": "postMeVerifyCode",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Confirm the signed-in account's email with the 6-digit code from the sign-up email: {code}. Until then the account can only read /v1/me, ask for a new code and sign out",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/me/verify-email": {
      "post": {
        "operationId": "postMeVerifyEmail",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send a new verification email: a 6-digit code and a link (at most once a minute, five an hour)",
        "tags": [
          "Users"
        ]
      }
    },
    "/v1/mobile-runner/artifact": {
      "put": {
        "operationId": "putMobileRunnerArtifact",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Upload the signed .ipa / .aab / .apk (?name=); it becomes a build of the app (run token)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/mobile-runner/bundle": {
      "get": {
        "operationId": "getMobileRunnerBundle",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Build script, variables and signing files of the run (Bearer hmr_ run token)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/mobile-runner/finish": {
      "post": {
        "operationId": "postMobileRunnerFinish",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Report a failed or cancelled build: {status, error} (run token)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/mobile-runner/log": {
      "post": {
        "operationId": "postMobileRunnerLog",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Append {lines}; answers {cancel} when the build was stopped (run token)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/mobile-runner/poll": {
      "post": {
        "operationId": "postMobileRunnerPoll",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The Mac agent asks for work (Bearer hmb_ builder token, body = its macOS/Xcode info): waits up to 25 s; 204 = nothing, 200 = {run_id, token}",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/mobile-runner/source": {
      "get": {
        "operationId": "getMobileRunnerSource",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The run's sources as tar.gz; X-Hangar-Strip = leading path parts to drop (run token)",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/netgw/config": {
      "get": {
        "operationId": "getNetgwConfig",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "For a network's gateway (Bearer \u003cnetwork id\u003e.\u003ctoken\u003e): its configuration now (peers, joined services, rules, DNS names); If-None-Match: \u003cversion\u003e → 304",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/netgw/status": {
      "post": {
        "operationId": "postNetgwStatus",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "For a network's gateway: what it sees of its devices {peers: [{public_key, endpoint, last_handshake, rx_bytes, tx_bytes}]}",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/network": {
      "get": {
        "operationId": "getNetwork",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Static outbound (egress) IPs and edge addresses of the platform",
        "tags": [
          "Networking"
        ]
      }
    },
    "/v1/network-devices/{deviceID}": {
      "delete": {
        "operationId": "deleteNetworkDevicesBydeviceID",
        "parameters": [
          {
            "in": "path",
            "name": "deviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a device (its grants go too)",
        "tags": [
          "Networks"
        ]
      },
      "patch": {
        "operationId": "patchNetworkDevicesBydeviceID",
        "parameters": [
          {
            "in": "path",
            "name": "deviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change a device: {name?, owner?, kind?, expires_at? or clear_expires, routes?, disabled?}",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/network-devices/{deviceID}/config": {
      "get": {
        "operationId": "getNetworkDevicesBydeviceIDConfig",
        "parameters": [
          {
            "in": "path",
            "name": "deviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The device's WireGuard configuration again: JSON, ?format=conf (file) or ?format=qr (PNG for the mobile apps); audited",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/network-devices/{deviceID}/rotate": {
      "post": {
        "operationId": "postNetworkDevicesBydeviceIDRotate",
        "parameters": [
          {
            "in": "path",
            "name": "deviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A new key for the device (the old configuration stops working) → {device, config}",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/network-grants/{grantID}": {
      "delete": {
        "operationId": "deleteNetworkGrantsBygrantID",
        "parameters": [
          {
            "in": "path",
            "name": "grantID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Revoke a grant",
        "tags": [
          "Networks"
        ]
      },
      "patch": {
        "operationId": "patchNetworkGrantsBygrantID",
        "parameters": [
          {
            "in": "path",
            "name": "grantID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change a grant: {ports?, protocol?, expires_at? or clear_expires, note?, disabled?}",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/network-services/{memberID}": {
      "delete": {
        "operationId": "deleteNetworkServicesBymemberID",
        "parameters": [
          {
            "in": "path",
            "name": "memberID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Take a service out of the network (its grants go too)",
        "tags": [
          "Networks"
        ]
      },
      "patch": {
        "operationId": "patchNetworkServicesBymemberID",
        "parameters": [
          {
            "in": "path",
            "name": "memberID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change a joined service's name or ports: {name?, ports?}",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/networks/{networkID}": {
      "delete": {
        "operationId": "deleteNetworksBynetworkID",
        "parameters": [
          {
            "in": "path",
            "name": "networkID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete the network, its gateway, devices and grants (services stay in their projects)",
        "tags": [
          "Networks"
        ]
      },
      "get": {
        "operationId": "getNetworksBynetworkID",
        "parameters": [
          {
            "in": "path",
            "name": "networkID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The network with its services (address, \u003cname\u003e.\u003cslug\u003e.internal, ports), devices (state online/offline/never/expired/disabled, last handshake, endpoint, traffic) and grants",
        "tags": [
          "Networks"
        ]
      },
      "patch": {
        "operationId": "patchNetworksBynetworkID",
        "parameters": [
          {
            "in": "path",
            "name": "networkID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename it or change the description: {name?, description?}",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/networks/{networkID}/devices": {
      "post": {
        "operationId": "postNetworksBynetworkIDDevices",
        "parameters": [
          {
            "in": "path",
            "name": "networkID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a device: {name, kind (laptop, server, ci, phone, router, other), owner?, expires_at?, routes? (subnets behind it), public_key? (own key)} → {device, config}: the WireGuard configuration when Hangar made the key",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/networks/{networkID}/grants": {
      "post": {
        "operationId": "postNetworksBynetworkIDGrants",
        "parameters": [
          {
            "in": "path",
            "name": "networkID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Allow a device to reach something: {device_id, target_kind (service, device, route), target_id, target_cidr? (route), ports? (\"\" = all; \"5432\", \"80,443,8000-8100\"), protocol? (tcp, udp, any), expires_at?, note?}; everything not granted is dropped",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/networks/{networkID}/services": {
      "post": {
        "operationId": "postNetworksBynetworkIDServices",
        "parameters": [
          {
            "in": "path",
            "name": "networkID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Join a service: {service_id, environment_id? (default the main one), name? (DNS label), ports? (default its port)}; only this network's gateway can reach it, on these ports",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/openapi.json": {
      "get": {
        "operationId": "getOpenapiJson",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "This OpenAPI document",
        "tags": [
          "System"
        ]
      }
    },
    "/v1/plans": {
      "get": {
        "operationId": "getPlans",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Available plans (price_amount in price_currency; price_cents in USD)",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/previews/{environmentID}": {
      "delete": {
        "operationId": "deletePreviewsByenvironmentID",
        "parameters": [
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a preview now (the next push to the PR creates it again)",
        "tags": [
          "Previews"
        ]
      }
    },
    "/v1/projects/{projectID}": {
      "delete": {
        "operationId": "deleteProjectsByprojectID",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a project",
        "tags": [
          "Projects"
        ]
      },
      "get": {
        "operationId": "getProjectsByprojectID",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Get a project with environments and services",
        "tags": [
          "Projects"
        ]
      },
      "patch": {
        "operationId": "patchProjectsByprojectID",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Update a project (name, PR environments)",
        "tags": [
          "Projects"
        ]
      }
    },
    "/v1/projects/{projectID}/compose/deploy": {
      "post": {
        "operationId": "postProjectsByprojectIDComposeDeploy",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create and deploy the plan: {repo, branch?, file?, environment_id?, services? (compose names; default: the plan's), public? {name: bool}, shared? {VAR: value}}",
        "tags": [
          "Templates"
        ]
      }
    },
    "/v1/projects/{projectID}/compose/plan": {
      "post": {
        "operationId": "postProjectsByprojectIDComposePlan",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Read a repository's docker-compose (and .env.example) and show what Hangar would create: {repo, branch?, file?} → plan with services (app built from a folder/Dockerfile, database, image, skip with reason), ports, public domains, disks, variables with links between services (${{ db.HANGAR_PRIVATE_DOMAIN }}), the ${VAR}s as shared variables (generated secrets, missing values) and warnings",
        "tags": [
          "Templates"
        ]
      }
    },
    "/v1/projects/{projectID}/dependency-vulnerabilities": {
      "get": {
        "operationId": "getProjectsByprojectIDDependencyVulnerabilities",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Vulnerable dependencies (from lock files) of the project's running services",
        "tags": [
          "Security"
        ]
      }
    },
    "/v1/projects/{projectID}/environments": {
      "get": {
        "operationId": "getProjectsByprojectIDEnvironments",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List environments",
        "tags": [
          "Environments"
        ]
      },
      "post": {
        "operationId": "postProjectsByprojectIDEnvironments",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create (or fork) an environment",
        "tags": [
          "Environments"
        ]
      }
    },
    "/v1/projects/{projectID}/mail-domains": {
      "get": {
        "operationId": "getProjectsByprojectIDMailDomains",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Mail domains of the project",
        "tags": [
          "Email"
        ]
      },
      "post": {
        "operationId": "postProjectsByprojectIDMailDomains",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a domain: {domain, service_id (the mail server; gets HANGAR_SMTP_* variables), environment_id?, inbound? (default true), smtp_port? 25, imap_port? 143, submission_port? 587, proxy_protocol? (PROXY v1 header with the sender's IP on every connection to the mail server)}. Paid plans only; returns the DNS records to publish. Project tokens may add domains to their own environment. Webhook events: mail.domain.verified, mail.domain.check_failed, mail.domain.blocked",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/projects/{projectID}/mail-server": {
      "post": {
        "operationId": "postProjectsByprojectIDMailServer",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "One click: a mail server (docker-mailserver with a volume) for {domain, environment_id?}, the domain routed to it and its first deploy; returns the first mailbox postmaster@\u003cdomain\u003e and its password",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/projects/{projectID}/services": {
      "get": {
        "operationId": "getProjectsByprojectIDServices",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List services",
        "tags": [
          "Services"
        ]
      },
      "post": {
        "operationId": "postProjectsByprojectIDServices",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a service from a repo or image",
        "tags": [
          "Services"
        ]
      }
    },
    "/v1/projects/{projectID}/template-export": {
      "get": {
        "operationId": "getProjectsByprojectIDTemplateExport",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Export the project as a template spec",
        "tags": [
          "Templates"
        ]
      }
    },
    "/v1/projects/{projectID}/templates/{code}/deploy": {
      "post": {
        "operationId": "postProjectsByprojectIDTemplatesBycodeDeploy",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "code",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Deploy a template into the project",
        "tags": [
          "Templates"
        ]
      }
    },
    "/v1/projects/{projectID}/tokens": {
      "get": {
        "operationId": "getProjectsByprojectIDTokens",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List project (CI) tokens",
        "tags": [
          "Tokens"
        ]
      },
      "post": {
        "operationId": "postProjectsByprojectIDTokens",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a project token for one environment",
        "tags": [
          "Tokens"
        ]
      }
    },
    "/v1/projects/{projectID}/tokens/{tokenID}": {
      "delete": {
        "operationId": "deleteProjectsByprojectIDTokensBytokenID",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "tokenID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Revoke a project token",
        "tags": [
          "Tokens"
        ]
      }
    },
    "/v1/projects/{projectID}/vulnerabilities": {
      "get": {
        "operationId": "getProjectsByprojectIDVulnerabilities",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Vulnerability alerts of the project's running services (?all=true: fixed and ignored too)",
        "tags": [
          "Security"
        ]
      }
    },
    "/v1/projects/{projectID}/webhooks": {
      "get": {
        "operationId": "getProjectsByprojectIDWebhooks",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List webhooks",
        "tags": [
          "Webhooks"
        ]
      },
      "post": {
        "operationId": "postProjectsByprojectIDWebhooks",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a webhook (secret returned once)",
        "tags": [
          "Webhooks"
        ]
      }
    },
    "/v1/projects/{projectID}/webhooks/{webhookID}": {
      "delete": {
        "operationId": "deleteProjectsByprojectIDWebhooksBywebhookID",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "webhookID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a webhook",
        "tags": [
          "Webhooks"
        ]
      },
      "patch": {
        "operationId": "patchProjectsByprojectIDWebhooksBywebhookID",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "webhookID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Enable, disable or change events",
        "tags": [
          "Webhooks"
        ]
      }
    },
    "/v1/projects/{projectID}/webhooks/{webhookID}/deliveries": {
      "get": {
        "operationId": "getProjectsByprojectIDWebhooksBywebhookIDDeliveries",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "webhookID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Recent deliveries",
        "tags": [
          "Webhooks"
        ]
      }
    },
    "/v1/projects/{projectID}/webhooks/{webhookID}/test": {
      "post": {
        "operationId": "postProjectsByprojectIDWebhooksBywebhookIDTest",
        "parameters": [
          {
            "in": "path",
            "name": "projectID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "webhookID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send a test event",
        "tags": [
          "Webhooks"
        ]
      }
    },
    "/v1/public/app-builds/{buildID}/download": {
      "get": {
        "operationId": "getPublicAppBuildsBybuildIDDownload",
        "parameters": [
          {
            "in": "path",
            "name": "buildID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "A build by its signed link (?exp=\u0026sig=)",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/public/drive/{storageID}": {
      "get": {
        "operationId": "getPublicDriveBystorageID",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page before signing in: {name, ready, quota_gb}",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/fs": {
      "get": {
        "operationId": "getPublicDriveBystorageIDFs",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page (X-Drive-Token): list a folder",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/fs/delete": {
      "post": {
        "operationId": "postPublicDriveBystorageIDFsDelete",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: delete",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/fs/link": {
      "post": {
        "operationId": "postPublicDriveBystorageIDFsLink",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: a file URL",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/fs/mkdir": {
      "post": {
        "operationId": "postPublicDriveBystorageIDFsMkdir",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: create a folder",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/fs/move": {
      "post": {
        "operationId": "postPublicDriveBystorageIDFsMove",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: rename or move",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/fs/upload": {
      "put": {
        "operationId": "putPublicDriveBystorageIDFsUpload",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: upload one file",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/fs/usage": {
      "get": {
        "operationId": "getPublicDriveBystorageIDFsUsage",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: used and quota bytes",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/login": {
      "post": {
        "operationId": "postPublicDriveBystorageIDLogin",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Sign in with the storage login: {username, password} → {token} for the X-Drive-Token header of the /v1/public/drive/{storageID}/fs… and /shares routes (same as the /v1/storages/{storageID} ones), 12 hours",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/shares": {
      "get": {
        "operationId": "getPublicDriveBystorageIDShares",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: public links",
        "tags": [
          "Storage files"
        ]
      },
      "post": {
        "operationId": "postPublicDriveBystorageIDShares",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: share a file or folder",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/drive/{storageID}/shares/{shareID}": {
      "delete": {
        "operationId": "deletePublicDriveBystorageIDSharesByshareID",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "shareID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The storage's page: revoke a link",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/grants": {
      "post": {
        "operationId": "postPublicGrants",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Apply for a startup grant (the landing form): {name, email, phone?, company, website?, stage (idea, mvp, launched, growing, other), team_size, description, needs?, consent}",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/public/meet/{meetingID}": {
      "get": {
        "operationId": "getPublicMeetBymeetingID",
        "parameters": [
          {
            "in": "path",
            "name": "meetingID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "A meeting's title (the call page)",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/public/meet/{meetingID}/join": {
      "post": {
        "operationId": "postPublicMeetBymeetingIDJoin",
        "parameters": [
          {
            "in": "path",
            "name": "meetingID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Join a meeting with {name}: SFU url and token (rate limited per IP)",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/public/platform": {
      "get": {
        "operationId": "getPublicPlatform",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Sign-up open, maintenance mode and enabled modules of the platform",
        "tags": [
          "Auth"
        ]
      }
    },
    "/v1/public/pricing": {
      "get": {
        "operationId": "getPublicPricing",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Public plans and resource prices per month in USD, with exchange rates fx {USD, RUB, KZT} and default_currency (no sign-in; the landing page)",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/public/shares/{token}": {
      "get": {
        "operationId": "getPublicSharesBytoken",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "A share link: {name, is_dir, locked, expires_at, size}",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/shares/{token}/fs": {
      "get": {
        "operationId": "getPublicSharesBytokenFs",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "List a shared folder (read only)",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/shares/{token}/fs/link": {
      "post": {
        "operationId": "postPublicSharesBytokenFsLink",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "A URL for a shared file, a file in a shared folder or a zip (counts downloads)",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/shares/{token}/unlock": {
      "post": {
        "operationId": "postPublicSharesBytokenUnlock",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Password of a share: {password} → {access} for the X-Share-Access header",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/public/status": {
      "get": {
        "operationId": "getPublicStatus",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "The status page feed (status.hangar.my): components, the platform's own health per component, incidents and maintenance of the last 90 days with their updates",
        "tags": [
          "Status"
        ]
      }
    },
    "/v1/public/storage-files/{name}": {
      "get": {
        "operationId": "getPublicStorageFilesByname",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Serve a signed link (?t=): Range requests for video, previews inline, everything else as a download",
        "tags": [
          "Storage files"
        ]
      },
      "head": {
        "operationId": "headPublicStorageFilesByname",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Headers of a signed link (size, type)",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/realtime/apps/{appID}": {
      "delete": {
        "operationId": "deleteRealtimeAppsByappID",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete the app",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/apps/{appID}/meetings": {
      "get": {
        "operationId": "getRealtimeAppsByappIDMeetings",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "RealtimeKit meetings of the app",
        "tags": [
          "Realtime"
        ]
      },
      "post": {
        "operationId": "postRealtimeAppsByappIDMeetings",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a meeting: {title} → {id, url}",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/apps/{appID}/rooms": {
      "get": {
        "operationId": "getRealtimeAppsByappIDRooms",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Live SFU rooms of the app with participants",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/apps/{appID}/rotate-token": {
      "post": {
        "operationId": "postRealtimeAppsByappIDRotateToken",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "New app token (the old one stops working)",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/apps/{appID}/test": {
      "post": {
        "operationId": "postRealtimeAppsByappIDTest",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Credentials for a test from the panel: {kind, room, path}",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/kit/meetings": {
      "post": {
        "operationId": "postRealtimeKitMeetings",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Create a RealtimeKit meeting from an app backend (Bearer hrt_ token): {title} → {id, title, url}",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/meetings/{meetingID}": {
      "delete": {
        "operationId": "deleteRealtimeMeetingsBymeetingID",
        "parameters": [
          {
            "in": "path",
            "name": "meetingID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a meeting",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/moq/token": {
      "post": {
        "operationId": "postRealtimeMoqToken",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Token for the MoQ relay for a MoQ app (Bearer hrt_ token): {path, publish: [patterns], subscribe: [patterns], ttl} → {url (with ?jwt=), token, expires_at}",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/sfu/token": {
      "post": {
        "operationId": "postRealtimeSfuToken",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "Access token for the Serverless SFU (LiveKit protocol) for an SFU or RealtimeKit app (Bearer hrt_ token): {room, identity, name, can_publish, ttl} → {url, token, room, identity, expires_at}",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/realtime/turn/credentials": {
      "post": {
        "operationId": "postRealtimeTurnCredentials",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "TURN credentials for a TURN app (Authorization: Bearer hrt_ app token): {ttl} seconds (default 86400) → {iceServers: {urls, username, credential}, expires_at}",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/regions": {
      "get": {
        "operationId": "getRegions",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Locations a service can be placed in (code, name, country, apps domain, edge and egress IPs)",
        "tags": [
          "Regions"
        ]
      }
    },
    "/v1/repos/{repoID}": {
      "delete": {
        "operationId": "deleteReposByrepoID",
        "parameters": [
          {
            "in": "path",
            "name": "repoID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a repository (refused while services deploy from it)",
        "tags": [
          "Hangar Git"
        ]
      },
      "get": {
        "operationId": "getReposByrepoID",
        "parameters": [
          {
            "in": "path",
            "name": "repoID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A repository",
        "tags": [
          "Hangar Git"
        ]
      },
      "patch": {
        "operationId": "patchReposByrepoID",
        "parameters": [
          {
            "in": "path",
            "name": "repoID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename, describe, change the default branch or the home project",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/v1/repos/{repoID}/blob": {
      "get": {
        "operationId": "getReposByrepoIDBlob",
        "parameters": [
          {
            "in": "path",
            "name": "repoID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A file: ?ref=\u0026path= → {content (utf-8), binary, too_big (over 2 MB), size}",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/v1/repos/{repoID}/commits": {
      "get": {
        "operationId": "getReposByrepoIDCommits",
        "parameters": [
          {
            "in": "path",
            "name": "repoID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "History: ?ref=\u0026path=\u0026limit=\u0026skip=",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/v1/repos/{repoID}/pushes": {
      "get": {
        "operationId": "getReposByrepoIDPushes",
        "parameters": [
          {
            "in": "path",
            "name": "repoID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Last 50 pushes: ref, before, after, who",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/v1/repos/{repoID}/refs": {
      "get": {
        "operationId": "getReposByrepoIDRefs",
        "parameters": [
          {
            "in": "path",
            "name": "repoID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Branches and tags with their last commit; default; empty",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/v1/repos/{repoID}/tree": {
      "get": {
        "operationId": "getReposByrepoIDTree",
        "parameters": [
          {
            "in": "path",
            "name": "repoID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Folder listing: ?ref= (branch, tag or SHA; default HEAD)\u0026path=",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/v1/services/{serviceID}": {
      "delete": {
        "operationId": "deleteServicesByserviceID",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a service in every environment",
        "tags": [
          "Services"
        ]
      },
      "get": {
        "operationId": "getServicesByserviceID",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Get a service",
        "tags": [
          "Services"
        ]
      },
      "patch": {
        "operationId": "patchServicesByserviceID",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename a service",
        "tags": [
          "Services"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentID",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Service settings in an environment",
        "tags": [
          "Services"
        ]
      },
      "patch": {
        "operationId": "patchServicesByserviceIDInstancesByenvironmentID",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change settings (source, commands, replicas, cron, limits, autoscale, sleep)",
        "tags": [
          "Services"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/config-files": {
      "put": {
        "operationId": "putServicesByserviceIDInstancesByenvironmentIDConfigFiles",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Replace the config files mounted into the container: {files: [{path, content}]} (up to 20, 256 KB each). Applied by the next deployment or a redeploy",
        "tags": [
          "Services"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/config-files/presets": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDConfigFilesPresets",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Suggested config files for the service's runtime (php.ini, PHP-FPM, Caddyfile, nginx, MySQL)",
        "tags": [
          "Services"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/config-files/read": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDConfigFilesRead",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A file as it is in the running container (?path=); user tokens only",
        "tags": [
          "Services"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/database": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Engine, connection details and admin panels of a database service",
        "tags": [
          "Database"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/database/overview": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDDatabaseOverview",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Databases and tables, collections or keys (?database=)",
        "tags": [
          "Database"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/database/panels": {
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDDatabasePanels",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Deploy an admin panel (pgadmin, adminer, phpmyadmin, redis-commander, mongo-express)",
        "tags": [
          "Database"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/database/pooler": {
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDDatabasePooler",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Put a PgBouncer connection pooler in front of a PostgreSQL service ({pool_mode?: transaction or session}); the database isn't changed, apps switch to the pooler's DATABASE_POOL_URL",
        "tags": [
          "Database"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/database/query": {
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDDatabaseQuery",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Run SQL, a Redis command or a Mongo command document",
        "tags": [
          "Database"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/database/rows": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDDatabaseRows",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A page of rows (?database, schema, table, limit, offset, order, desc, filter, cursor)",
        "tags": [
          "Database"
        ]
      },
      "patch": {
        "operationId": "patchServicesByserviceIDInstancesByenvironmentIDDatabaseRows",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Update one row by its key",
        "tags": [
          "Database"
        ]
      },
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDDatabaseRows",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Insert a row, document or key",
        "tags": [
          "Database"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/database/rows/delete": {
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDDatabaseRowsDelete",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete one row by its key",
        "tags": [
          "Database"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/deployments": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDDeployments",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List deployments",
        "tags": [
          "Deployments"
        ]
      },
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDDeployments",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Deploy the configured source",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/deployments/upload": {
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDDeploymentsUpload",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Deploy a gzipped tarball of source code",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/domains": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDDomains",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List domains",
        "tags": [
          "Networking"
        ]
      },
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDDomains",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a generated or custom domain",
        "tags": [
          "Networking"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/exec": {
      "get": {
        "description": "WebSocket endpoint (Upgrade). See docs/API.md for the framing.",
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDExec",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Shell or command in a running replica",
        "tags": [
          "Sessions"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/logs": {
      "get": {
        "description": "Add follow=true or Accept: text/event-stream to stream server-sent events.",
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDLogs",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Runtime logs (?tail, ?since, follow)",
        "tags": [
          "Observability"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/mail-relay": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDMailRelay",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The service's relay login {host, port, user, password, domains}: one login for every mail domain routed to the service (also in its HANGAR_SMTP_* variables). Project tokens: their environment",
        "tags": [
          "Email"
        ]
      },
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDMailRelay",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Issue a new password for the service's relay login and update HANGAR_SMTP_PASSWORD",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/metrics": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDMetrics",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "CPU, memory, requests, errors, latency (?range=1h…30d)",
        "tags": [
          "Observability"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/restart": {
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDRestart",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Restart live replicas",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/stop": {
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDStop",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Take the service down",
        "tags": [
          "Deployments"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/tcp-proxies": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDTcpProxies",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List TCP proxies",
        "tags": [
          "Networking"
        ]
      },
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDTcpProxies",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Expose a TCP port publicly",
        "tags": [
          "Networking"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/tunnel": {
      "get": {
        "description": "WebSocket endpoint (Upgrade). See docs/API.md for the framing.",
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDTunnel",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "TCP tunnel to a port of a running replica (?port=)",
        "tags": [
          "Sessions"
        ]
      }
    },
    "/v1/services/{serviceID}/instances/{environmentID}/volume": {
      "get": {
        "operationId": "getServicesByserviceIDInstancesByenvironmentIDVolume",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Get the service's volume",
        "tags": [
          "Data"
        ]
      },
      "post": {
        "operationId": "postServicesByserviceIDInstancesByenvironmentIDVolume",
        "parameters": [
          {
            "in": "path",
            "name": "serviceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "environmentID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Attach a persistent volume",
        "tags": [
          "Data"
        ]
      }
    },
    "/v1/storages/{storageID}": {
      "delete": {
        "operationId": "deleteStoragesBystorageID",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete the storage and its files",
        "tags": [
          "Storage"
        ]
      },
      "get": {
        "operationId": "getStoragesBystorageID",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A storage: web, WebDAV and SFTP access, usage",
        "tags": [
          "Storage"
        ]
      },
      "patch": {
        "operationId": "patchStoragesBystorageID",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change the quota (quota_gb)",
        "tags": [
          "Storage"
        ]
      }
    },
    "/v1/storages/{storageID}/fs": {
      "get": {
        "operationId": "getStoragesBystorageIDFs",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List a folder: ?path=/ → {data: [{name, path, is_dir, size, modified}], can_write}",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/storages/{storageID}/fs/delete": {
      "post": {
        "operationId": "postStoragesBystorageIDFsDelete",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete files and folders: {items: [{path, is_dir}]} (folders with their contents)",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/storages/{storageID}/fs/link": {
      "post": {
        "operationId": "postStoragesBystorageIDFsLink",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A URL serving files for an hour: {paths, download, zip}; one file inline (preview) or downloaded, zip: true (folders, several paths) as one zip",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/storages/{storageID}/fs/mkdir": {
      "post": {
        "operationId": "postStoragesBystorageIDFsMkdir",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a folder: {path} (parents too)",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/storages/{storageID}/fs/move": {
      "post": {
        "operationId": "postStoragesBystorageIDFsMove",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename or move: {from, to, is_dir}",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/storages/{storageID}/fs/upload": {
      "put": {
        "operationId": "putStoragesBystorageIDFsUpload",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Upload one file: ?path=/folder/name, the request body is the file (the quota applies)",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/storages/{storageID}/fs/usage": {
      "get": {
        "operationId": "getStoragesBystorageIDFsUsage",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Used and quota bytes, files",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/storages/{storageID}/shares": {
      "get": {
        "operationId": "getStoragesBystorageIDShares",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Public links of the storage",
        "tags": [
          "Storage files"
        ]
      },
      "post": {
        "operationId": "postStoragesBystorageIDShares",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Share a file or folder: {path, is_dir, expires_hours? (0 = never), password?, max_downloads? (0 = no limit)} → {url: https://hangar.my/s/\u003ctoken\u003e, ...}",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/storages/{storageID}/shares/{shareID}": {
      "delete": {
        "operationId": "deleteStoragesBystorageIDSharesByshareID",
        "parameters": [
          {
            "in": "path",
            "name": "storageID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "shareID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Revoke a public link",
        "tags": [
          "Storage files"
        ]
      }
    },
    "/v1/tcp-proxies/{proxyID}": {
      "delete": {
        "operationId": "deleteTcpProxiesByproxyID",
        "parameters": [
          {
            "in": "path",
            "name": "proxyID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a TCP proxy",
        "tags": [
          "Networking"
        ]
      }
    },
    "/v1/templates": {
      "get": {
        "operationId": "getTemplates",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Built-in, catalog (marketplace), saved and public templates",
        "tags": [
          "Templates"
        ]
      }
    },
    "/v1/templates/{templateID}": {
      "delete": {
        "operationId": "deleteTemplatesBytemplateID",
        "parameters": [
          {
            "in": "path",
            "name": "templateID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a saved template",
        "tags": [
          "Templates"
        ]
      }
    },
    "/v1/volumes/{volumeID}": {
      "delete": {
        "operationId": "deleteVolumesByvolumeID",
        "parameters": [
          {
            "in": "path",
            "name": "volumeID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a volume and its data (?confirm=true)",
        "tags": [
          "Data"
        ]
      },
      "patch": {
        "operationId": "patchVolumesByvolumeID",
        "parameters": [
          {
            "in": "path",
            "name": "volumeID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Resize or change backup settings",
        "tags": [
          "Data"
        ]
      }
    },
    "/v1/volumes/{volumeID}/backups": {
      "get": {
        "operationId": "getVolumesByvolumeIDBackups",
        "parameters": [
          {
            "in": "path",
            "name": "volumeID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List backups",
        "tags": [
          "Data"
        ]
      },
      "post": {
        "operationId": "postVolumesByvolumeIDBackups",
        "parameters": [
          {
            "in": "path",
            "name": "volumeID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Back up now",
        "tags": [
          "Data"
        ]
      }
    },
    "/v1/vpc/{connectorID}": {
      "delete": {
        "operationId": "deleteVpcByconnectorID",
        "parameters": [
          {
            "in": "path",
            "name": "connectorID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove the connector",
        "tags": [
          "Hangar VPC"
        ]
      },
      "patch": {
        "operationId": "patchVpcByconnectorID",
        "parameters": [
          {
            "in": "path",
            "name": "connectorID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename or change ports: {name, ports}",
        "tags": [
          "Hangar VPC"
        ]
      }
    },
    "/v1/vpc/{connectorID}/rotate-token": {
      "post": {
        "operationId": "postVpcByconnectorIDRotateToken",
        "parameters": [
          {
            "in": "path",
            "name": "connectorID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Issue a new agent token (the old one stops working)",
        "tags": [
          "Hangar VPC"
        ]
      }
    },
    "/v1/vulnerabilities/{vulnerabilityID}/fix": {
      "post": {
        "operationId": "postVulnerabilitiesByvulnerabilityIDFix",
        "parameters": [
          {
            "in": "path",
            "name": "vulnerabilityID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Apply the fix: deploy the service on the patched runtime release",
        "tags": [
          "Security"
        ]
      }
    },
    "/v1/vulnerabilities/{vulnerabilityID}/ignore": {
      "post": {
        "operationId": "postVulnerabilitiesByvulnerabilityIDIgnore",
        "parameters": [
          {
            "in": "path",
            "name": "vulnerabilityID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Hide an alert",
        "tags": [
          "Security"
        ]
      }
    },
    "/v1/vulnerabilities/{vulnerabilityID}/unignore": {
      "post": {
        "operationId": "postVulnerabilitiesByvulnerabilityIDUnignore",
        "parameters": [
          {
            "in": "path",
            "name": "vulnerabilityID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Show a hidden alert again",
        "tags": [
          "Security"
        ]
      }
    },
    "/v1/workflows/apps/{appID}": {
      "delete": {
        "operationId": "deleteWorkflowsAppsByappID",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete an app with its runs",
        "tags": [
          "Workflows"
        ]
      },
      "get": {
        "operationId": "getWorkflowsAppsByappID",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "An app",
        "tags": [
          "Workflows"
        ]
      },
      "patch": {
        "operationId": "patchWorkflowsAppsByappID",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change an app",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/apps/{appID}/runs": {
      "post": {
        "operationId": "postWorkflowsAppsByappIDRuns",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Start a run from the panel: {function, input}",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/apps/{appID}/secret": {
      "get": {
        "operationId": "getWorkflowsAppsByappIDSecret",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The signing secret",
        "tags": [
          "Workflows"
        ]
      },
      "post": {
        "operationId": "postWorkflowsAppsByappIDSecret",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Issue a new signing secret",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/apps/{appID}/sync": {
      "post": {
        "operationId": "postWorkflowsAppsByappIDSync",
        "parameters": [
          {
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Ask the endpoint which functions it serves",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/events": {
      "post": {
        "operationId": "postWorkflowsEvents",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "From a backend (hjk_): {name, match?, data?} wakes runs waiting in step.waitForEvent for that event (and match)",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/runs/{runID}": {
      "get": {
        "operationId": "getWorkflowsRunsByrunID",
        "parameters": [
          {
            "in": "path",
            "name": "runID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "A run with input, output and every step (kind run/sleep/wait, status, output, attempts)",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/runs/{runID}/cancel": {
      "post": {
        "operationId": "postWorkflowsRunsByrunIDCancel",
        "parameters": [
          {
            "in": "path",
            "name": "runID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Cancel a run",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/runs/{runID}/retry": {
      "post": {
        "operationId": "postWorkflowsRunsByrunIDRetry",
        "parameters": [
          {
            "in": "path",
            "name": "runID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Continue a failed or cancelled run from the step that failed",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/start/{app}/{function}": {
      "post": {
        "operationId": "postWorkflowsStartByappByfunction",
        "parameters": [
          {
            "in": "path",
            "name": "app",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "function",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "From a backend (Bearer hjk_): start a run, the request body is the input JSON, ?idempotency_key= returns the existing run",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workflows/status/{runID}": {
      "get": {
        "operationId": "getWorkflowsStatusByrunID",
        "parameters": [
          {
            "in": "path",
            "name": "runID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "security": [],
        "summary": "From a backend (hjk_): a run's status, output and error",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workspaces": {
      "get": {
        "operationId": "getWorkspaces",
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List workspaces",
        "tags": [
          "Workspaces"
        ]
      },
      "post": {
        "operationId": "postWorkspaces",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a workspace",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}": {
      "delete": {
        "operationId": "deleteWorkspacesByworkspaceID",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Delete a workspace and all its projects",
        "tags": [
          "Workspaces"
        ]
      },
      "get": {
        "operationId": "getWorkspacesByworkspaceID",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Get a workspace",
        "tags": [
          "Workspaces"
        ]
      },
      "patch": {
        "operationId": "patchWorkspacesByworkspaceID",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rename a workspace",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/agentics": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDAgentics",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Agent teams of the workspace with their agents and task counts",
        "tags": [
          "Agentics"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDAgentics",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a team: {name, repo_kind (hangar or github), repo (Hangar Git repository id or owner/name), base_branch}",
        "tags": [
          "Agentics"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/ai-gateways": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDAiGateways",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Gateways with their URL, provider keys (last 4 characters) and today's requests, errors and cost",
        "tags": [
          "AI Gateway"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDAiGateways",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a gateway: {name, default_provider? openai, fallbacks? [\"anthropic/claude-sonnet-4-5\"], rate_limit_rpm?, daily_budget_cents?, timeout_seconds? 300, log_bodies?, prices? {\"model\": [usd per 1M in, usd per 1M out]}}",
        "tags": [
          "AI Gateway"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/apps": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDApps",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "iOS / Android apps with their newest build",
        "tags": [
          "Mobile releases"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDApps",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add an app: {platform: ios or android, name, bundle_id, integration_id, settings?}; Hangar looks it up in the store",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/audit-log": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDAuditLog",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Audit log",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/balance": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDBalance",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Prepaid balance ledger: top-ups and invoices paid from it",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/billing": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDBilling",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Plan, usage this month, estimate, credits",
        "tags": [
          "Billing"
        ]
      },
      "patch": {
        "operationId": "patchWorkspacesByworkspaceIDBilling",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Usage limit, alert threshold, billing email",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/billing/payment-method": {
      "post": {
        "operationId": "postWorkspacesByworkspaceIDBillingPaymentMethod",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Get a page to add a card",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/billing/plan": {
      "put": {
        "operationId": "putWorkspacesByworkspaceIDBillingPlan",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change plan (owner)",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/builders": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDBuilders",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Macs connected as iOS builders: name, online, busy, macOS and Xcode versions",
        "tags": [
          "Mobile CI"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDBuilders",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Connect a Mac: {name} → the builder with its token and the command to run on the Mac (hangar builder connect …), shown once",
        "tags": [
          "Mobile CI"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/cdn-zones": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDCdnZones",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Zones of a workspace with 24-hour counters (enabled, price per GB)",
        "tags": [
          "CDN"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDCdnZones",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a zone: name, origin_kind service (service_id, environment_id, port) or url, cache settings",
        "tags": [
          "CDN"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/credits": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDCredits",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Credit grants",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/deployments": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDDeployments",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Deployments across all projects, newest first (?status=failed",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/dns-zones": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDDnsZones",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The workspace's domains in Hangar DNS: delegation status (pending/active), name servers seen, record count, 24-hour queries",
        "tags": [
          "DNS"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDDnsZones",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add a domain: {name, import? (default true: copy today's common records from public DNS)}; returns {zone, imported}",
        "tags": [
          "DNS"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/domains": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDDomains",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "All domains of the workspace with their project, service and certificate status",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/github/confirm": {
      "post": {
        "operationId": "postWorkspacesByworkspaceIDGithubConfirm",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Confirm linking an installation",
        "tags": [
          "GitHub"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/github/install-url": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDGithubInstallUrl",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "URL to install the GitHub App",
        "tags": [
          "GitHub"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/github/installations": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDGithubInstallations",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Linked installations",
        "tags": [
          "GitHub"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/github/installations/{installationID}": {
      "delete": {
        "operationId": "deleteWorkspacesByworkspaceIDGithubInstallationsByinstallationID",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "installationID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Unlink an installation",
        "tags": [
          "GitHub"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/github/repos": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDGithubRepos",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Repositories available to deploy",
        "tags": [
          "GitHub"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/home": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDHome",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Home page: counts, live load (24 h), problems needing attention, recent deployments, plan",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/hosting": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDHosting",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Classic web hosting (ISPmanager): plans, the workspace's accounts with disk use and sites, whether paid plans are open",
        "tags": [
          "Hosting"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDHosting",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Order hosting: {plan: free",
        "tags": [
          "Hosting"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/hosting-waitlist": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDHostingWaitlist",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Classic web hosting (pre-release): whether the user signed up for early access, and how many did",
        "tags": [
          "Hosting"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDHostingWaitlist",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Sign up for early access to classic web hosting",
        "tags": [
          "Hosting"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/integrations": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDIntegrations",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "App Store Connect / Google Play / AI provider credentials of the workspace (secrets are never returned)",
        "tags": [
          "Mobile releases"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDIntegrations",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Connect a service: {kind: apple, issuer_id, key_id, private_key (.p8)} · {kind: google, service_account_json} · {kind: ai, base_url, model, api_key}; the credentials are checked against the service (admin)",
        "tags": [
          "Mobile releases"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/invites": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDInvites",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List pending invitations",
        "tags": [
          "Workspaces"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDInvites",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Invite by email",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/invites/{inviteID}": {
      "delete": {
        "operationId": "deleteWorkspacesByworkspaceIDInvitesByinviteID",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "inviteID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Revoke an invitation",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/invoices": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDInvoices",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Invoices",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/jobs/keys": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDJobsKeys",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Keys for backends (hjk_)",
        "tags": [
          "Jobs"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDJobsKeys",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a key: {name} → {key} once",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/jobs/messages": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDJobsMessages",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Runs, newest first: ?queue=\u0026status=queued,running,succeeded,failed,cancelled\u0026before=\u0026limit=",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/jobs/queues": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDJobsQueues",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Queues with their target (a service of a project or a URL) and counts: queued, running, succeeded/failed in 24 h",
        "tags": [
          "Jobs"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDJobsQueues",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a queue: {name, target: {url} or {service_id, environment_id?, port?, path?}, method? POST, concurrency? 5, max_retries? 5, backoff_seconds? 10, timeout_seconds? 60} → with its signing secret",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/jobs/schedules": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDJobsSchedules",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Cron schedules",
        "tags": [
          "Jobs"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDJobsSchedules",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a schedule: {name, queue_id, cron (5 fields or @hourly, @daily…), timezone? UTC, body?, content_type?}",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/jobs/stats": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDJobsStats",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Last 24 hours by hour (succeeded, failed), queued, running, average duration",
        "tags": [
          "Jobs"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/mail": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDMail",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Every mail domain of the workspace with DNS records, status and today's usage",
        "tags": [
          "Email"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/members": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDMembers",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List members",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/members/{userID}": {
      "delete": {
        "operationId": "deleteWorkspacesByworkspaceIDMembersByuserID",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "userID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Remove a member",
        "tags": [
          "Workspaces"
        ]
      },
      "patch": {
        "operationId": "patchWorkspacesByworkspaceIDMembersByuserID",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "userID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Change a member's role",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/networks": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDNetworks",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Hangar Network: the workspace's private networks with counts (services, devices, online, active grants), the next free range (suggested_cidr) and whether networks are enabled",
        "tags": [
          "Networks"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDNetworks",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a network: {name, slug?, description?, cidr? (private IPv4 /16–/28, default the next free 10.88.N.0/24)}; its gateway (own WireGuard key and public UDP port) starts in the background",
        "tags": [
          "Networks"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/notifications": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDNotifications",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Your email notification preferences",
        "tags": [
          "Workspaces"
        ]
      },
      "put": {
        "operationId": "putWorkspacesByworkspaceIDNotifications",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Set email notification preferences",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/previews": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDPreviews",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Pull request previews of the workspace (status, links per service, PR title/author/commit) and the projects that can have them (pr_environments_enabled, repos)",
        "tags": [
          "Previews"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/projects": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDProjects",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "List projects",
        "tags": [
          "Projects"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDProjects",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a project (with a production environment)",
        "tags": [
          "Projects"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/realtime": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDRealtime",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Realtime endpoints (TURN, SFU, MoQ, meetings) and the workspace's realtime apps",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/realtime/apps": {
      "post": {
        "operationId": "postWorkspacesByworkspaceIDRealtimeApps",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create an app: {kind (turn, sfu, kit or moq), name}; the hrt_ token is returned once",
        "tags": [
          "Realtime"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/report": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDReport",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Report for the last ?days=N (default 30): per-day deployments, CPU, memory, requests, errors, cost; per-project totals; top services; failures",
        "tags": [
          "Workspaces"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/repos": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDRepos",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Repositories hosted by Hangar, with clone_url (https://\u003capi\u003e/git/\u003cworkspace\u003e/\u003cname\u003e.git), size, last push and how many services deploy from them",
        "tags": [
          "Hangar Git"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDRepos",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Create a repository: {name, description?, default_branch? (main), project_id? (its project tokens may push), import_github? \"owner/name\" or import_url? (public https git URL) to copy every branch and tag}",
        "tags": [
          "Hangar Git"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/storages": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDStorages",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rented cloud storages with usage, free capacity and price per GB",
        "tags": [
          "Storage"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDStorages",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Rent a cloud storage (name, quota_gb, region)",
        "tags": [
          "Storage"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/templates": {
      "post": {
        "operationId": "postWorkspacesByworkspaceIDTemplates",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Save a template",
        "tags": [
          "Templates"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/usage": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDUsage",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Usage by meter, project or service",
        "tags": [
          "Billing"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/workflows/apps": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDWorkflowsApps",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Workflow apps: endpoints serving workflow functions with the SDK, their functions and run counts",
        "tags": [
          "Workflows"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDWorkflowsApps",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Add an app: {name, target: {url} or {service_id, environment_id?, port?, path?}, timeout_seconds? 300, max_retries? 3, backoff_seconds? 10} → with its secret (WORKFLOW_SECRET)",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/workflows/events": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDWorkflowsEvents",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "The last 100 events and how many runs each woke",
        "tags": [
          "Workflows"
        ]
      },
      "post": {
        "operationId": "postWorkspacesByworkspaceIDWorkflowsEvents",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Send an event from the panel: {name, match?, data?}",
        "tags": [
          "Workflows"
        ]
      }
    },
    "/v1/workspaces/{workspaceID}/workflows/runs": {
      "get": {
        "operationId": "getWorkspacesByworkspaceIDWorkflowsRuns",
        "parameters": [
          {
            "in": "path",
            "name": "workspaceID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "2XX": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            },
            "description": "Error"
          }
        },
        "summary": "Runs, newest first: ?app=\u0026function=\u0026status=queued,running,sleeping,waiting,completed,failed,cancelled\u0026before=\u0026limit=",
        "tags": [
          "Workflows"
        ]
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "servers": [
    {
      "url": "/"
    }
  ],
  "tags": [
    {
      "name": "AI Gateway"
    },
    {
      "name": "Admin"
    },
    {
      "name": "Agentics"
    },
    {
      "name": "Auth"
    },
    {
      "name": "Billing"
    },
    {
      "name": "CDN"
    },
    {
      "name": "CDN edge"
    },
    {
      "name": "CLI"
    },
    {
      "name": "DNS"
    },
    {
      "name": "DNS servers"
    },
    {
      "name": "Data"
    },
    {
      "name": "Database"
    },
    {
      "name": "Deployments"
    },
    {
      "name": "Email"
    },
    {
      "name": "Environments"
    },
    {
      "name": "GitHub"
    },
    {
      "name": "Hangar Git"
    },
    {
      "name": "Hangar VPC"
    },
    {
      "name": "Hosting"
    },
    {
      "name": "Hosting plugin"
    },
    {
      "name": "Jobs"
    },
    {
      "name": "Mobile CI"
    },
    {
      "name": "Mobile releases"
    },
    {
      "name": "Networking"
    },
    {
      "name": "Networks"
    },
    {
      "name": "Observability"
    },
    {
      "name": "Previews"
    },
    {
      "name": "Projects"
    },
    {
      "name": "Protection"
    },
    {
      "name": "Push"
    },
    {
      "name": "Realtime"
    },
    {
      "name": "Regions"
    },
    {
      "name": "Security"
    },
    {
      "name": "Services"
    },
    {
      "name": "Sessions"
    },
    {
      "name": "Status"
    },
    {
      "name": "Storage"
    },
    {
      "name": "Storage files"
    },
    {
      "name": "System"
    },
    {
      "name": "Templates"
    },
    {
      "name": "Tokens"
    },
    {
      "name": "Users"
    },
    {
      "name": "Variables"
    },
    {
      "name": "Webhooks"
    },
    {
      "name": "Workflows"
    },
    {
      "name": "Workspaces"
    }
  ]
}