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 APIs API

Manage API objects within applications

Tetrate APIs 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 APIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 4 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.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 POST1 PUT

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 APIs 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 5

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

APIs 5

Manage API objects within applications

GET
/organizations/{organization}/tenants/{tenant}/applications/{application}/apis
List APIs
listAPIs 3 params → 200
POST
/organizations/{organization}/tenants/{tenant}/applications/{application}/apis
Create API
createAPI 3 params body → 200
GET
/organizations/{organization}/tenants/{tenant}/applications/{application}/apis/{api}
Get API
getAPI 4 params → 200
PUT
/organizations/{organization}/tenants/{tenant}/applications/{application}/apis/{api}
Update API
updateAPI 4 params body → 200
DELETE
/organizations/{organization}/tenants/{tenant}/applications/{application}/apis/{api}
Delete API
deleteAPI 4 params → 200

Schemas 4

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

APIList
object
1 property
HTTPEndpoint
object
3 properties
ResourceMeta
object
7 properties
API
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrate-apis-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 Applications API
Tetrate Clusters API
Tetrate Gateway Groups API
Tetrate Organizations API
Tetrate RBAC API
Tetrate Security Groups API
Tetrate Tenants API