Tetrate Tenants API

openapi: 3.0.3
info:
  title: Tetrate Service Bridge REST APIs Tenants 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: Tenants
  description: Manage tenants within organizations
paths:
  /organizations/{organization}/tenants:
    get:
      operationId: listTenants
      summary: List Tenants
      description: Returns all tenants within an organization.
      tags:
      - Tenants
      parameters:
      - $ref: '#/components/parameters/organization'
      responses:
        '200':
          description: List of tenants
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantList'
    post:
      operationId: createTenant
      summary: Create Tenant
      description: Creates a new tenant within an organization.
      tags:
      - Tenants
      parameters:
      - $ref: '#/components/parameters/organization'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tenant'
      responses:
        '200':
          description: Created tenant
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
  /organizations/{organization}/tenants/{tenant}:
    get:
      operationId: getTenant
      summary: Get Tenant
      description: Returns the details of a specific tenant.
      tags:
      - Tenants
      parameters:
      - $ref: '#/components/parameters/organization'
      - $ref: '#/components/parameters/tenant'
      responses:
        '200':
          description: Tenant details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
    put:
      operationId: updateTenant
      summary: Update Tenant
      description: Updates an existing tenant configuration.
      tags:
      - Tenants
      parameters:
      - $ref: '#/components/parameters/organization'
      - $ref: '#/components/parameters/tenant'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tenant'
      responses:
        '200':
          description: Updated tenant
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
    delete:
      operationId: deleteTenant
      summary: Delete Tenant
      description: Deletes a tenant and all its workspaces.
      tags:
      - Tenants
      parameters:
      - $ref: '#/components/parameters/organization'
      - $ref: '#/components/parameters/tenant'
      responses:
        '200':
          description: Tenant deleted
components:
  schemas:
    Tenant:
      allOf:
      - $ref: '#/components/schemas/ResourceMeta'
      type: object
      properties:
        spec:
          type: object
          properties:
            displayName:
              type: string
            description:
              type: string
            deletionProtectionEnabled:
              type: boolean
    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
    TenantList:
      type: object
      properties:
        tenants:
          type: array
          items:
            $ref: '#/components/schemas/Tenant'
  parameters:
    tenant:
      name: tenant
      in: path
      required: true
      description: Tenant name
      schema:
        type: string
    organization:
      name: organization
      in: path
      required: true
      description: Organization name
      schema:
        type: string
  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