openapi: 3.0.3
info:
  title: Tetrate Service Bridge REST APIs Gateway Groups API
  description: The Tetrate Service Bridge (TSB) REST API provides programmatic management of the TSB control plane. It exposes endpoints for managing organizations, tenants, workspaces, cluster onboarding, gateway configuration, traffic routing, security policies, and application/API lifecycle management across multi-cluster, multi-cloud service mesh environments. The API uses Protobuf-backed REST resources and supports standard CRUD operations via HTTP verbs.
  version: '2.0'
  contact:
    name: Tetrate
    url: https://tetrate.io/
  license:
    name: Proprietary
    url: https://tetrate.io/
servers:
- url: https://{tsb-host}:8443/v2
  description: TSB Management Plane REST API
  variables:
    tsb-host:
      default: tsb.example.com
      description: Hostname of your TSB management plane
security:
- BasicAuth: []
- JWTToken: []
tags:
- name: Gateway Groups
  description: Manage gateway groups and ingress/egress gateways
paths:
  /organizations/{organization}/tenants/{tenant}/workspaces/{workspace}/gatewaygroups:
    get:
      operationId: listGatewayGroups
      summary: List Gateway Groups
      description: Returns all gateway groups within a workspace.
      tags:
      - Gateway Groups
      parameters:
      - $ref: '#/components/parameters/organization'
      - $ref: '#/components/parameters/tenant'
      - $ref: '#/components/parameters/workspace'
      responses:
        '200':
          description: List of gateway groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayGroupList'
    post:
      operationId: createGatewayGroup
      summary: Create Gateway Group
      description: Creates a new gateway group within a workspace.
      tags:
      - Gateway Groups
      parameters:
      - $ref: '#/components/parameters/organization'
      - $ref: '#/components/parameters/tenant'
      - $ref: '#/components/parameters/workspace'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayGroup'
      responses:
        '200':
          description: Created gateway group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayGroup'
components:
  parameters:
    tenant:
      name: tenant
      in: path
      required: true
      description: Tenant name
      schema:
        type: string
    workspace:
      name: workspace
      in: path
      required: true
      description: Workspace name
      schema:
        type: string
    organization:
      name: organization
      in: path
      required: true
      description: Organization name
      schema:
        type: string
  schemas:
    ResourceMeta:
      type: object
      properties:
        name:
          type: string
          description: Resource name (1-63 chars, lowercase alphanumeric with hyphens)
        fqn:
          type: string
          description: Fully-qualified name
        displayName:
          type: string
        description:
          type: string
        etag:
          type: string
          description: Version tag for optimistic concurrency
        labels:
          type: object
          additionalProperties:
            type: string
        annotations:
          type: object
          additionalProperties:
            type: string
    GatewayGroupList:
      type: object
      properties:
        gatewayGroups:
          type: array
          items:
            $ref: '#/components/schemas/GatewayGroup'
    GatewayGroup:
      allOf:
      - $ref: '#/components/schemas/ResourceMeta'
      type: object
      properties:
        spec:
          type: object
          properties:
            namespaceSelector:
              type: object
            configMode:
              type: string
              enum:
              - BRIDGED
              - DIRECT
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with TSB username and password
    JWTToken:
      type: apiKey
      in: header
      name: x-tetrate-token
      description: JWT token authentication using the x-tetrate-token header
externalDocs:
  description: Tetrate Service Bridge REST API Guide
  url: https://docs.tetrate.io/service-bridge/reference/rest-api/guide