Spectro Cloud overlords API

The overlords API from Spectro Cloud — 29 operation(s) for overlords.

Operations 40

GET /v1/overlords Retrieves a list of overlords owned by the tenant #
GET /v1/overlords/apache-cloudstack/manifest Returns the manifests required for the private gateway installation #
POST /v1/overlords/apache-cloudstack/{uid}/account create the CloudStack cloudaccount for the private gateway #
PUT /v1/overlords/apache-cloudstack/{uid}/account update the CloudStack cloudaccount for the private gateway #
POST /v1/overlords/apache-cloudstack/{uid}/account/validate validate the CloudStack cloudaccount for the private gateway #
POST /v1/overlords/apache-cloudstack/{uid}/cloudconfig create the CloudStack cloud config for the private gateway #
PUT /v1/overlords/apache-cloudstack/{uid}/cloudconfig update the CloudStack cloud config for the private gateway #
GET /v1/overlords/apache-cloudstack/{uid}/clusterprofile Returns the specified CloudStack private gateway cluster profile #
GET /v1/overlords/maas/manifest Returns the manifests required for the private gateway installation #
POST /v1/overlords/maas/{uid}/account create the maas cloudaccount for the private gateway #
PUT /v1/overlords/maas/{uid}/account update the maas cloudaccount for the private gateway #
POST /v1/overlords/maas/{uid}/account/validate validate the maas cloudaccount for the private gateway #
POST /v1/overlords/maas/{uid}/cloudconfig create the maas cloud config for the private gateway #
PUT /v1/overlords/maas/{uid}/cloudconfig update the maas cloud config for the private gateway #
GET /v1/overlords/maas/{uid}/clusterprofile Returns the specified maas private gateway cluster profile #
GET /v1/overlords/maas/{uid}/pools Retrieves a list of IP Pools for the specified maas private gateway #
POST /v1/overlords/maas/{uid}/pools Creates an IP pool definition for the specified maas private gateway #
DELETE /v1/overlords/maas/{uid}/pools/{poolUid} Deletes the maas private gateway's specified IP Pool data #
PUT /v1/overlords/maas/{uid}/pools/{poolUid} Updates the maas private gateway's specified IP Pool data #
POST /v1/overlords/migrate migrate all the clusters from source overlord to target overlord #
GET /v1/overlords/pairing/code Returns the pairing code for the private gateway #
GET /v1/overlords/vsphere/manifest Returns the manifests required for the private gateway installation #
GET /v1/overlords/vsphere/ova Returns overlord's ova information #
POST /v1/overlords/vsphere/tenants/{tenantUid}/system Creates the system private gateway for the specified tenant #
POST /v1/overlords/vsphere/{uid}/account create the vSphere cloudaccount for the private gateway #
PUT /v1/overlords/vsphere/{uid}/account update the vSphere cloudaccount for the private gateway #
POST /v1/overlords/vsphere/{uid}/account/validate validate the vSphere cloudaccount for the private gateway #
POST /v1/overlords/vsphere/{uid}/cloudconfig create the vSphere cloud config for the private gateway #
PUT /v1/overlords/vsphere/{uid}/cloudconfig update the vSphere cloud config for the private gateway #
GET /v1/overlords/vsphere/{uid}/clusterprofile Returns the specified vsphere private gateway cluster profile #
GET /v1/overlords/vsphere/{uid}/pools Retrieves a list of IP Pools for the specified private gateway #
POST /v1/overlords/vsphere/{uid}/pools Creates an IP pool defintion for the sepcified private gateway #
DELETE /v1/overlords/vsphere/{uid}/pools/{poolUid} Deletes the private gateways's specified IP Pool data #
PUT /v1/overlords/vsphere/{uid}/pools/{poolUid} Updates the private gateways's specified IP Pool data #
GET /v1/overlords/vsphere/{uid}/properties/computecluster/resources Retrieves the vSphere computecluster resources for the specified private gateway's account #
GET /v1/overlords/vsphere/{uid}/properties/datacenters Retrieves the vSphere datacenters & datacluster for the specified private gateway's account #
DELETE /v1/overlords/{uid} delete the private gateway #
GET /v1/overlords/{uid} Returns the specified private gateway's for the given uid #
PUT /v1/overlords/{uid}/metadata update the private gateway's metadata #
PUT /v1/overlords/{uid}/reset reset the private gateway by disaaociating the private gateway's resources #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/spectro-cloud-overlords-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spectro-cloud-overlords-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Local Management APIs activations Overlords API
  version: v1
