Skip to main content
Version: 1.6.x

Gateway Service

Gateway

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

Requires CreateGroup

Create a new gateway group in the given workspace.

Groups will by default configure all the namespaces owned by their workspace, unless explicitly configured. If a specific set of namespaces is set for the group, it must be a subset of the namespaces defined by its workspace.

GetGroup

Requires ReadGroup

Get the details of the given gateway group.

UpdateGroup

Requires WriteGroup

update the given gateway group.

ListGroups

List all gateway groups that exist in the workspace.

DeleteGroup

Requires DeleteGroup

Delete the given gateway group. Note that deleting resources in TSB is a recursive operation. Deleting a gateway group will delete all configuration objects that exist in it.

CreateIngressGateway

Requires CreateIngressGateway

Create an Ingress Gateway object in the gateway group.

GetIngressGateway

Requires ReadIngressGateway

Get the details of the given Ingress Gateway object.

UpdateIngressGateway

Requires WriteIngressGateway

Modify the given Ingress Gateway object.

ListIngressGateways

List all Ingress Gateway objects in the gateway group.

DeleteIngressGateway

Requires DeleteIngressGateway

Delete the given Ingress Gateway object.

CreateEgressGateway

Requires CreateEgressGateway

Create an Egress Gateway object in the gateway group.

GetEgressGateway

Requires ReadEgressGateway

Get the details of the given Egress Gateway object.

UpdateEgressGateway

Requires WriteEgressGateway

Modify the given Egress Gateway object.

ListEgressGateways

List all Egress Gateway objects in the gateway group.

DeleteEgressGateway

Requires DeleteEgressGateway

Delete the given Egress Gateway object.

CreateTier1Gateway

Requires CreateTier1Gateway

Create a Tier1 Gateway object in the gateway group.

GetTier1Gateway

Requires READ

get the details of the given Tier1 Gateway object.

UpdateTier1Gateway

Requires WRITE

ListTier1Gateways

List all Tier1 Gateway objects that have been created in the gateway group.

DeleteTier1Gateway

Requires DELETE

Delete the given Tier1 Gateway object.

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
}

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
}

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
}

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

ListIngressGatewaysRequest

Request to list IngressGateways.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list IngressGateways from.

string = {
  min_len: 1
}

ListIngressGatewaysResponse

Lost 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