sealgate-ai API Keys API

openapi: 3.2.0
info:
  title: Sealgate Ai API Keys API
  x-refined-note:
  - x-source-of-truth differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged API Keys across 3 of this provider''s published API definitions: sealgate-ai-openapi.json, sealgate-ai-dashboard-openapi.json, sealgate-ai-management-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dashboard.sealgate.ai
  description: SealGate management API - release
- url: https://demo-dashboard.sealgate.ai
  description: SealGate management API - demo
tags:
- name: API Keys
  description: Enable, disable, and re-role API keys.
paths:
  /api/v1/api-keys/{api_key_param}/status:
    parameters:
    - name: api_key_param
      in: path
      required: true
      description: The target API key to modify
      schema:
        type: string
    patch:
      tags:
      - API Keys
      summary: Enable or disable an API key
      description: Set an API key's active status. Requires the admin role.
      operationId: updateApiKeyStatus
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateApiKeyStatusRequest'
      responses:
        '200':
          description: Updated status (API key returned masked)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiKeyStatusResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
      - bearerAuth: []
    servers:
    - url: https://dashboard.sealgate.ai
      description: SealGate management API - release
    - url: https://demo-dashboard.sealgate.ai
      description: SealGate management API - demo
  /api/v1/api-keys/{api_key_param}/role:
    parameters:
    - name: api_key_param
      in: path
      required: true
      description: The target API key to modify
      schema:
        type: string
    patch:
      tags:
      - API Keys
      summary: Change an API key's role
      description: Change an API key's role (admin, user, owner). Requires the admin role.
      operationId: updateApiKeyRole
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateApiKeyRoleRequest'
      responses:
        '200':
          description: Updated role (API key returned masked)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiKeyRoleResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
      - bearerAuth: []
    servers:
    - url: https://dashboard.sealgate.ai
      description: SealGate management API - release
    - url: https://demo-dashboard.sealgate.ai
      description: SealGate management API - demo
components:
  schemas:
    UpdateApiKeyStatusRequest:
      type: object
      properties:
        is_active:
          type: boolean
          description: New active status for the API key
      required:
      - is_active
    UpdateApiKeyRoleResponse:
      type: object
      properties:
        status:
          type: string
          default: success
        api_key:
          type: string
          description: Masked API key
        role:
          type: string
          description: New role
      required:
      - status
      - api_key
      - role
    HTTPValidationError:
      type: object
      description: Body returned for a 422 request-validation failure.
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    UpdateApiKeyRoleRequest:
      type: object
      properties:
        role:
          type: string
          description: New role for the API key (admin, user, owner)
      required:
      - role
    ErrorDetail:
      type: object
      description: Application error body carried under `detail`.
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: Machine-readable error code
        details:
          type:
          - object
          - 'null'
          description: Additional error details
          additionalProperties: true
      required:
      - error
      - code
    ValidationError:
      type: object
      description: A single request-validation error.
      properties:
        loc:
          type: array
          items:
            type:
            - string
            - integer
          description: Location of the invalid field
        msg:
          type: string
          description: Validation error message
        type:
          type: string
          description: Validation error type
      required:
      - loc
      - msg
      - type
    UpdateApiKeyStatusResponse:
      type: object
      properties:
        status:
          type: string
          default: success
        api_key:
          type: string
          description: Masked API key
        is_active:
          type: boolean
      required:
      - status
      - api_key
      - is_active
    ErrorResponse:
      type: object
      description: Standard error envelope returned on 4xx and 5xx responses.
      properties:
        detail:
          $ref: '#/components/schemas/ErrorDetail'
      required:
      - detail
    ValidationError_2:
      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_2:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError_2'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UpdateApiKeyStatusResponse_2:
      properties:
        status:
          type: string
          title: Status
          description: Operation result
          default: success
        api_key:
          type: string
          title: Api Key
          description: Masked API key
        is_active:
          type: boolean
          title: Is Active
          description: New active status
      type: object
      required:
      - api_key
      - is_active
      title: UpdateApiKeyStatusResponse
    UpdateApiKeyStatusRequest_2:
      properties:
        is_active:
          type: boolean
          title: Is Active
          description: New active status for the API key
      type: object
      required:
      - is_active
      title: UpdateApiKeyStatusRequest
  responses:
    Forbidden:
      description: The caller's role is not permitted to perform this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: The request was invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: SealGate API key
      description: 'SealGate API key sent as `Authorization: Bearer <your-sealgate-api-key>`.'
    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.
externalDocs:
  description: SealGate product documentation
  url: https://docs.sealgate.ai
x-refined-from:
- sealgate-ai-openapi.json
- sealgate-ai-dashboard-openapi.json
- sealgate-ai-management-openapi.json