servers:
- url: https://edge-host-ip:5080
tags:
- name: overlords
  x-displayName: Overlords
paths:
  /v1/overlords:
    get:
      operationId: v1OverlordsList
      parameters:
      - in: query
        name: name
        schema:
          type: string
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Overlords'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Retrieves a list of overlords owned by the tenant
      tags:
      - overlords
  /v1/overlords/apache-cloudstack/manifest:
    parameters:
    - in: query
      name: pairingCode
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsCloudStackManifest
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1OverlordManifest'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the manifests required for the private gateway installation
      tags:
      - overlords
  /v1/overlords/apache-cloudstack/{uid}/account:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: v1OverlordsUidCloudStackAccountCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create the CloudStack cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordCloudStackAccountCreate'
    put:
      operationId: v1OverlordsUidCloudStackAccountUpdate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: update the CloudStack cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordCloudStackAccountEntity'
  /v1/overlords/apache-cloudstack/{uid}/account/validate:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      description: Validates CloudStack account credentials and domain. Verifies API connectivity and that the specified domain exists.
      operationId: v1OverlordsUidCloudStackAccountValidate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: validate the CloudStack cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              properties:
                account:
                  $ref: '#/components/schemas/v1CloudStackCloudAccount'
  /v1/overlords/apache-cloudstack/{uid}/cloudconfig:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: v1OverlordsUidCloudStackCloudConfigCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create the CloudStack cloud config for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordCloudStackCloudConfig'
    put:
      operationId: v1OverlordsUidCloudStackCloudConfigUpdate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: update the CloudStack cloud config for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordCloudStackCloudConfig'
  /v1/overlords/apache-cloudstack/{uid}/clusterprofile:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsUidCloudStackClusterProfile
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ClusterProfile'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the specified CloudStack private gateway cluster profile
      tags:
      - overlords
  /v1/overlords/maas/manifest:
    parameters:
    - in: query
      name: pairingCode
      required: true
      schema:
        type: string
    get:
      operationId: V1OverlordsMaasManifest
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1OverlordManifest'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the manifests required for the private gateway installation
      tags:
      - overlords
  /v1/overlords/maas/{uid}/account:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: v1OverlordsUidMaasAccountCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create the maas cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordMaasAccountCreate'
    put:
      operationId: v1OverlordsUidMaasAccountUpdate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: update the maas cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordMaasAccountEntity'
  /v1/overlords/maas/{uid}/account/validate:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: v1OverlordsUidMaasAccountValidate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: validate the maas cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              properties:
                account:
                  $ref: '#/components/schemas/v1MaasCloudAccount'
  /v1/overlords/maas/{uid}/cloudconfig:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: V1OverlordsUidMaasCloudConfigCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create the maas cloud config for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordMaasCloudConfig'
    put:
      operationId: V1OverlordsUidMaasCloudConfigUpdate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: update the maas cloud config for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordMaasCloudConfig'
  /v1/overlords/maas/{uid}/clusterprofile:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsUidMaasClusterProfile
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ClusterProfile'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the specified maas private gateway cluster profile
      tags:
      - overlords
  /v1/overlords/maas/{uid}/pools:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsUidMaasPoolsList
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1IpPools'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Retrieves a list of IP Pools for the specified maas private gateway
      tags:
      - overlords
    post:
      operationId: v1OverlordsUidMaasPoolCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Creates an IP pool definition for the specified maas private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1IpPoolInputEntity'
  /v1/overlords/maas/{uid}/pools/{poolUid}:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    - in: path
      name: poolUid
      required: true
      schema:
        type: string
    delete:
      operationId: v1OverlordsUidMaasPoolDelete
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the maas private gateway's specified IP Pool data
      tags:
      - overlords
    put:
      operationId: v1OverlordsUidMaasPoolUpdate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Updates the maas private gateway's specified IP Pool data
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1IpPoolInputEntity'
  /v1/overlords/migrate:
    post:
      operationId: V1OverlordsMigrate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: migrate all the clusters from source overlord to target overlord
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordMigrateEntity'
  /v1/overlords/pairing/code:
    get:
      operationId: v1OverlordsPairingCode
      parameters:
      - in: query
        name: cloudType
        schema:
          type: string
          enum:
          - vsphere
          - maas
          - apache-cloudstack
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1PairingCode'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the pairing code for the private gateway
      tags:
      - overlords
  /v1/overlords/vsphere/manifest:
    parameters:
    - in: query
      name: pairingCode
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsVsphereManifest
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1OverlordManifest'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the manifests required for the private gateway installation
      tags:
      - overlords
  /v1/overlords/vsphere/ova:
    get:
      operationId: v1OverlordsVsphereOvaGet
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1OverloadVsphereOva'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns overlord's ova information
      tags:
      - overlords
  /v1/overlords/vsphere/tenants/{tenantUid}/system:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    post:
      operationId: v1OverlordsSystem
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Creates the system private gateway for the specified tenant
      tags:
      - overlords
  /v1/overlords/vsphere/{uid}/account:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: v1OverlordsUidVsphereAccountCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create the vSphere cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordVsphereAccountCreate'
    put:
      operationId: v1OverlordsUidVsphereAccountUpdate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: update the vSphere cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordVsphereAccountEntity'
  /v1/overlords/vsphere/{uid}/account/validate:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: v1OverlordsUidVsphereAccountValidate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: validate the vSphere cloudaccount for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              properties:
                account:
                  $ref: '#/components/schemas/v1VsphereCloudAccount'
  /v1/overlords/vsphere/{uid}/cloudconfig:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    post:
      operationId: v1OverlordsUidVsphereCloudConfigCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create the vSphere cloud config for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordVsphereCloudConfig'
    put:
      operationId: v1OverlordsUidVsphereCloudConfigUpdate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: update the vSphere cloud config for the private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1OverlordVsphereCloudConfig'
  /v1/overlords/vsphere/{uid}/clusterprofile:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsUidVsphereClusterProfile
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ClusterProfile'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the specified vsphere private gateway cluster profile
      tags:
      - overlords
  /v1/overlords/vsphere/{uid}/pools:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsUidPoolsList
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1IpPools'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Retrieves a list of IP Pools for the specified private gateway
      tags:
      - overlords
    post:
      operationId: v1OverlordsUidPoolCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Creates an IP pool defintion for the sepcified private gateway
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1IpPoolInputEntity'
  /v1/overlords/vsphere/{uid}/pools/{poolUid}:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    - in: path
      name: poolUid
      required: true
      schema:
        type: string
    delete:
      operationId: v1OverlordsUidPoolDelete
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the private gateways's specified IP Pool data
      tags:
      - overlords
    put:
      operationId: v1OverlordsUidPoolUpdate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Updates the private gateways's specified IP Pool data
      tags:
      - overlords
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1IpPoolInputEntity'
  /v1/overlords/vsphere/{uid}/properties/computecluster/resources:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    - in: query
      name: datacenter
      required: true
      schema:
        type: string
    - in: query
      name: computecluster
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsUidVsphereComputeclusterRes
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1VsphereComputeClusterResources'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Retrieves the vSphere computecluster resources for the specified private gateway's account
      tags:
      - overlords
  /v1/overlords/vsphere/{uid}/properties/datacenters:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    get:
      operationId: v1OverlordsUidVsphereDatacenters
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1VsphereDatacenters'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Retrieves the vSphere datacenters & datacluster for the specified private gateway's account
      tags:
      - overlords
  /v1/overlords/{uid}:
    parameters:
    - in: path
      name: uid
      required: true
      schema:
        type: string
    delete:
      operationId: v1OverlordsUidDelete
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1DeletedMsg'
      security:
      - ApiKey: []
      - Authorization: []
      summary: delete the private gateway
      tags:
      - overlords
    get:
      operationId: v1OverlordsUidGet
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          content:
            application/json:
          

# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-overlords-api-openapi.yml