Skip to main content
logoTetrate Service BridgeVersion: 1.7.x

Gateway Service

Service to manage the configuration for Gateways.

Gateways

The Gateway service provides methods to manage gateway settings in TSB.

It provides methods to create and manage gateway groups within a workspace, allowing to create fine-grained groupings to configure a subset of the workspace namespaces. Access policies can be assigned at group level, providing a fine-grained access control to the gateway configuration features.

The Gateway service also provides methods to configure the different gateway settings that are allowed within each group.

CreateGroup

GetGroup

UpdateGroup

ListGroups

DeleteGroup

CreateIngressGateway

GetIngressGateway

UpdateIngressGateway

ListIngressGateways

DeleteIngressGateway

CreateEgressGateway

GetEgressGateway

UpdateEgressGateway

ListEgressGateways

DeleteEgressGateway

CreateTier1Gateway

GetTier1Gateway

UpdateTier1Gateway

ListTier1Gateways

DeleteTier1Gateway

CreateGateway

GetGateway

UpdateGateway

ListGateways

DeleteGateway

CreateEgressGatewayRequest

Request to create a EgressGateway.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the EgressGateway will be created.

string = {
  min_len: 1
}

name

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

string = {
  min_len: 1
}

egressGateway

tetrateio.api.tsb.gateway.v2.EgressGateway
REQUIRED
Details of the EgressGateway to be created.

message = {
  required: true
}

CreateGatewayGroupRequest

Request to create a Gateway Group.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Group will be created.

string = {
  min_len: 1
}

name

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

string = {
  min_len: 1
}

group

tetrateio.api.tsb.gateway.v2.Group
REQUIRED
Details of the Group to be created.

message = {
  required: true
}

CreateGatewayRequest

Request to create a Gateway.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Gateway will be created.

string = {
  min_len: 1
}

name

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

string = {
  min_len: 1
}

gateway

tetrateio.api.tsb.gateway.v2.Gateway
REQUIRED
Details of the Gateway to be created.

message = {
  required: true
}

CreateIngressGatewayRequest

Request to create a IngressGateway.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the IngressGateway will be created.

string = {
  min_len: 1
}

name

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

string = {
  min_len: 1
}

ingressGateway

tetrateio.api.tsb.gateway.v2.IngressGateway
REQUIRED
Details of the IngressGateway to be created.

message = {
  required: true
}

CreateTier1GatewayRequest

Request to create a Tier1Gateway.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Tier1Gateway will be created.

string = {
  min_len: 1
}

name

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

string = {
  min_len: 1
}

tier1Gateway

tetrateio.api.tsb.gateway.v2.Tier1Gateway
REQUIRED
Details of the Tier1Gateway to be created.

message = {
  required: true
}

DeleteEgressGatewayRequest

Request to delete a EgressGateway.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the EgressGateway.

string = {
  min_len: 1
}

DeleteGatewayGroupRequest

Request to delete a Gateway Group.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Group.

string = {
  min_len: 1
}

force

bool
Force the deletion of the object even if deletion protection is enabled. If this is set, then the object and all its children will be deleted even if any of them has the deletion protection enabled.

DeleteGatewayRequest

Request to delete a Gateway.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Gateway.

string = {
  min_len: 1
}

DeleteIngressGatewayRequest

Request to delete a IngressGateway.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the IngressGateway.

string = {
  min_len: 1
}

DeleteTier1GatewayRequest

Request to delete a Tier1Gateway.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Tier1Gateway.

string = {
  min_len: 1
}

GetEgressGatewayRequest

Request to retrieve a EgressGateway.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the EgressGateway.

string = {
  min_len: 1
}

GetGatewayGroupRequest

Request to retrieve a Gateway Group.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Group.

string = {
  min_len: 1
}

GetGatewayRequest

Request to retrieve a Gateway.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Gateway.

string = {
  min_len: 1
}

GetIngressGatewayRequest

Request to retrieve a IngressGateway.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the IngressGateway.

string = {
  min_len: 1
}

GetTier1GatewayRequest

Request to retrieve a Tier1Gateway.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Tier1Gateway.

string = {
  min_len: 1
}

ListEgressGatewaysRequest

Request to list EgressGateways.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list EgressGateways from.

string = {
  min_len: 1
}

ListEgressGatewaysResponse

Lost of all Egress Gateway objects in the gateway group.

FieldDescriptionValidation Rule

egressGateways

List of tetrateio.api.tsb.gateway.v2.EgressGateway

ListGatewayGroupsRequest

Request to list Gateway Groups.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Groups from.

string = {
  min_len: 1
}

ListGatewayGroupsResponse

List of all gateway groups in the workspace.

FieldDescriptionValidation Rule

groups

List of tetrateio.api.tsb.gateway.v2.Group

ListGatewaysRequest

Request to list Gateways.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Gateways from.

string = {
  min_len: 1
}

ListGatewaysResponse

List of all Gateway objects in the gateway group.

FieldDescriptionValidation Rule

gateways

List of tetrateio.api.tsb.gateway.v2.Gateway
List of all Gateway objects.

ListIngressGatewaysRequest

Request to list IngressGateways.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list IngressGateways from.

string = {
  min_len: 1
}

ListIngressGatewaysResponse

List of all Ingress Gateway objects in the gateway group.

FieldDescriptionValidation Rule

ingressGateways

List of tetrateio.api.tsb.gateway.v2.IngressGateway

ListTier1GatewaysRequest

Request to list Tier1Gateways.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Tier1Gateways from.

string = {
  min_len: 1
}

ListTier1GatewaysResponse

List of all Tier1 Gateway objects in the gateway group.

FieldDescriptionValidation Rule

tier1Gateways

List of tetrateio.api.tsb.gateway.v2.Tier1Gateway