Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tetrate Security Groups API

Manage security settings and policies

Tetrate Security Groups API is one of 15 APIs that Tetrate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Security Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://{tsb-host}:8443/v2.

2 operations 1 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://tsbhost:8443/v2
Authentication
HTTP Basic, API Key
Contact
Resource Areas
1

Authentication & Security 2

Tetrate Security Groups API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as x-tetrate-token (JWTToken). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic authentication with TSB username and password
  • JWTToken — JWT token authentication using the x-tetrate-token header

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Security Groups 2

Manage security settings and policies

GET
/organizations/{organization}/tenants/{tenant}/workspaces/{workspace}/securitygroups
List Security Groups
listSecurityGroups 3 params → 200
POST
/organizations/{organization}/tenants/{tenant}/workspaces/{workspace}/securitygroups
Create Security Group
createSecurityGroup 3 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ResourceMeta (7 properties), SecurityGroupList (1 property), SecurityGroup (1 property). Each schema is shown below with its type and property counts.

SecurityGroup
object
1 property
ResourceMeta
object
7 properties
SecurityGroupList
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrate-security-groups-api-openapi.yml Raw ↑

Other APIs Tetrate publishes across the network.

Tetrate Service Bridge Platform API
Tetrate Service Bridge Gateway API
Tetrate Service Bridge Traffic API
Tetrate Service Bridge Security API
Tetrate Service Bridge Observability API
Tetrate APIs API
Tetrate Applications API
Tetrate Clusters API
Tetrate Gateway Groups API
Tetrate Organizations API
Tetrate RBAC API
Tetrate Tenants API