sealgate-ai Devices API

openapi: 3.2.0
info:
  title: SealGate Devices API
  description: Open-source MCP security, aggregation, and monitoring. Self-hosted MCP proxy.
  version: 0.19.0
tags:
- name: Devices
paths:
  /api/v1/devices/{device_ref_id}/scope:
    patch:
      summary: Set Device Scope
      description: 'Flip a device between personal and shared scope (admin + step-up).


        Same step-up gate as stdio_tunnel server creation: scope changes alter

        who can execute commands on a real machine, so they require a freshly

        re-authenticated admin.'
      operationId: set_device_scope_api_v1_devices__device_ref_id__scope_patch
      security:
      - HTTPBearer: []
      parameters:
      - name: device_ref_id
        in: path
        required: true
        schema:
          type: integer
          title: Device Ref Id
      - name: domain
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Org to view (Super-Owner only, read-only)
          title: Domain
        description: Org to view (Super-Owner only, read-only)
      - name: Idempotency-Key
        in: header
        required: false
        description: Optional client-generated key that makes this write operation safe to retry. Reusing the same key returns the original response instead of performing the operation a second time. Keys are scoped to the caller and expire after 24 hours.
        schema:
          type: string
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetDeviceScopeRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetDeviceScopeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Devices
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SetDeviceScopeResponse:
      properties:
        id:
          type: integer
          title: Id
        scope:
          type: string
          title: Scope
        previous_scope:
          type: string
          title: Previous Scope
        affected_servers:
          items:
            type: string
          type: array
          title: Affected Servers
          description: Names of this device's stdio_tunnel servers whose enablement rows were rewritten (demotion only; promotion touches none).
      type: object
      required:
      - id
      - scope
      - previous_scope
      title: SetDeviceScopeResponse
    SetDeviceScopeRequest:
      properties:
        scope:
          type: string
          title: Scope
          description: 'One of: personal, shared.'
        force:
          type: boolean
          title: Force
          description: 'Demotion only: confirm deleting the non-owner enablement rows that sharing accumulated. Without it, demoting a device whose servers have role/user/global grants beyond the owner is rejected with 409 so the dashboard can show what would be lost.'
          default: false
      type: object
      required:
      - scope
      title: SetDeviceScopeRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    ClientBearer:
      type: http
      description: Opaque ewc_ client installation credential
      scheme: bearer
    ServiceToken:
      type: http
      description: 'A SealGate service token: `sgt_acct_...` (account token) or `sgt_org_...` (org token). Mint an account token in the dashboard.'
      scheme: bearer
    MCPGatewayOAuth:
      type: oauth2
      description: OAuth 2.1 authorization-code flow (PKCE required) against the SealGate MCP gateway's authorization server. Request only the scopes an agent needs; unrequested scopes are not granted.
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          refreshUrl: /oauth/token
          scopes:
            mcp: Connect to the MCP gateway and call the tools exposed by your enabled servers. Every call is still evaluated by the policy engine.
            offline_access: Issue a refresh token so the client can renew access without a new browser sign-in.