sealgate-ai Templates API

openapi: 3.2.0
info:
  title: SealGate Templates API
  description: Open-source MCP security, aggregation, and monitoring. Self-hosted MCP proxy.
  version: 0.19.0
tags:
- name: Templates
paths:
  /api/v1/templates/servers:
    get:
      summary: List All Template Configs
      description: Get all admin template configurations.
      operationId: list_all_template_configs_api_v1_templates_servers_get
      security:
      - HTTPBearer: []
      parameters:
      - 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)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllAdminTemplateConfigsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Templates
  /api/v1/templates/servers/{name}:
    get:
      summary: Get Template Config
      description: Get admin template configuration for a specific server.
      operationId: get_template_config_api_v1_templates_servers__name__get
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      - 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)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminTemplateConfigResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Templates
    put:
      summary: Set Template Config
      description: Set or update admin template configuration for a server.
      operationId: set_template_config_api_v1_templates_servers__name__put
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      - 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/SetAdminTemplateConfigRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminTemplateConfigResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Templates
    delete:
      summary: Delete Template Config
      description: Delete admin template configuration for a server; only field *key*'s value when given.
      operationId: delete_template_config_api_v1_templates_servers__name__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      - name: key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      - 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)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminTemplateConfigResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Templates
  /api/v1/templates/servers/{name}/set-by-user:
    put:
      summary: Update Set By User
      description: Toggle whether template fields are set by user or admin.
      operationId: update_set_by_user_api_v1_templates_servers__name__set_by_user_put
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      - 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/UpdateSetByUserRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSetByUserResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Templates
  /api/v1/templates/servers/{name}/fields/{field_key}/required:
    put:
      summary: Update Field Required
      description: Toggle whether a template field is required or optional.
      operationId: update_field_required_api_v1_templates_servers__name__fields__field_key__required_put
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      - name: field_key
        in: path
        required: true
        schema:
          type: string
          title: Field Key
      - 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/UpdateFieldRequiredRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFieldRequiredResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Templates
  /api/v1/templates/servers/{name}/fields/{field_key}/set-by-user:
    put:
      summary: Update Field Set By User
      description: Toggle whether a single template field is set by user or admin.
      operationId: update_field_set_by_user_api_v1_templates_servers__name__fields__field_key__set_by_user_put
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      - name: field_key
        in: path
        required: true
        schema:
          type: string
          title: Field Key
      - 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/UpdateFieldSetByUserRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFieldSetByUserResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Templates
  /api/v1/templates/servers/{name}/verify-credentials:
    post:
      summary: Verify Credentials
      description: Save credentials for verification, then return them for testing.
      operationId: verify_credentials_api_v1_templates_servers__name__verify_credentials_post
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      - 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/VerifyCredentialsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyCredentialsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Templates
components:
  schemas:
    AdminTemplateConfigResponse:
      properties:
        status:
          type: string
          title: Status
          description: Operation result
          default: ok
        server_name:
          type: string
          title: Server Name
          description: MCP server name
        config:
          additionalProperties: true
          type: object
          title: Config
          description: Current configuration
      type: object
      required:
      - server_name
      title: AdminTemplateConfigResponse
      description: Response for admin template config operations.
    UpdateFieldRequiredResponse:
      properties:
        status:
          type: string
          title: Status
          description: Operation result
          default: ok
        server_name:
          type: string
          title: Server Name
          description: MCP server name
        template_key:
          type: string
          title: Template Key
          description: Template field key
        required:
          type: boolean
          title: Required
          description: Updated required flag
      type: object
      required:
      - server_name
      - template_key
      - required
      title: UpdateFieldRequiredResponse
      description: Response for field required update.
    UpdateSetByUserRequest:
      properties:
        set_by_user:
          type: boolean
          title: Set By User
          description: True = users provide values; False = admin provides values
      type: object
      required:
      - set_by_user
      title: UpdateSetByUserRequest
      description: Request to toggle whether template fields are set by user or admin.
    SetAdminTemplateConfigRequest:
      properties:
        config:
          additionalProperties:
            type: string
          type: object
          title: Config
          description: Template values for the server
      type: object
      required:
      - config
      title: SetAdminTemplateConfigRequest
      description: Request body for setting admin template configuration.
    VerifyCredentialsRequest:
      properties:
        config:
          additionalProperties:
            type: string
          type: object
          title: Config
          description: Credential key-value pairs to verify
      type: object
      required:
      - config
      title: VerifyCredentialsRequest
      description: Request body for saving credentials for verification.
    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
    VerifyCredentialsResponse:
      properties:
        status:
          type: string
          title: Status
          description: Operation result
          default: ok
        server_name:
          type: string
          title: Server Name
          description: MCP server name
        config:
          additionalProperties: true
          type: object
          title: Config
          description: Credential data
      type: object
      required:
      - server_name
      title: VerifyCredentialsResponse
      description: Response for credential verification operations.
    UpdateFieldSetByUserResponse:
      properties:
        status:
          type: string
          title: Status
          description: Operation result
          default: ok
        server_name:
          type: string
          title: Server Name
          description: MCP server name
        template_key:
          type: string
          title: Template Key
          description: Template field key
        set_by_user:
          type: boolean
          title: Set By User
          description: Updated set_by_user flag
      type: object
      required:
      - server_name
      - template_key
      - set_by_user
      title: UpdateFieldSetByUserResponse
      description: Response for per-field set-by-user update.
    UpdateSetByUserResponse:
      properties:
        status:
          type: string
          title: Status
          description: Operation result
          default: ok
        server_name:
          type: string
          title: Server Name
          description: MCP server name
        set_by_user:
          type: boolean
          title: Set By User
          description: Updated set_by_user flag
      type: object
      required:
      - server_name
      - set_by_user
      title: UpdateSetByUserResponse
      description: Response for set-by-user update.
    UpdateFieldRequiredRequest:
      properties:
        required:
          type: boolean
          title: Required
          description: True = field is required; False = field is optional
      type: object
      required:
      - required
      title: UpdateFieldRequiredRequest
      description: Request to toggle whether a template field is required or optional.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AllAdminTemplateConfigsResponse:
      properties:
        configs:
          additionalProperties: true
          type: object
          title: Configs
          description: Admin configs keyed by server name
      type: object
      required:
      - configs
      title: AllAdminTemplateConfigsResponse
      description: Response listing all admin template configurations.
    UpdateFieldSetByUserRequest:
      properties:
        set_by_user:
          type: boolean
          title: Set By User
          description: True = user provides value; False = admin provides value
      type: object
      required:
      - set_by_user
      title: UpdateFieldSetByUserRequest
      description: Request to toggle whether a single template field is set by user or admin.
  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.