Skip to main content
logoTetrate Service BridgeVersion: 1.8.x

Application Service

Service to manage Applications and APis

Applications​

The Applications service exposes methods to manage Applications and API definitions in Service Bridge.

CreateApplication​

GetApplication​

UpdateApplication​

ListApplications​

DeleteApplication​

GetApplicationStatus​

CreateAPI​

GetAPI​

UpdateAPI​

UpdateAPIWithParams​

ListAPIs​

DeleteAPI​

GetAPIStatus​

CreateAPIRequest​

Request to create an API and register it in the management plane so configuration can be generated for it.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the API will be created. This is the FQN of the application where the API belongs to.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

api

tetrateio.api.tsb.application.v2.API
REQUIRED
Details of the API to be created.

message = {
  required: true
}

CreateApplicationRequest​

Request to create an application and register it in the management plane so configuration can be generated for it.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the application will be created. This is the FQN of the tenant where the application belongs to.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

application

tetrateio.api.tsb.application.v2.Application
REQUIRED
Details of the application to be created.

message = {
  required: true
}

DeleteAPIRequest​

Request to delete an API.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the API.

string = {
  min_len: 1
}

DeleteApplicationRequest​

Request to delete an application.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the application.

string = {
  min_len: 1
}

forceDeleteProtectedGroups

bool
Force the deletion of internal groups even if they are protected against deletion.

–

GetAPIRequest​

Request to retrieve an API.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the API.

string = {
  min_len: 1
}

GetApplicationRequest​

Request to retrieve an application.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the application.

string = {
  min_len: 1
}

GetStatusRequest​

Request to retrieve the configuration status of a given resource.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the resource to get the configuration status for.

string = {
  min_len: 1
}

ListAPIsRequest​

Request to list APIs.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list APIs from. This is the FQN of the application where the APIs belong to.

string = {
  min_len: 1
}

ListAPIsResponse​

List of APIs that have been attached to the given application.

FieldDescriptionValidation Rule

apis

List of tetrateio.api.tsb.application.v2.API
The list of APIs that are registered in the given application.

–

ListApplicationsRequest​

Request to list applications.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list applications from. This is the FQN of the tenant where the applications belong to.

string = {
  min_len: 1
}

ListApplicationsResponse​

List of applications in the given tenant.

FieldDescriptionValidation Rule

applications

List of tetrateio.api.tsb.application.v2.Application
The list of applications that are registered in the given tenant.

–

UpdateAPIRequest​

FieldDescriptionValidation Rule

api

tetrateio.api.tsb.application.v2.API
REQUIRED
Details of the API to be updated.

message = {
  required: true
}

force

bool
When the force parameter is set, changes will be applied regardless of the status of the API object. This will overwrite the generated configuration objects even if they were manually modified or were out of sync with the API object. Defaults to false.

–