Transit Gateway API | IBM Cloud API Docs

Introduction

Last updated: 2024-06-12

The IBM Cloud Transit Gateway API is a RESTful API that allows you to manage your Transit Gateway resources.

Familiarize yourself with Transit Gateway functionality described in About IBM Cloud Transit Gateway.

The code examples on this tab use the client library that is provided for Go.

Installation

go get -u github.com/IBM/networking-go-sdk

GitHub:

https://github.com/IBM/networking-go-sdk

The code examples on this tab use the client library that is provided for Java.

Maven:

<dependency>
    <groupId>com.ibm.cloud</groupId>
    <artifactId>transit-gateway-ap-is</artifactId>
    <version>X.X.X</version>
</dependency>

Gradle:

compile 'com.ibm.cloud:transit-gateway-ap-is:X.X.X'

GitHub:

https://github.com/IBM/networking-java-sdk

The code examples on this tab use the client library that is provided for Node.js.

Installation

npm install ibm-cloud-networking

GitHub:

https://github.com/IBM/networking-node-sdk

The code examples on this tab use the client library that is provided for Python.

Installation

pip install --upgrade "ibm-cloud-networking-services>=X.X.X"

GitHub

https://github.com/IBM/networking-python-sdk

Authentication

The IBM Cloud Transit Gateway API uses Identity and Access Management (IAM) to authenticate requests. Pass a bearer token in an Authorization header.

You can retrieve an access token by first creating an API key, and then exchanging your API key for an IAM token. For more information, see Retrieving an access token programmatically.

Authorization

Access management to Transit Gateway resources is done through Identity and Access Management (IAM). For more information, see Using IAM permissions with Transit Gateway.

API Endpoint

https://transit.cloud.ibm.com/v1

Use Virtual Private Endpoint (VPE) for VPC to access Transit Gateway via https://private.transit.cloud.ibm.com/v1.


import (
	"github.com/IBM/networking-go-sdk/transitgatewayapisv1"
)

authenticator := &core.IamAuthenticator{
          ApiKey: apikey,
       }
	version := "2021-12-30"
	options := &transitgatewayapisv1.TransitGatewayApisV1Options{
		Version:       &version,
		Authenticator: authenticator,
	}

transitGatewayService, transitGatewayServiceErr := transitgatewayapisv1.NewTransitGatewayApisV1(options)

transitGatewayService.SetServiceURL("{api_endpoint}")

TransitGatewayApis transitGatewayService = new TransitGatewayApis("2020-03-31", "{service_name}", authenticator);

transitGatewayService.setServiceUrl("{api_endpoint}");

const transitGatewayService = new TransitGatewayApisV1({
   version: '2020-03-31',
   authenticator: new IamAuthenticator({
    apikey: '{apikey}',
   }),
   serviceUrl: '{api_endpoint}',
});


from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
from ibm_cloud_networking_services import TransitGatewayApisV1

authenticator = IAMAuthenticator(
            apikey={apikey}
)

transit_gateway_service = TransitGatewayApisV1(
    version='2020-03-31',
    authenticator=authenticator
)

transit_gateway_service.set_service_url('{api_endpoint}')

Versioning

All API requests require a major version in the path (/v1/) and a date-based version as a query parameter in the format version=YYYY-MM-DD.

For example: GET /v1/transit_gateways?version=2020-03-31

Start development of new applications with the current date as a fixed value. Do not dynamically use the current date as the version for a production application. Instead, use a fixed date-based version that was tested with your application.

Pagination

Some API requests can return many results. To improve performance, results are returned one page at a time, with a limited number of results on each page. The default page size is typically 50 items, with a maximum size of 100.

The default and maximum limits might vary by operation. To specify a different page size, use the limit query parameter.

For a request that uses pagination, the response includes additional properties:

The first.href property links to the first page of resources
The next.href property links to the next page of resources (included for all pages except for the last page)

Use query parameters to page through your available resources and retrieve a subset of objects. To retrieve the first page of results, make the request without specifying a start query parameter. If the results cannot fit on the first page, the response will include a next property, whose value can then be specified as the start parameter when making the next page request. Each page of results is based on the resources that exist at the time of each paginated request, and therefore may include resources that did not exist when the first request was made. The last page of results will not include a next property.

When you're retrieving a subset of objects:

You may use the value of first.href to retrieve the first page of resources in the requested sort order and with the requested filters
You may use the value of next.href to retrieve the next page of resources in the requested sort order and with the requested filters
You may not change the requested filters across page retrievals
You may not add a sort query parameter to the href value (sort order is set by the first paginated list request)
You may modify the limit in the href value to limit the number of resources to return, per page, in a paginated list operation
You may not change the path segments of the request (that is, anything before the ? in the href value)

Best practices

To minimize regressions from changes, the following best practices are recommended when you call the API:

Log any 4xx or 5xx HTTP status code along with the included trace property.
Follow HTTP redirect rules for any 3xx HTTP status code.
Consume only the resources and properties that are needed for your application to function.
Avoid depending on any behavior that is not explicitly documented.

Error handling

The Transit Gateway API uses standard HTTP response codes to indicate whether a method completed successfully. A 2xx response indicates success. A 4xx type response indicates a failure, and 5xx type response indicates an internal system error.

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

Table 1. HTTP error codes and descriptions
HTTP Error Code	Description	Recovery
`200`	Success	The request was successful.
`400`	Bad Request	The input parameters in the request body are either incomplete or in the wrong format. See the specific error message for more details. Be sure to include all required parameters in your request.
`401`	Unauthorized	You are not authorized to make this request. Log in to IBM Cloud® and try again. If this error persists, contact the account owner to check your permissions.
`403`	Forbidden	The supplied authentication is not authorized to access the requested action. Check that you have the correct access credentials and permissions.
`404`	Not Found	The requested resource might not exist, or the supplied authentication is not authorized to access it. See the specific error message for resource details, verify that the specified resource exists, or contact the account owner to check your permissions to view it.
`408`	Request Timeout	The connection to the server timed out. Wait a few minutes, then try again.
`409`	Conflict	The entity is already in the requested state, or resources are in an incorrect state. See the specific error message for more details.
`500`	Internal Server Error	IBM Cloud Transit Gateway API is currently unavailable. Your request could not be processed. Wait a few minutes and try again.

Auditing

Monitor API activity within your account by using the IBM Cloud Activity Tracker service. Each time that you make an API call, an event is generated and saved to Activity Tracker. The specific event type is listed for each individual method. For more information, see Auditing events for account management.

Lists all Transit Gateways in account the caller is authorized to view.

List all Transit Gateways in account the caller is authorized to view.

GET /transit_gateways

ServiceCall<TransitGatewayCollection> listTransitGateways(ListTransitGatewaysOptions listTransitGatewaysOptions)

listTransitGateways(params)

list_transit_gateways(
        self,
        *,
        limit: Optional[int] = None,
        start: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) ListTransitGateways(listTransitGatewaysOptions *ListTransitGatewaysOptions) (result *TransitGatewayCollection, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewaysWithContext(ctx context.Context, listTransitGatewaysOptions *ListTransitGatewaysOptions) (result *TransitGatewayCollection, response *core.DetailedResponse, err error)

Request

Use the ListTransitGatewaysOptions.Builder to create a ListTransitGatewaysOptions object that contains the parameter values for the listTransitGateways method.

Instantiate the ListTransitGatewaysOptions struct and set the fields to provide parameter values for the ListTransitGateways method.

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
limit
int32
The maximum number of resources to return per page

Possible values: 1 ≤ value ≤ 50
Default: 50
start
string
A server supplied token determining which resource to start the page on

Possible values: 0 ≤ length ≤ 500, Value must match regular expression ^([0-9a-zA-Z]{1,500})$

ListTransitGatewaysOptions

The listTransitGateways options.

parameters

limit
number
The maximum number of resources to return per page.

Possible values: 1 ≤ value ≤ 50
Default: 50
start
string
A server supplied token determining which resource to start the page on.

Possible values: 0 ≤ length ≤ 500, Value must match regular expression /^([0-9a-zA-Z]{1,500})$/

parameters

limit
int
The maximum number of resources to return per page.

Possible values: 1 ≤ value ≤ 50
Default: 50
start
str
A server supplied token determining which resource to start the page on.

Possible values: 0 ≤ length ≤ 500, Value must match regular expression /^([0-9a-zA-Z]{1,500})$/

parameter

WithContext method only

ListTransitGatewaysOptions

The ListTransitGateways options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways?version={version}"

Example request

listTransitGatewaysOptions := &transitgatewayapisv1.ListTransitGatewaysOptions{
  Limit: core.Int64Ptr(int64(10)),
}

pager, err := transitGatewayApisService.NewTransitGatewaysPager(listTransitGatewaysOptions)
if err != nil {
  panic(err)
}

var allResults []transitgatewayapisv1.TransitGateway
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))

Example request

ListTransitGatewaysOptions listTransitGatewaysOptions = new ListTransitGatewaysOptions.Builder()
  .limit(Long.valueOf("10"))
  .build();

TransitGatewaysPager pager = new TransitGatewaysPager(transitGatewayApisService, listTransitGatewaysOptions);
List<TransitGateway> allResults = new ArrayList<>();
while (pager.hasNext()) {
  List<TransitGateway> nextPage = pager.getNext();
  allResults.addAll(nextPage);
}

System.out.println(GsonSingleton.getGson().toJson(allResults));

Example request

const params = {
  limit: 10,
};

const allResults = [];
try {
  const pager = new TransitGatewayApisV1.TransitGatewaysPager(transitGatewayApisService, params);
  while (pager.hasNext()) {
    const nextPage = await pager.getNext();
    expect(nextPage).not.toBeNull();
    allResults.push(...nextPage);
  }
  console.log(JSON.stringify(allResults, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

all_results = []
pager = TransitGatewaysPager(
  client=transit_gateway_apis_service,
  limit=10,
)
while pager.has_next():
  next_page = pager.get_next()
  assert next_page is not None
  all_results.extend(next_page)

print(json.dumps(all_results, indent=2))

Response

Response Body

TransitGatewayCollection

A list of Transit Gateways

TransitGatewayCollection

A list of Transit Gateways.

TransitGatewayCollection

A list of Transit Gateways.

TransitGatewayCollection

A list of Transit Gateways.

TransitGatewayCollection

A list of Transit Gateways.

Status Code

200
The Transit Gateways were retrieved successfully.

Example responses

Status 200

{
  "first": {
    "href": "https://transit.cloud.ibm.com/v1/transit_gateways?limit=50"
  },
  "limit": 50,
  "transit_gateways": [
    {
      "created_at": "2020-03-31T12:08:05Z",
      "crn": "crn:[...]",
      "global": true,
      "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4",
      "location": "us-south",
      "name": "example-gateway",
      "resource_group": {
        "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8",
        "id": "56969d6043e9465c883cb9f7363e78e8"
      },
      "status": "available",
      "updated_at": "2020-03-31T12:08:05Z"
    }
  ]
}

Success example

{
  "first": {
    "href": "https://transit.cloud.ibm.com/v1/transit_gateways?limit=50"
  },
  "limit": 50,
  "transit_gateways": [
    {
      "created_at": "2020-03-31T12:08:05Z",
      "crn": "crn:[...]",
      "global": true,
      "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4",
      "location": "us-south",
      "name": "example-gateway",
      "resource_group": {
        "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8",
        "id": "56969d6043e9465c883cb9f7363e78e8"
      },
      "status": "available",
      "updated_at": "2020-03-31T12:08:05Z"
    }
  ]
}

Create a Transit Gateway based on the supplied input template.

POST /transit_gateways

ServiceCall<TransitGateway> createTransitGateway(CreateTransitGatewayOptions createTransitGatewayOptions)

createTransitGateway(params)

create_transit_gateway(
        self,
        location: str,
        name: str,
        *,
        global_: Optional[bool] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGateway(createTransitGatewayOptions *CreateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayWithContext(ctx context.Context, createTransitGatewayOptions *CreateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

Request

Use the CreateTransitGatewayOptions.Builder to create a CreateTransitGatewayOptions object that contains the parameter values for the createTransitGateway method.

Instantiate the CreateTransitGatewayOptions struct and set the fields to provide parameter values for the CreateTransitGateway method.

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

TGCreateTemplate

The Transit Gateway template

CreateTransitGatewayOptions

The createTransitGateway options.

parameters

location
Required*
string
Location of Transit Gateway Services.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:
value
_source
_lines
_html
name
Required*
string
Name Transit Gateway Services.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html
global
boolean
Allow global routing for a Transit Gateway. If unspecified, the default value is false.

Default: false
Examples:
value
_source
_lines
_html
resourceGroup
The resource group to use. If unspecified, the account's default resource group is used.

parameters

location
Required*
str
Location of Transit Gateway Services.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:
value
_source
_lines
_html
name
Required*
str
Name Transit Gateway Services.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html
global_
bool
Allow global routing for a Transit Gateway. If unspecified, the default value is false.

Default: false
Examples:
value
_source
_lines
_html
resource_group
The resource group to use. If unspecified, the account's default resource group is used.

parameter

WithContext method only

CreateTransitGatewayOptions

The CreateTransitGateway options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "location": "us-south", "name": "Transit_Service_BWTN_SJ_DL" }'   "{base_url}/transit_gateways?version={version}"

Example request

createTransitGatewayOptions := transitGatewayApisService.NewCreateTransitGatewayOptions(
  "us-south",
  "Transit_Service_BWTN_SJ_DL",
)

transitGateway, response, err := transitGatewayApisService.CreateTransitGateway(createTransitGatewayOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(transitGateway, "", "  ")
fmt.Println(string(b))

Example request

CreateTransitGatewayOptions createTransitGatewayOptions = new CreateTransitGatewayOptions.Builder()
  .location("us-south")
  .name("Transit_Service_BWTN_SJ_DL")
  .build();

Response<TransitGateway> response = transitGatewayApisService.createTransitGateway(createTransitGatewayOptions).execute();
TransitGateway transitGateway = response.getResult();

System.out.println(transitGateway);

Example request

const params = {
  location: 'us-south',
  name: 'Transit_Service_BWTN_SJ_DL',
};

let res;
try {
  res = await transitGatewayApisService.createTransitGateway(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.create_transit_gateway(
  location='us-south',
  name='Transit_Service_BWTN_SJ_DL',
)
transit_gateway = response.get_result()

print(json.dumps(transit_gateway, indent=2))

Response

Response Body

TransitGateway

Details of a Transit Gateway

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

Status Code

201
The Transit Gateway was created successfully.
400
An invalid Transit Gateway template was provided.
404
A Transit Gateway location could not be found for the identifier given in the template, a resource group could not be found for the given resource group identifier, or the default resource group could not be found for the account (if no resource group identifier was supplied).
409
The Transit Gateway could not be created as a transit gateway with the same name already exists.

Example responses

Status 201

{
  "created_at": "2020-03-31T12:08:05Z",
  "crn": "crn:[...]",
  "global": true,
  "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4",
  "location": "us-south",
  "name": "example-gateway",
  "resource_group": {
    "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8",
    "id": "56969d6043e9465c883cb9f7363e78e8"
  },
  "status": "pending",
  "updated_at": "2020-03-31T12:08:05Z"
}

Success example

{
  "created_at": "2020-03-31T12:08:05Z",
  "crn": "crn:[...]",
  "global": true,
  "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4",
  "location": "us-south",
  "name": "example-gateway",
  "resource_group": {
    "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8",
    "id": "56969d6043e9465c883cb9f7363e78e8"
  },
  "status": "pending",
  "updated_at": "2020-03-31T12:08:05Z"
}

Status 400

{
  "errors": [
    {
      "code": "validation_required_field_missing",
      "message": "Mandatory field is missing.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "name",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "validation_required_field_missing",
      "message": "Mandatory field is missing.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "name",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Location not found.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Location not found.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 409

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "A gateway with the same name already exists",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "A gateway with the same name already exists",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.

DELETE /transit_gateways/{id}

ServiceCall<Void> deleteTransitGateway(DeleteTransitGatewayOptions deleteTransitGatewayOptions)

deleteTransitGateway(params)

delete_transit_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGateway(deleteTransitGatewayOptions *DeleteTransitGatewayOptions) (response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayWithContext(ctx context.Context, deleteTransitGatewayOptions *DeleteTransitGatewayOptions) (response *core.DetailedResponse, err error)

Request

Use the DeleteTransitGatewayOptions.Builder to create a DeleteTransitGatewayOptions object that contains the parameter values for the deleteTransitGateway method.

Instantiate the DeleteTransitGatewayOptions struct and set the fields to provide parameter values for the DeleteTransitGateway method.

Path Parameters

id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

DeleteTransitGatewayOptions

The deleteTransitGateway options.

parameters

id
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

DeleteTransitGatewayOptions

The DeleteTransitGateway options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/transit_gateways/{id}?version={version}"

Example request

deleteTransitGatewayOptions := transitGatewayApisService.NewDeleteTransitGatewayOptions(
  "testString",
)

response, err := transitGatewayApisService.DeleteTransitGateway(deleteTransitGatewayOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteTransitGateway(): %d\n", response.StatusCode)
}

Example request

DeleteTransitGatewayOptions deleteTransitGatewayOptions = new DeleteTransitGatewayOptions.Builder()
  .id("testString")
  .build();

Response<Void> response = transitGatewayApisService.deleteTransitGateway(deleteTransitGatewayOptions).execute();

Example request

const params = {
  id: 'testString',
};

try {
  await transitGatewayApisService.deleteTransitGateway(params);
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.delete_transit_gateway(
  id='testString',
)

Response

Status Code

204
The Transit Gateway was deleted successfully.
404
A Transit Gateway with the specified identifier could not be found.
409
The Transit Gateway could not be deleted as there are pre-existing connections attached.

Example responses

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 409

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "The gateway could not be deleted as there are connections attached to it. Delete all connections attached to this gateway and retry.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "The gateway could not be deleted as there are connections attached to it. Delete all connections attached to this gateway and retry.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

This request retrieves a single Transit Gateway specified by the identifier in the URL.

GET /transit_gateways/{id}

ServiceCall<TransitGateway> getTransitGateway(GetTransitGatewayOptions getTransitGatewayOptions)

getTransitGateway(params)

get_transit_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) GetTransitGateway(getTransitGatewayOptions *GetTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayWithContext(ctx context.Context, getTransitGatewayOptions *GetTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

Request

Use the GetTransitGatewayOptions.Builder to create a GetTransitGatewayOptions object that contains the parameter values for the getTransitGateway method.

Instantiate the GetTransitGatewayOptions struct and set the fields to provide parameter values for the GetTransitGateway method.

Path Parameters

id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

GetTransitGatewayOptions

The getTransitGateway options.

parameters

id
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

GetTransitGatewayOptions

The GetTransitGateway options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{id}?version={version}"

Example request

getTransitGatewayOptions := transitGatewayApisService.NewGetTransitGatewayOptions(
  "testString",
)

transitGateway, response, err := transitGatewayApisService.GetTransitGateway(getTransitGatewayOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(transitGateway, "", "  ")
fmt.Println(string(b))

Example request

GetTransitGatewayOptions getTransitGatewayOptions = new GetTransitGatewayOptions.Builder()
  .id("testString")
  .build();

Response<TransitGateway> response = transitGatewayApisService.getTransitGateway(getTransitGatewayOptions).execute();
TransitGateway transitGateway = response.getResult();

System.out.println(transitGateway);

Example request

const params = {
  id: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.getTransitGateway(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.get_transit_gateway(
  id='testString',
)
transit_gateway = response.get_result()

print(json.dumps(transit_gateway, indent=2))

Response

Response Body

TransitGateway

Details of a Transit Gateway

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

Status Code

200
The Transit Gateway was retrieved successfully.
404
A Transit Gateway with the specified identifier could not be found.

Example responses

Status 200

{
  "created_at": "2020-03-31T12:08:05Z",
  "crn": "crn:[...]",
  "global": true,
  "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4",
  "location": "us-south",
  "name": "example-gateway",
  "resource_group": {
    "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8",
    "id": "56969d6043e9465c883cb9f7363e78e8"
  },
  "status": "available",
  "updated_at": "2020-03-31T12:08:05Z"
}

Success example

{
  "created_at": "2020-03-31T12:08:05Z",
  "crn": "crn:[...]",
  "global": true,
  "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4",
  "location": "us-south",
  "name": "example-gateway",
  "resource_group": {
    "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8",
    "id": "56969d6043e9465c883cb9f7363e78e8"
  },
  "status": "available",
  "updated_at": "2020-03-31T12:08:05Z"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

This request updates a Transit Gateway's name and/or global flag.

PATCH /transit_gateways/{id}

ServiceCall<TransitGateway> updateTransitGateway(UpdateTransitGatewayOptions updateTransitGatewayOptions)

updateTransitGateway(params)

update_transit_gateway(
        self,
        id: str,
        *,
        global_: Optional[bool] = None,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGateway(updateTransitGatewayOptions *UpdateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayWithContext(ctx context.Context, updateTransitGatewayOptions *UpdateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)

Request

Use the UpdateTransitGatewayOptions.Builder to create a UpdateTransitGatewayOptions object that contains the parameter values for the updateTransitGateway method.

Instantiate the UpdateTransitGatewayOptions struct and set the fields to provide parameter values for the UpdateTransitGateway method.

Path Parameters

id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

TGPatchTemplate

Update a Transit Gateway

UpdateTransitGatewayOptions

The updateTransitGateway options.

parameters

id
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
global
boolean
Allow global routing for a Transit Gateway.

Examples:
value
_source
_lines
_html
name
string
The user-defined name for this transit gateway.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html

parameters

id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
global_
bool
Allow global routing for a Transit Gateway.

Examples:
value
_source
_lines
_html
name
str
The user-defined name for this transit gateway.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html

parameter

WithContext method only

UpdateTransitGatewayOptions

The UpdateTransitGateway options.

Example request

curl -X PATCH --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{}'   "{base_url}/transit_gateways/{id}?version={version}"

Example request

updateTransitGatewayOptions := transitGatewayApisService.NewUpdateTransitGatewayOptions(
  "testString",
)

transitGateway, response, err := transitGatewayApisService.UpdateTransitGateway(updateTransitGatewayOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(transitGateway, "", "  ")
fmt.Println(string(b))

Example request

UpdateTransitGatewayOptions updateTransitGatewayOptions = new UpdateTransitGatewayOptions.Builder()
  .id("testString")
  .build();

Response<TransitGateway> response = transitGatewayApisService.updateTransitGateway(updateTransitGatewayOptions).execute();
TransitGateway transitGateway = response.getResult();

System.out.println(transitGateway);

Example request

const params = {
  id: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.updateTransitGateway(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.update_transit_gateway(
  id='testString',
)
transit_gateway = response.get_result()

print(json.dumps(transit_gateway, indent=2))

Response

Response Body

TransitGateway

Details of a Transit Gateway

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

TransitGateway

Details of a Transit Gateway.

Status Code

200
The Transit Gateway was updated successfully.
400
The supplied Transit Gateway patch was invalid.
404
A Transit Gateway with the specified identifier could not be found.
409
The Transit Gateway could not be updated as there are pre-existing cross-region connections attached.

Example responses

Status 200

{
  "created_at": "2020-03-31T12:08:05Z",
  "crn": "crn:[...]",
  "global": false,
  "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4",
  "location": "us-south",
  "name": "example-gateway-new-name",
  "resource_group": {
    "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8",
    "id": "56969d6043e9465c883cb9f7363e78e8"
  },
  "status": "available",
  "updated_at": "2020-03-31T12:08:05Z"
}

Success example

{
  "created_at": "2020-03-31T12:08:05Z",
  "crn": "crn:[...]",
  "global": false,
  "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4",
  "location": "us-south",
  "name": "example-gateway-new-name",
  "resource_group": {
    "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8",
    "id": "56969d6043e9465c883cb9f7363e78e8"
  },
  "status": "available",
  "updated_at": "2020-03-31T12:08:05Z"
}

Status 400

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 409

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "all non-local connections need to be deleted before the gateway's routing can be updated to local",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "all non-local connections need to be deleted before the gateway's routing can be updated to local",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

List all transit gateway connections associated with this account.

GET /connections

ServiceCall<TransitConnectionCollection> listConnections(ListConnectionsOptions listConnectionsOptions)

listConnections(params)

list_connections(
        self,
        *,
        limit: Optional[int] = None,
        start: Optional[str] = None,
        network_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) ListConnections(listConnectionsOptions *ListConnectionsOptions) (result *TransitConnectionCollection, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) ListConnectionsWithContext(ctx context.Context, listConnectionsOptions *ListConnectionsOptions) (result *TransitConnectionCollection, response *core.DetailedResponse, err error)

Request

Use the ListConnectionsOptions.Builder to create a ListConnectionsOptions object that contains the parameter values for the listConnections method.

Instantiate the ListConnectionsOptions struct and set the fields to provide parameter values for the ListConnections method.

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
limit
int32
The maximum number of resources to return per page

Possible values: 1 ≤ value ≤ 100
Default: 50
start
string
A server supplied token determining which resource to start the page on

Possible values: 0 ≤ length ≤ 500, Value must match regular expression ^([0-9a-zA-Z]){0,500}$
network_id
string
Search for connections with the given network_id value

Possible values: 0 ≤ length ≤ 220, Value must match regular expression .

ListConnectionsOptions

The listConnections options.

parameters

limit
number
The maximum number of resources to return per page.

Possible values: 1 ≤ value ≤ 100
Default: 50
start
string
A server supplied token determining which resource to start the page on.

Possible values: 0 ≤ length ≤ 500, Value must match regular expression /^([0-9a-zA-Z]){0,500}$/
networkId
string
Search for connections with the given network_id value.

Possible values: 0 ≤ length ≤ 220, Value must match regular expression /./

parameters

limit
int
The maximum number of resources to return per page.

Possible values: 1 ≤ value ≤ 100
Default: 50
start
str
A server supplied token determining which resource to start the page on.

Possible values: 0 ≤ length ≤ 500, Value must match regular expression /^([0-9a-zA-Z]){0,500}$/
network_id
str
Search for connections with the given network_id value.

Possible values: 0 ≤ length ≤ 220, Value must match regular expression /./

parameter

WithContext method only

ListConnectionsOptions

The ListConnections options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/connections?version={version}"

Example request

listConnectionsOptions := &transitgatewayapisv1.ListConnectionsOptions{
  Limit: core.Int64Ptr(int64(10)),
  NetworkID: core.StringPtr("testString"),
}

pager, err := transitGatewayApisService.NewConnectionsPager(listConnectionsOptions)
if err != nil {
  panic(err)
}

var allResults []transitgatewayapisv1.TransitConnection
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))

Example request

ListConnectionsOptions listConnectionsOptions = new ListConnectionsOptions.Builder()
  .limit(Long.valueOf("10"))
  .networkId("testString")
  .build();

ConnectionsPager pager = new ConnectionsPager(transitGatewayApisService, listConnectionsOptions);
List<TransitConnection> allResults = new ArrayList<>();
while (pager.hasNext()) {
  List<TransitConnection> nextPage = pager.getNext();
  allResults.addAll(nextPage);
}

System.out.println(GsonSingleton.getGson().toJson(allResults));

Example request

const params = {
  limit: 10,
  networkId: 'testString',
};

const allResults = [];
try {
  const pager = new TransitGatewayApisV1.ConnectionsPager(transitGatewayApisService, params);
  while (pager.hasNext()) {
    const nextPage = await pager.getNext();
    expect(nextPage).not.toBeNull();
    allResults.push(...nextPage);
  }
  console.log(JSON.stringify(allResults, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

all_results = []
pager = ConnectionsPager(
  client=transit_gateway_apis_service,
  limit=10,
  network_id='testString',
)
while pager.has_next():
  next_page = pager.get_next()
  assert next_page is not None
  all_results.extend(next_page)

print(json.dumps(all_results, indent=2))

Response

Response Body

TransitConnectionCollection

Transit gateway connections

TransitConnectionCollection

Transit gateway connections.

TransitConnectionCollection

Transit gateway connections.

TransitConnectionCollection

Transit gateway connections.

TransitConnectionCollection

Transit gateway connections.

Status Code

200
The connections were retrieved successfully.

Example responses

Status 200

{
  "connections": [
    {
      "created_at": "2020-03-31T12:08:05Z",
      "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
      "name": "example-connection",
      "network_id": "crn:[...]",
      "network_type": "vpc",
      "prefix_filters_default": "permit",
      "request_status": "approved",
      "status": "attached",
      "transit_gateway": [
        {
          "crn": "crn:[...]",
          "id": "456f58c1-afe7-123a-0a0a-7f3d720f1a44",
          "name": "my-transit-gw100"
        }
      ],
      "updated_at": "2020-03-31T12:08:05Z"
    }
  ],
  "first": {
    "href": "https://transit.cloud.ibm.com/v1/connections?limit=50"
  },
  "limit": 50,
  "total_count": 100
}

Success example

{
  "connections": [
    {
      "created_at": "2020-03-31T12:08:05Z",
      "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
      "name": "example-connection",
      "network_id": "crn:[...]",
      "network_type": "vpc",
      "prefix_filters_default": "permit",
      "request_status": "approved",
      "status": "attached",
      "transit_gateway": [
        {
          "crn": "crn:[...]",
          "id": "456f58c1-afe7-123a-0a0a-7f3d720f1a44",
          "name": "my-transit-gw100"
        }
      ],
      "updated_at": "2020-03-31T12:08:05Z"
    }
  ],
  "first": {
    "href": "https://transit.cloud.ibm.com/v1/connections?limit=50"
  },
  "limit": 50,
  "total_count": 100
}

This request retrieves all connections in a Transit Gateway.

GET /transit_gateways/{transit_gateway_id}/connections

ServiceCall<TransitGatewayConnectionCollection> listTransitGatewayConnections(ListTransitGatewayConnectionsOptions listTransitGatewayConnectionsOptions)

listTransitGatewayConnections(params)

list_transit_gateway_connections(
        self,
        transit_gateway_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnections(listTransitGatewayConnectionsOptions *ListTransitGatewayConnectionsOptions) (result *TransitGatewayConnectionCollection, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnectionsWithContext(ctx context.Context, listTransitGatewayConnectionsOptions *ListTransitGatewayConnectionsOptions) (result *TransitGatewayConnectionCollection, response *core.DetailedResponse, err error)

Request

Use the ListTransitGatewayConnectionsOptions.Builder to create a ListTransitGatewayConnectionsOptions object that contains the parameter values for the listTransitGatewayConnections method.

Instantiate the ListTransitGatewayConnectionsOptions struct and set the fields to provide parameter values for the ListTransitGatewayConnections method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
start
string
A server supplied token determining which resource to start the page on

Possible values: 0 ≤ length ≤ 500, Value must match regular expression ^([0-9a-zA-Z]){0,500}$
limit
int32
The maximum number of resources to return per page

Possible values: 1 ≤ value ≤ 50
Default: 50
name
string
Search for connections with the given name

Possible values: 0 ≤ length ≤ 64, Value must match regular expression ^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$

ListTransitGatewayConnectionsOptions

The listTransitGatewayConnections options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
start
string
A server supplied token determining which resource to start the page on.

Possible values: 0 ≤ length ≤ 500, Value must match regular expression /^([0-9a-zA-Z]){0,500}$/
limit
number
The maximum number of resources to return per page.

Possible values: 1 ≤ value ≤ 50
Default: 50
name
string
Search for connections with the given name.

Possible values: 0 ≤ length ≤ 64, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
start
str
A server supplied token determining which resource to start the page on.

Possible values: 0 ≤ length ≤ 500, Value must match regular expression /^([0-9a-zA-Z]){0,500}$/
limit
int
The maximum number of resources to return per page.

Possible values: 1 ≤ value ≤ 50
Default: 50
name
str
Search for connections with the given name.

Possible values: 0 ≤ length ≤ 64, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/

parameter

WithContext method only

ListTransitGatewayConnectionsOptions

The ListTransitGatewayConnections options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/connections?version={version}"

Example request

listTransitGatewayConnectionsOptions := &transitgatewayapisv1.ListTransitGatewayConnectionsOptions{
  TransitGatewayID: core.StringPtr("testString"),
  Limit: core.Int64Ptr(int64(10)),
  Name: core.StringPtr("testString"),
}

pager, err := transitGatewayApisService.NewTransitGatewayConnectionsPager(listTransitGatewayConnectionsOptions)
if err != nil {
  panic(err)
}

var allResults []transitgatewayapisv1.TransitGatewayConnectionCust
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))

Example request

ListTransitGatewayConnectionsOptions listTransitGatewayConnectionsOptions = new ListTransitGatewayConnectionsOptions.Builder()
  .transitGatewayId("testString")
  .limit(Long.valueOf("10"))
  .name("testString")
  .build();

TransitGatewayConnectionsPager pager = new TransitGatewayConnectionsPager(transitGatewayApisService, listTransitGatewayConnectionsOptions);
List<TransitGatewayConnectionCust> allResults = new ArrayList<>();
while (pager.hasNext()) {
  List<TransitGatewayConnectionCust> nextPage = pager.getNext();
  allResults.addAll(nextPage);
}

System.out.println(GsonSingleton.getGson().toJson(allResults));

Example request

const params = {
  transitGatewayId: 'testString',
  limit: 10,
  name: 'testString',
};

const allResults = [];
try {
  const pager = new TransitGatewayApisV1.TransitGatewayConnectionsPager(transitGatewayApisService, params);
  while (pager.hasNext()) {
    const nextPage = await pager.getNext();
    expect(nextPage).not.toBeNull();
    allResults.push(...nextPage);
  }
  console.log(JSON.stringify(allResults, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

all_results = []
pager = TransitGatewayConnectionsPager(
  client=transit_gateway_apis_service,
  transit_gateway_id='testString',
  limit=10,
  name='testString',
)
while pager.has_next():
  next_page = pager.get_next()
  assert next_page is not None
  all_results.extend(next_page)

print(json.dumps(all_results, indent=2))

Response

Response Body

TransitGatewayConnectionCollection

A set of Transit Gateway network connections

TransitGatewayConnectionCollection

A set of Transit Gateway network connections.

TransitGatewayConnectionCollection

A set of Transit Gateway network connections.

TransitGatewayConnectionCollection

A set of Transit Gateway network connections.

TransitGatewayConnectionCollection

A set of Transit Gateway network connections.

Status Code

200
The connections were retrieved successfully.
404
The specified Transit Gateway could not be found.

Example responses

Status 200

{
  "connections": [
    {
      "created_at": "2020-03-31T12:08:05Z",
      "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
      "name": "example-connection",
      "network_id": "crn:[...]",
      "network_type": "vpc",
      "prefix_filters_default": "permit",
      "request_status": "approved",
      "status": "attached",
      "updated_at": "2020-03-31T12:08:05Z"
    }
  ],
  "first": {
    "href": "https://transit.cloud.ibm.com/v1/tansit_gateways/86780a34-e651-4b47-9fb0-184a169cc9af/connections?limit=50"
  },
  "limit": 50,
  "total_count": 100
}

Success example

{
  "connections": [
    {
      "created_at": "2020-03-31T12:08:05Z",
      "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
      "name": "example-connection",
      "network_id": "crn:[...]",
      "network_type": "vpc",
      "prefix_filters_default": "permit",
      "request_status": "approved",
      "status": "attached",
      "updated_at": "2020-03-31T12:08:05Z"
    }
  ],
  "first": {
    "href": "https://transit.cloud.ibm.com/v1/tansit_gateways/86780a34-e651-4b47-9fb0-184a169cc9af/connections?limit=50"
  },
  "limit": 50,
  "total_count": 100
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Add a connection to Transit Gateway.

POST /transit_gateways/{transit_gateway_id}/connections

ServiceCall<TransitGatewayConnectionCust> createTransitGatewayConnection(CreateTransitGatewayConnectionOptions createTransitGatewayConnectionOptions)

createTransitGatewayConnection(params)

create_transit_gateway_connection(
        self,
        transit_gateway_id: str,
        network_type: str,
        *,
        base_connection_id: Optional[str] = None,
        base_network_type: Optional[str] = None,
        local_gateway_ip: Optional[str] = None,
        local_tunnel_ip: Optional[str] = None,
        name: Optional[str] = None,
        network_account_id: Optional[str] = None,
        network_id: Optional[str] = None,
        prefix_filters: Optional[List['TransitGatewayConnectionPrefixFilter']] = None,
        prefix_filters_default: Optional[str] = None,
        remote_bgp_asn: Optional[int] = None,
        remote_gateway_ip: Optional[str] = None,
        remote_tunnel_ip: Optional[str] = None,
        tunnels: Optional[List['TransitGatewayRedundantGRETunnelTemplate']] = None,
        zone: Optional['ZoneIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnection(createTransitGatewayConnectionOptions *CreateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionWithContext(ctx context.Context, createTransitGatewayConnectionOptions *CreateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

Request

Use the CreateTransitGatewayConnectionOptions.Builder to create a CreateTransitGatewayConnectionOptions object that contains the parameter values for the createTransitGatewayConnection method.

Instantiate the CreateTransitGatewayConnectionOptions struct and set the fields to provide parameter values for the CreateTransitGatewayConnection method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

TransitGatewayConnectionTemplate

The connection template

CreateTransitGatewayConnectionOptions

The createTransitGatewayConnection options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
networkType
Required*
string
Defines what type of network is connected via this connection.

Allowable values: [classic,directlink,gre_tunnel,unbound_gre_tunnel,vpc,power_virtual_server,redundant_gre]
Examples:
value
_source
_lines
_html
baseConnectionId
string
network_type gre_tunnel connections must be created over an existing network_type classic connection. This field must specify the ID of an active transit gateway network_type classic connection in the same transit gateway.

This field is required for network type gre_tunnel connections.

This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server, unbound_gre_tunnel and redundant_gre connections.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:
value
_source
_lines
_html
baseNetworkType
string
The type of network the Unbound GRE tunnel is targeting. This field is required for network type unbound_gre_tunnel and must be set to classic. For a redundant_gre network type, the value is required and can be either VPC or Classic. This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and gre_tunnel connections.

Allowable values: [classic,vpc]
Examples:
value
_source
_lines
_html
localGatewayIp
string
Local gateway IP address. This field is required for network type gre_tunnel and unbound_gre_tunnel connections. This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and redundant_gre connections.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
localTunnelIp
string
Local tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.

This field is required for network type gre_tunnel and unbound_gre_tunnel connections.

This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and redundant_gre connections.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
name
string
The user-defined name for this transit gateway connection. Network type vpc connections are defaulted to the name of the VPC. Network type classic connections are named Classic.

This field is required for network type gre_tunnel, unbound_gre_tunnel and redundant_gre connections.

This field is optional for network type classic, directlink, vpc and power_virtual_server connections.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html
networkAccountId
string
The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type unbound_gre_tunnel when the associated_network_type is classic or network_type is redundant_gre and the GRE tunnel is in a different account than the gateway.

Possible values: 0 ≤ length ≤ 100, Value must match regular expression /./
networkId
string
The ID of the network being connected via this connection. For network types vpc,power_virtual_server and directlink this is the CRN of the VPC / PowerVS / Direct Link gateway respectively. This field is required for network type vpc, power_virtual_server and directlink connections. It is also required for redundant_gre connections when the base_network_type is set to VPC. This field is required to be unspecified for network type classic, gre_tunnel and unbound_gre_tunnel connections.

Possible values: 0 ≤ length ≤ 220, Value must match regular expression /./
Examples:
value
_source
_lines
_html
prefixFilters
Array of prefix route filters for a transit gateway connection. Prefix filters can be specified for netowrk type vpc, classic, power_virtual_server and directlink connections. They are not allowed for type gre_tunnel connections. This is order dependent with those first in the array being applied first, and those at the end of the array being applied last, or just before applying the default. This field is optional for network type classic, vpc, directlink, and power_virtual_server connections. This field is required to be unspecified for network type gre_tunnel, unbound_gre_tunnel and redundant_gre connections.

Possible values: 0 ≤ number of items ≤ 10
prefixFiltersDefault
string
Default setting of permit or deny which applies to any routes that don't match a specified filter. This field is optional for network type classic, vpc, directlink, and power_virtual_server connections. This field is required to be unspecified for network type gre_tunnel, unbound_gre_tunnel and redundant_gre connections.

Allowable values: [permit,deny]
Examples:
value
_source
_lines
_html
remoteBgpAsn
number
Remote network BGP ASN. The following ASN values are reserved and unavailable 0, 13884, 36351, 64512-64513, 65100, 65200-65234, 65402-65433, 65500 and 4201065000-4201065999. If remote_bgp_asn is omitted on gre_tunnel or unbound_gre_tunnel connection create requests IBM will assign an ASN.

This field is optional for network type gre_tunnel and unbound_gre_tunnel connections.

This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and gre_tunnel connections.

Examples:
value
_source
_lines
_html
remoteGatewayIp
string
Remote gateway IP address. This field is required for network type gre_tunnel and unbound_gre_tunnel connections. This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and redundant_gre connections.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
remoteTunnelIp
string
Remote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.

This field is required for network type gre_tunnel and unbound_gre_tunnel connections.

This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and redundant_gre connections.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
tunnels
Array of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for redundant_gre connections.

Possible values: 2 ≤ number of items ≤ 10
zone
Availability zone.

Change Request Parameter List

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
network_type
Required*
str
Defines what type of network is connected via this connection.

Allowable values: [classic,directlink,gre_tunnel,unbound_gre_tunnel,vpc,power_virtual_server,redundant_gre]
Examples:
value
_source
_lines
_html
base_connection_id
str
network_type gre_tunnel connections must be created over an existing network_type classic connection. This field must specify the ID of an active transit gateway network_type classic connection in the same transit gateway.

This field is required for network type gre_tunnel connections.

This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server, unbound_gre_tunnel and redundant_gre connections.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:
value
_source
_lines
_html
base_network_type
str
The type of network the Unbound GRE tunnel is targeting. This field is required for network type unbound_gre_tunnel and must be set to classic. For a redundant_gre network type, the value is required and can be either VPC or Classic. This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and gre_tunnel connections.

Allowable values: [classic,vpc]
Examples:
value
_source
_lines
_html
local_gateway_ip
str
Local gateway IP address. This field is required for network type gre_tunnel and unbound_gre_tunnel connections. This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and redundant_gre connections.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
local_tunnel_ip
str
Local tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.

This field is required for network type gre_tunnel and unbound_gre_tunnel connections.

This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and redundant_gre connections.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
name
str
The user-defined name for this transit gateway connection. Network type vpc connections are defaulted to the name of the VPC. Network type classic connections are named Classic.

This field is required for network type gre_tunnel, unbound_gre_tunnel and redundant_gre connections.

This field is optional for network type classic, directlink, vpc and power_virtual_server connections.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html
network_account_id
str
The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type unbound_gre_tunnel when the associated_network_type is classic or network_type is redundant_gre and the GRE tunnel is in a different account than the gateway.

Possible values: 0 ≤ length ≤ 100, Value must match regular expression /./
network_id
str
The ID of the network being connected via this connection. For network types vpc,power_virtual_server and directlink this is the CRN of the VPC / PowerVS / Direct Link gateway respectively. This field is required for network type vpc, power_virtual_server and directlink connections. It is also required for redundant_gre connections when the base_network_type is set to VPC. This field is required to be unspecified for network type classic, gre_tunnel and unbound_gre_tunnel connections.

Possible values: 0 ≤ length ≤ 220, Value must match regular expression /./
Examples:
value
_source
_lines
_html
prefix_filters
Array of prefix route filters for a transit gateway connection. Prefix filters can be specified for netowrk type vpc, classic, power_virtual_server and directlink connections. They are not allowed for type gre_tunnel connections. This is order dependent with those first in the array being applied first, and those at the end of the array being applied last, or just before applying the default. This field is optional for network type classic, vpc, directlink, and power_virtual_server connections. This field is required to be unspecified for network type gre_tunnel, unbound_gre_tunnel and redundant_gre connections.

Possible values: 0 ≤ number of items ≤ 10
prefix_filters_default
str
Default setting of permit or deny which applies to any routes that don't match a specified filter. This field is optional for network type classic, vpc, directlink, and power_virtual_server connections. This field is required to be unspecified for network type gre_tunnel, unbound_gre_tunnel and redundant_gre connections.

Allowable values: [permit,deny]
Examples:
value
_source
_lines
_html
remote_bgp_asn
int
Remote network BGP ASN. The following ASN values are reserved and unavailable 0, 13884, 36351, 64512-64513, 65100, 65200-65234, 65402-65433, 65500 and 4201065000-4201065999. If remote_bgp_asn is omitted on gre_tunnel or unbound_gre_tunnel connection create requests IBM will assign an ASN.

This field is optional for network type gre_tunnel and unbound_gre_tunnel connections.

This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and gre_tunnel connections.

Examples:
value
_source
_lines
_html
remote_gateway_ip
str
Remote gateway IP address. This field is required for network type gre_tunnel and unbound_gre_tunnel connections. This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and redundant_gre connections.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
remote_tunnel_ip
str
Remote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.

This field is required for network type gre_tunnel and unbound_gre_tunnel connections.

This field is required to be unspecified for network type classic, directlink, vpc, power_virtual_server and redundant_gre connections.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
tunnels
Array of GRE tunnels for a transit gateway redundant GRE tunnel connection. This field is required for redundant_gre connections.

Possible values: 2 ≤ number of items ≤ 10
zone
Availability zone.

Change Request Parameter List

parameter

WithContext method only

CreateTransitGatewayConnectionOptions

The CreateTransitGatewayConnection options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "network_type": "vpc" }'   "{base_url}/transit_gateways/{transit_gateway_id}/connections?version={version}"

Example request

createTransitGatewayConnectionOptions := transitGatewayApisService.NewCreateTransitGatewayConnectionOptions(
  "testString",
  "vpc",
)

transitGatewayConnectionCust, response, err := transitGatewayApisService.CreateTransitGatewayConnection(createTransitGatewayConnectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(transitGatewayConnectionCust, "", "  ")
fmt.Println(string(b))

Example request

CreateTransitGatewayConnectionOptions createTransitGatewayConnectionOptions = new CreateTransitGatewayConnectionOptions.Builder()
  .transitGatewayId("testString")
  .networkType("vpc")
  .build();

Response<TransitGatewayConnectionCust> response = transitGatewayApisService.createTransitGatewayConnection(createTransitGatewayConnectionOptions).execute();
TransitGatewayConnectionCust transitGatewayConnectionCust = response.getResult();

System.out.println(transitGatewayConnectionCust);

Example request

const params = {
  transitGatewayId: 'testString',
  networkType: 'vpc',
};

let res;
try {
  res = await transitGatewayApisService.createTransitGatewayConnection(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.create_transit_gateway_connection(
  transit_gateway_id='testString',
  network_type='vpc',
)
transit_gateway_connection_cust = response.get_result()

print(json.dumps(transit_gateway_connection_cust, indent=2))

Response

Response Body

TransitGatewayConnectionCust

Connection included in transit gateway

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

Status Code

201
The Transit Gateway connection was created successfully.
400
An invalid connection template was provided.
404
The specified Transit Gateway could not be found, the specified resource group could not be found, or the default resource group could not be found (if the resource group was not specified in the template).
409
The network being connected must either be in a location that is considered "local" to the specified Transit Gateway, or the specified Transit Gateway needs to be global. The network being connected cannot already be connected to another Transit Gateway.

Example responses

Status 201

{
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "name": "example-connection",
  "network_id": "crn:[...]",
  "network_type": "vpc",
  "prefix_filters_default": "permit",
  "request_status": "approved",
  "status": "pending",
  "updated_at": "2020-03-31T12:08:05Z"
}

Success example

{
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "name": "example-connection",
  "network_id": "crn:[...]",
  "network_type": "vpc",
  "prefix_filters_default": "permit",
  "request_status": "approved",
  "status": "pending",
  "updated_at": "2020-03-31T12:08:05Z"
}

Status 400

{
  "errors": [
    {
      "code": "validation_required_field_missing",
      "message": "Mandatory field is missing.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "type",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "validation_required_field_missing",
      "message": "Mandatory field is missing.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "type",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 409

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "NetworkID already exists, Invalid request",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "NetworkID already exists, Invalid request",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

After the specified connection is detached, entities still within the Transit Gateway will no longer be able to communicate directly to it through the IBM Cloud private backbone.

DELETE /transit_gateways/{transit_gateway_id}/connections/{id}

ServiceCall<Void> deleteTransitGatewayConnection(DeleteTransitGatewayConnectionOptions deleteTransitGatewayConnectionOptions)

deleteTransitGatewayConnection(params)

delete_transit_gateway_connection(
        self,
        transit_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnection(deleteTransitGatewayConnectionOptions *DeleteTransitGatewayConnectionOptions) (response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnectionWithContext(ctx context.Context, deleteTransitGatewayConnectionOptions *DeleteTransitGatewayConnectionOptions) (response *core.DetailedResponse, err error)

Request

Use the DeleteTransitGatewayConnectionOptions.Builder to create a DeleteTransitGatewayConnectionOptions object that contains the parameter values for the deleteTransitGatewayConnection method.

Instantiate the DeleteTransitGatewayConnectionOptions struct and set the fields to provide parameter values for the DeleteTransitGatewayConnection method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

DeleteTransitGatewayConnectionOptions

The deleteTransitGatewayConnection options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

DeleteTransitGatewayConnectionOptions

The DeleteTransitGatewayConnection options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}?version={version}"

Example request

deleteTransitGatewayConnectionOptions := transitGatewayApisService.NewDeleteTransitGatewayConnectionOptions(
  "testString",
  "testString",
)

response, err := transitGatewayApisService.DeleteTransitGatewayConnection(deleteTransitGatewayConnectionOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteTransitGatewayConnection(): %d\n", response.StatusCode)
}

Example request

DeleteTransitGatewayConnectionOptions deleteTransitGatewayConnectionOptions = new DeleteTransitGatewayConnectionOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .build();

Response<Void> response = transitGatewayApisService.deleteTransitGatewayConnection(deleteTransitGatewayConnectionOptions).execute();

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
};

try {
  await transitGatewayApisService.deleteTransitGatewayConnection(params);
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.delete_transit_gateway_connection(
  transit_gateway_id='testString',
  id='testString',
)

Response

Status Code

204
The connection was removed successfully.
404
A Transit Gateway or Transit Gateway connection with the specified identifier could not be found.

Example responses

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

This request retrieves a connection from the Transit Gateway.

GET /transit_gateways/{transit_gateway_id}/connections/{id}

ServiceCall<TransitGatewayConnectionCust> getTransitGatewayConnection(GetTransitGatewayConnectionOptions getTransitGatewayConnectionOptions)

getTransitGatewayConnection(params)

get_transit_gateway_connection(
        self,
        transit_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnection(getTransitGatewayConnectionOptions *GetTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnectionWithContext(ctx context.Context, getTransitGatewayConnectionOptions *GetTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

Request

Use the GetTransitGatewayConnectionOptions.Builder to create a GetTransitGatewayConnectionOptions object that contains the parameter values for the getTransitGatewayConnection method.

Instantiate the GetTransitGatewayConnectionOptions struct and set the fields to provide parameter values for the GetTransitGatewayConnection method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

GetTransitGatewayConnectionOptions

The getTransitGatewayConnection options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

GetTransitGatewayConnectionOptions

The GetTransitGatewayConnection options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}?version={version}"

Example request

getTransitGatewayConnectionOptions := transitGatewayApisService.NewGetTransitGatewayConnectionOptions(
  "testString",
  "testString",
)

transitGatewayConnectionCust, response, err := transitGatewayApisService.GetTransitGatewayConnection(getTransitGatewayConnectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(transitGatewayConnectionCust, "", "  ")
fmt.Println(string(b))

Example request

GetTransitGatewayConnectionOptions getTransitGatewayConnectionOptions = new GetTransitGatewayConnectionOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .build();

Response<TransitGatewayConnectionCust> response = transitGatewayApisService.getTransitGatewayConnection(getTransitGatewayConnectionOptions).execute();
TransitGatewayConnectionCust transitGatewayConnectionCust = response.getResult();

System.out.println(transitGatewayConnectionCust);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.getTransitGatewayConnection(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.get_transit_gateway_connection(
  transit_gateway_id='testString',
  id='testString',
)
transit_gateway_connection_cust = response.get_result()

print(json.dumps(transit_gateway_connection_cust, indent=2))

Response

Response Body

TransitGatewayConnectionCust

Connection included in transit gateway

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

Status Code

200
The connection was retrieved successfully.
404
A connection or gateway with the specified identifier(s) could not be found.

Example responses

Status 200

{
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "name": "example-connection",
  "network_id": "crn:[...]",
  "network_type": "vpc",
  "prefix_filters_default": "permit",
  "request_status": "approved",
  "status": "attached",
  "updated_at": "2020-03-31T12:08:05Z"
}

Success example

{
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "name": "example-connection",
  "network_id": "crn:[...]",
  "network_type": "vpc",
  "prefix_filters_default": "permit",
  "request_status": "approved",
  "status": "attached",
  "updated_at": "2020-03-31T12:08:05Z"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Update the name of a connection to a Transit Gateway.

PATCH /transit_gateways/{transit_gateway_id}/connections/{id}

ServiceCall<TransitGatewayConnectionCust> updateTransitGatewayConnection(UpdateTransitGatewayConnectionOptions updateTransitGatewayConnectionOptions)

updateTransitGatewayConnection(params)

update_transit_gateway_connection(
        self,
        transit_gateway_id: str,
        id: str,
        *,
        name: Optional[str] = None,
        prefix_filters_default: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnection(updateTransitGatewayConnectionOptions *UpdateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnectionWithContext(ctx context.Context, updateTransitGatewayConnectionOptions *UpdateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)

Request

Use the UpdateTransitGatewayConnectionOptions.Builder to create a UpdateTransitGatewayConnectionOptions object that contains the parameter values for the updateTransitGatewayConnection method.

Instantiate the UpdateTransitGatewayConnectionOptions struct and set the fields to provide parameter values for the UpdateTransitGatewayConnection method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

TransitGatewayConnectionPatch

The connection template

UpdateTransitGatewayConnectionOptions

The updateTransitGatewayConnection options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
name
string
The user-defined name for this transit gateway. If specified as empty string or nil, the name will be the network name (the name of the VPC in the case of network type vpc, and the word Classic, in the case of network type classic).

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html
prefixFiltersDefault
string
Default setting of permit or deny which applies to any routes that don't match a specified filter.

Allowable values: [permit,deny]
Examples:
value
_source
_lines
_html

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
name
str
The user-defined name for this transit gateway. If specified as empty string or nil, the name will be the network name (the name of the VPC in the case of network type vpc, and the word Classic, in the case of network type classic).

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html
prefix_filters_default
str
Default setting of permit or deny which applies to any routes that don't match a specified filter.

Allowable values: [permit,deny]
Examples:
value
_source
_lines
_html

parameter

WithContext method only

UpdateTransitGatewayConnectionOptions

The UpdateTransitGatewayConnection options.

Example request

curl -X PATCH --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{}'   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}?version={version}"

Example request

updateTransitGatewayConnectionOptions := transitGatewayApisService.NewUpdateTransitGatewayConnectionOptions(
  "testString",
  "testString",
)

transitGatewayConnectionCust, response, err := transitGatewayApisService.UpdateTransitGatewayConnection(updateTransitGatewayConnectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(transitGatewayConnectionCust, "", "  ")
fmt.Println(string(b))

Example request

UpdateTransitGatewayConnectionOptions updateTransitGatewayConnectionOptions = new UpdateTransitGatewayConnectionOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .build();

Response<TransitGatewayConnectionCust> response = transitGatewayApisService.updateTransitGatewayConnection(updateTransitGatewayConnectionOptions).execute();
TransitGatewayConnectionCust transitGatewayConnectionCust = response.getResult();

System.out.println(transitGatewayConnectionCust);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.updateTransitGatewayConnection(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.update_transit_gateway_connection(
  transit_gateway_id='testString',
  id='testString',
)
transit_gateway_connection_cust = response.get_result()

print(json.dumps(transit_gateway_connection_cust, indent=2))

Response

Response Body

TransitGatewayConnectionCust

Connection included in transit gateway

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

TransitGatewayConnectionCust

Connection included in transit gateway.

Status Code

200
The connection was updated successfully.
400
The connection update template was invalid.
404
A connection or gateway with the specified identifier(s) could not be found.

Example responses

Status 200

{
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "name": "example-connection-new-name",
  "network_id": "crn:[...]",
  "network_type": "vpc",
  "prefix_filters_default": "permit",
  "request_status": "approved",
  "status": "attached",
  "updated_at": "2020-03-31T12:08:05Z"
}

Success example

{
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "name": "example-connection-new-name",
  "network_id": "crn:[...]",
  "network_type": "vpc",
  "prefix_filters_default": "permit",
  "request_status": "approved",
  "status": "attached",
  "updated_at": "2020-03-31T12:08:05Z"
}

Status 400

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Allow a network owner to approve or reject a cross-account connection request.

POST /transit_gateways/{transit_gateway_id}/connections/{id}/actions

ServiceCall<Void> createTransitGatewayConnectionActions(CreateTransitGatewayConnectionActionsOptions createTransitGatewayConnectionActionsOptions)

createTransitGatewayConnectionActions(params)

create_transit_gateway_connection_actions(
        self,
        transit_gateway_id: str,
        id: str,
        action: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionActions(createTransitGatewayConnectionActionsOptions *CreateTransitGatewayConnectionActionsOptions) (response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionActionsWithContext(ctx context.Context, createTransitGatewayConnectionActionsOptions *CreateTransitGatewayConnectionActionsOptions) (response *core.DetailedResponse, err error)

Request

Use the CreateTransitGatewayConnectionActionsOptions.Builder to create a CreateTransitGatewayConnectionActionsOptions object that contains the parameter values for the createTransitGatewayConnectionActions method.

Instantiate the CreateTransitGatewayConnectionActionsOptions struct and set the fields to provide parameter values for the CreateTransitGatewayConnectionActions method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

TransitGatewayConnectionActions

The action template

CreateTransitGatewayConnectionActionsOptions

The createTransitGatewayConnectionActions options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
action
Required*
string
The action that is to be performed against the connection request.

Allowable values: [approve,reject]
Examples:
value
_source
_lines
_html

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
action
Required*
str
The action that is to be performed against the connection request.

Allowable values: [approve,reject]
Examples:
value
_source
_lines
_html

parameter

WithContext method only

CreateTransitGatewayConnectionActionsOptions

The CreateTransitGatewayConnectionActions options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Content-Type: application/json"   --data '{ "action": "approve" }'   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/actions?version={version}"

Example request

createTransitGatewayConnectionActionsOptions := transitGatewayApisService.NewCreateTransitGatewayConnectionActionsOptions(
  "testString",
  "testString",
  "approve",
)

response, err := transitGatewayApisService.CreateTransitGatewayConnectionActions(createTransitGatewayConnectionActionsOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from CreateTransitGatewayConnectionActions(): %d\n", response.StatusCode)
}

Example request

CreateTransitGatewayConnectionActionsOptions createTransitGatewayConnectionActionsOptions = new CreateTransitGatewayConnectionActionsOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .action("approve")
  .build();

Response<Void> response = transitGatewayApisService.createTransitGatewayConnectionActions(createTransitGatewayConnectionActionsOptions).execute();

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  action: 'approve',
};

try {
  await transitGatewayApisService.createTransitGatewayConnectionActions(params);
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.create_transit_gateway_connection_actions(
  transit_gateway_id='testString',
  id='testString',
  action='approve',
)

Response

Status Code

204
The connection approval/rejection was successful.
403
The caller is not authorized to perform the requested action, or the action was called by the gateway owning account.
404
A Transit Gateway or Transit Gateway connection with the specified identifier could not be found.
409
Attempted to approve a classic_access VPC connection.

Example responses

Status 403

{
  "errors": [
    {
      "code": "not_authorized",
      "message": "The request is not authorized.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_authorized",
      "message": "The request is not authorized.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 409

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "Attempted to approve a classic_access VPC connection.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "invalid_state",
      "message": "Attempted to approve a classic_access VPC connection.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

This request retrieves a list of all the tunnels for the redundant GRE conneciton.

This request retrieves a list of all the tunnels for the redundant gre conneciton.

GET /transit_gateways/{transit_gateway_id}/connections/{id}/tunnels

ServiceCall<RedundantGRETunnelCollection> getTransitGatewayGreTunnel(GetTransitGatewayGreTunnelOptions getTransitGatewayGreTunnelOptions)

getTransitGatewayGreTunnel(params)

get_transit_gateway_gre_tunnel(
        self,
        transit_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayGreTunnel(getTransitGatewayGreTunnelOptions *GetTransitGatewayGreTunnelOptions) (result *RedundantGRETunnelCollection, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayGreTunnelWithContext(ctx context.Context, getTransitGatewayGreTunnelOptions *GetTransitGatewayGreTunnelOptions) (result *RedundantGRETunnelCollection, response *core.DetailedResponse, err error)

Request

Use the GetTransitGatewayGreTunnelOptions.Builder to create a GetTransitGatewayGreTunnelOptions object that contains the parameter values for the getTransitGatewayGreTunnel method.

Instantiate the GetTransitGatewayGreTunnelOptions struct and set the fields to provide parameter values for the GetTransitGatewayGreTunnel method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

GetTransitGatewayGreTunnelOptions

The getTransitGatewayGreTunnel options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

GetTransitGatewayGreTunnelOptions

The GetTransitGatewayGreTunnel options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/tunnels?version={version}"

Example request

getTransitGatewayGreTunnelOptions := transitGatewayApisService.NewGetTransitGatewayGreTunnelOptions(
  "testString",
  "testString",
)

redundantGreTunnelCollection, response, err := transitGatewayApisService.GetTransitGatewayGreTunnel(getTransitGatewayGreTunnelOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(redundantGreTunnelCollection, "", "  ")
fmt.Println(string(b))

Example request

GetTransitGatewayGreTunnelOptions getTransitGatewayGreTunnelOptions = new GetTransitGatewayGreTunnelOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .build();

Response<RedundantGRETunnelCollection> response = transitGatewayApisService.getTransitGatewayGreTunnel(getTransitGatewayGreTunnelOptions).execute();
RedundantGRETunnelCollection redundantGreTunnelCollection = response.getResult();

System.out.println(redundantGreTunnelCollection);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.getTransitGatewayGreTunnel(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.get_transit_gateway_gre_tunnel(
  transit_gateway_id='testString',
  id='testString',
)
redundant_gre_tunnel_collection = response.get_result()

print(json.dumps(redundant_gre_tunnel_collection, indent=2))

Response

Response Body

TransitGatewayTunnelCollection

Collection of all tunnels for redundant GRE connections.

RedundantGRETunnelCollection

Collection of all tunnels for redundant gre connection.

RedundantGRETunnelCollection

Collection of all tunnels for redundant gre connection.

RedundantGRETunnelCollection

Collection of all tunnels for redundant gre connection.

RedundantGRETunnelCollection

Collection of all tunnels for redundant gre connection.

Status Code

200
The list of tunnels was retrieved successfully.
404
A connection or gateway with the specified identifier(s) could not be found.

Example responses

Status 200

{
  "tunnels": [
    {
      "base_network_type": "vpc",
      "created_at": "2023-11-13T17:12:36.625Z",
      "id": "0a06fb9b-820f-4c44-8a31-77f1f0806d32",
      "local_bgp_asn": 45876,
      "local_gateway_ip": "192.168.100.1",
      "local_tunnel_ip": "192.168.129.2",
      "mtu": 9000,
      "name": "gre1",
      "network_id": "crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b",
      "remote_bgp_asn": 65010,
      "remote_gateway_ip": "10.242.63.12",
      "remote_tunnel_ip": "192.168.129.1",
      "status": "attached",
      "updated_at": "2023-11-13T17:11:55.625Z",
      "zone": {
        "name": "us-south-1"
      }
    },
    {
      "base_network_type": "vpc",
      "created_at": "2023-11-13T16:12:36.625Z",
      "id": "b0b6fb9b-820f-4c44-8a31-aaff1f08106d32",
      "local_bgp_asn": 45992,
      "local_gateway_ip": "192.168.210.1",
      "local_tunnel_ip": "192.168.229.2",
      "mtu": 9000,
      "name": "gre1",
      "network_id": "crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b",
      "remote_bgp_asn": 63220,
      "remote_gateway_ip": "10.100.163.12",
      "remote_tunnel_ip": "192.168.229.1",
      "status": "pending",
      "updated_at": "2023-11-13T16:11:55.625Z",
      "zone": {
        "name": "us-south-2"
      }
    }
  ]
}

Success example

{
  "tunnels": [
    {
      "base_network_type": "vpc",
      "created_at": "2023-11-13T17:12:36.625Z",
      "id": "0a06fb9b-820f-4c44-8a31-77f1f0806d32",
      "local_bgp_asn": 45876,
      "local_gateway_ip": "192.168.100.1",
      "local_tunnel_ip": "192.168.129.2",
      "mtu": 9000,
      "name": "gre1",
      "network_id": "crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b",
      "remote_bgp_asn": 65010,
      "remote_gateway_ip": "10.242.63.12",
      "remote_tunnel_ip": "192.168.129.1",
      "status": "attached",
      "updated_at": "2023-11-13T17:11:55.625Z",
      "zone": {
        "name": "us-south-1"
      }
    },
    {
      "base_network_type": "vpc",
      "created_at": "2023-11-13T16:12:36.625Z",
      "id": "b0b6fb9b-820f-4c44-8a31-aaff1f08106d32",
      "local_bgp_asn": 45992,
      "local_gateway_ip": "192.168.210.1",
      "local_tunnel_ip": "192.168.229.2",
      "mtu": 9000,
      "name": "gre1",
      "network_id": "crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b",
      "remote_bgp_asn": 63220,
      "remote_gateway_ip": "10.100.163.12",
      "remote_tunnel_ip": "192.168.229.1",
      "status": "pending",
      "updated_at": "2023-11-13T16:11:55.625Z",
      "zone": {
        "name": "us-south-2"
      }
    }
  ]
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find redundant GRE tunnels",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find redundant GRE tunnels",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Add a tunnel to an existing Redundant GRE connection.

POST /transit_gateways/{transit_gateway_id}/connections/{id}/tunnels

ServiceCall<RedundantGRETunnelReference> createTransitGatewayGreTunnel(CreateTransitGatewayGreTunnelOptions createTransitGatewayGreTunnelOptions)

createTransitGatewayGreTunnel(params)

create_transit_gateway_gre_tunnel(
        self,
        transit_gateway_id: str,
        id: str,
        local_gateway_ip: str,
        local_tunnel_ip: str,
        name: str,
        remote_gateway_ip: str,
        remote_tunnel_ip: str,
        zone: 'ZoneIdentity',
        *,
        remote_bgp_asn: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayGreTunnel(createTransitGatewayGreTunnelOptions *CreateTransitGatewayGreTunnelOptions) (result *RedundantGRETunnelReference, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayGreTunnelWithContext(ctx context.Context, createTransitGatewayGreTunnelOptions *CreateTransitGatewayGreTunnelOptions) (result *RedundantGRETunnelReference, response *core.DetailedResponse, err error)

Request

Use the CreateTransitGatewayGreTunnelOptions.Builder to create a CreateTransitGatewayGreTunnelOptions object that contains the parameter values for the createTransitGatewayGreTunnel method.

Instantiate the CreateTransitGatewayGreTunnelOptions struct and set the fields to provide parameter values for the CreateTransitGatewayGreTunnel method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

TransitGatewayTunnelTemplate

The action template

CreateTransitGatewayGreTunnelOptions

The createTransitGatewayGreTunnel options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
localGatewayIp
Required*
string
Local gateway IP address.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
localTunnelIp
Required*
string
Local tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
name
Required*
string
The user-defined name for this tunnel connection.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html
remoteGatewayIp
Required*
string
Remote gateway IP address.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
remoteTunnelIp
Required*
string
Remote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
zone
Availability zone.

Change Request Parameter List
remoteBgpAsn
number
Remote network BGP ASN. The following ASN values are reserved and unavailable 0, 13884, 36351, 64512-64513, 65100, 65200-65234, 65402-65433, 65500 and 4201065000-4201065999. If remote_bgp_asn is omitted on create requests, IBM will assign an ASN.

Examples:
value
_source
_lines
_html

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
local_gateway_ip
Required*
str
Local gateway IP address.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
local_tunnel_ip
Required*
str
Local tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
name
Required*
str
The user-defined name for this tunnel connection.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html
remote_gateway_ip
Required*
str
Remote gateway IP address.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
remote_tunnel_ip
Required*
str
Remote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.

Possible values: 0 ≤ length ≤ 40, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:
value
_source
_lines
_html
zone
Availability zone.

Change Request Parameter List
remote_bgp_asn
int
Remote network BGP ASN. The following ASN values are reserved and unavailable 0, 13884, 36351, 64512-64513, 65100, 65200-65234, 65402-65433, 65500 and 4201065000-4201065999. If remote_bgp_asn is omitted on create requests, IBM will assign an ASN.

Examples:
value
_source
_lines
_html

parameter

WithContext method only

CreateTransitGatewayGreTunnelOptions

The CreateTransitGatewayGreTunnel options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "local_gateway_ip": "10.242.63.12", "local_tunnel_ip": "192.168.100.20", "name": "gre1", "remote_gateway_ip": "10.242.33.22", "remote_tunnel_ip": "192.168.129.1", "zone": {} }'   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/tunnels?version={version}"

Example request

zoneIdentityModel := &transitgatewayapisv1.ZoneIdentityByName{
}

createTransitGatewayGreTunnelOptions := transitGatewayApisService.NewCreateTransitGatewayGreTunnelOptions(
  "testString",
  "testString",
  "10.242.63.12",
  "192.168.100.20",
  "gre1",
  "10.242.33.22",
  "192.168.129.1",
  zoneIdentityModel,
)

redundantGreTunnelReference, response, err := transitGatewayApisService.CreateTransitGatewayGreTunnel(createTransitGatewayGreTunnelOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(redundantGreTunnelReference, "", "  ")
fmt.Println(string(b))

Example request

ZoneIdentityByName zoneIdentityModel = new ZoneIdentityByName.Builder()
  .build();
CreateTransitGatewayGreTunnelOptions createTransitGatewayGreTunnelOptions = new CreateTransitGatewayGreTunnelOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .localGatewayIp("10.242.63.12")
  .localTunnelIp("192.168.100.20")
  .name("gre1")
  .remoteGatewayIp("10.242.33.22")
  .remoteTunnelIp("192.168.129.1")
  .zone(zoneIdentityModel)
  .build();

Response<RedundantGRETunnelReference> response = transitGatewayApisService.createTransitGatewayGreTunnel(createTransitGatewayGreTunnelOptions).execute();
RedundantGRETunnelReference redundantGreTunnelReference = response.getResult();

System.out.println(redundantGreTunnelReference);

Example request

// Request models needed by this operation.

// ZoneIdentityByName
const zoneIdentityModel = {
};

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  localGatewayIp: '10.242.63.12',
  localTunnelIp: '192.168.100.20',
  name: 'gre1',
  remoteGatewayIp: '10.242.33.22',
  remoteTunnelIp: '192.168.129.1',
  zone: zoneIdentityModel,
};

let res;
try {
  res = await transitGatewayApisService.createTransitGatewayGreTunnel(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

zone_identity_model = {
}

response = transit_gateway_apis_service.create_transit_gateway_gre_tunnel(
  transit_gateway_id='testString',
  id='testString',
  local_gateway_ip='10.242.63.12',
  local_tunnel_ip='192.168.100.20',
  name='gre1',
  remote_gateway_ip='10.242.33.22',
  remote_tunnel_ip='192.168.129.1',
  zone=zone_identity_model,
)
redundant_gre_tunnel_reference = response.get_result()

print(json.dumps(redundant_gre_tunnel_reference, indent=2))

Response

Response Body

TransitGatewayTunnel

Details for a redundant GRE tunnel

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

Status Code

201
Successfully created the new Redundant GRE tunnel connection.
403
The caller is not authorized to perform the requested action, or the action was called by the gateway owning account.
404
A Transit Gateway or Transit Gateway connection with the specified identifier could not be found.

Example responses

Status 201

{
  "base_network_type": "classic",
  "created_at": "2023-11-13T17:12:36.625Z",
  "id": "0a06fb9b-820f-4c44-8a31-77f1f0806d32",
  "local_bgp_asn": 45876,
  "local_gateway_ip": "192.168.100.1",
  "local_tunnel_ip": "192.168.129.2",
  "mtu": 9000,
  "name": "gre1",
  "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
  "redundant_gre_id": "83792525-471c-47d0-9e84-jdy830jd",
  "remote_bgp_asn": 65010,
  "remote_gateway_ip": "10.242.63.12",
  "remote_tunnel_ip": "192.168.129.1",
  "status": "pending",
  "updated_at": "2023-11-13T17:11:55.625Z",
  "zone": {
    "name": "us-south-1"
  }
}

Success example

{
  "base_network_type": "classic",
  "created_at": "2023-11-13T17:12:36.625Z",
  "id": "0a06fb9b-820f-4c44-8a31-77f1f0806d32",
  "local_bgp_asn": 45876,
  "local_gateway_ip": "192.168.100.1",
  "local_tunnel_ip": "192.168.129.2",
  "mtu": 9000,
  "name": "gre1",
  "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
  "redundant_gre_id": "83792525-471c-47d0-9e84-jdy830jd",
  "remote_bgp_asn": 65010,
  "remote_gateway_ip": "10.242.63.12",
  "remote_tunnel_ip": "192.168.129.1",
  "status": "pending",
  "updated_at": "2023-11-13T17:11:55.625Z",
  "zone": {
    "name": "us-south-1"
  }
}

Status 403

{
  "errors": [
    {
      "code": "not_authorized",
      "message": "The request is not authorized.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_authorized",
      "message": "The request is not authorized.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Remove a tunnel from a redundant GRE connection

Remove a tunnel from a redundant GRE connection.

DELETE /transit_gateways/{transit_gateway_id}/connections/{id}/tunnels/{gre_tunnel_id}

ServiceCall<Void> deleteTransitGatewayConnectionTunnels(DeleteTransitGatewayConnectionTunnelsOptions deleteTransitGatewayConnectionTunnelsOptions)

deleteTransitGatewayConnectionTunnels(params)

delete_transit_gateway_connection_tunnels(
        self,
        transit_gateway_id: str,
        id: str,
        gre_tunnel_id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnectionTunnels(deleteTransitGatewayConnectionTunnelsOptions *DeleteTransitGatewayConnectionTunnelsOptions) (response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnectionTunnelsWithContext(ctx context.Context, deleteTransitGatewayConnectionTunnelsOptions *DeleteTransitGatewayConnectionTunnelsOptions) (response *core.DetailedResponse, err error)

Request

Use the DeleteTransitGatewayConnectionTunnelsOptions.Builder to create a DeleteTransitGatewayConnectionTunnelsOptions object that contains the parameter values for the deleteTransitGatewayConnectionTunnels method.

Instantiate the DeleteTransitGatewayConnectionTunnelsOptions struct and set the fields to provide parameter values for the DeleteTransitGatewayConnectionTunnels method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
gre_tunnel_id
Required*
string
The tunnel identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

DeleteTransitGatewayConnectionTunnelsOptions

The deleteTransitGatewayConnectionTunnels options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
greTunnelId
Required*
string
The tunnel identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
gre_tunnel_id
Required*
str
The tunnel identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

DeleteTransitGatewayConnectionTunnelsOptions

The DeleteTransitGatewayConnectionTunnels options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/tunnels/{gre_tunnel_id}?version={version}"

Example request

deleteTransitGatewayConnectionTunnelsOptions := transitGatewayApisService.NewDeleteTransitGatewayConnectionTunnelsOptions(
  "testString",
  "testString",
  "testString",
)

response, err := transitGatewayApisService.DeleteTransitGatewayConnectionTunnels(deleteTransitGatewayConnectionTunnelsOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteTransitGatewayConnectionTunnels(): %d\n", response.StatusCode)
}

Example request

DeleteTransitGatewayConnectionTunnelsOptions deleteTransitGatewayConnectionTunnelsOptions = new DeleteTransitGatewayConnectionTunnelsOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .greTunnelId("testString")
  .build();

Response<Void> response = transitGatewayApisService.deleteTransitGatewayConnectionTunnels(deleteTransitGatewayConnectionTunnelsOptions).execute();

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  greTunnelId: 'testString',
};

try {
  await transitGatewayApisService.deleteTransitGatewayConnectionTunnels(params);
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.delete_transit_gateway_connection_tunnels(
  transit_gateway_id='testString',
  id='testString',
  gre_tunnel_id='testString',
)

Response

Status Code

204
The connection tunnel was removed successfully.
404
A Transit Gateway or Transit Gateway connection with the specified identifier could not be found.

Example responses

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection Tunnel",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection Tunnel",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

This request retrieves a connection tunnel from the Transit Gateway Connection.

GET /transit_gateways/{transit_gateway_id}/connections/{id}/tunnels/{gre_tunnel_id}

ServiceCall<RedundantGRETunnelReference> getTransitGatewayConnectionTunnels(GetTransitGatewayConnectionTunnelsOptions getTransitGatewayConnectionTunnelsOptions)

getTransitGatewayConnectionTunnels(params)

get_transit_gateway_connection_tunnels(
        self,
        transit_gateway_id: str,
        id: str,
        gre_tunnel_id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnectionTunnels(getTransitGatewayConnectionTunnelsOptions *GetTransitGatewayConnectionTunnelsOptions) (result *RedundantGRETunnelReference, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnectionTunnelsWithContext(ctx context.Context, getTransitGatewayConnectionTunnelsOptions *GetTransitGatewayConnectionTunnelsOptions) (result *RedundantGRETunnelReference, response *core.DetailedResponse, err error)

Request

Use the GetTransitGatewayConnectionTunnelsOptions.Builder to create a GetTransitGatewayConnectionTunnelsOptions object that contains the parameter values for the getTransitGatewayConnectionTunnels method.

Instantiate the GetTransitGatewayConnectionTunnelsOptions struct and set the fields to provide parameter values for the GetTransitGatewayConnectionTunnels method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
gre_tunnel_id
Required*
string
The tunnel identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

GetTransitGatewayConnectionTunnelsOptions

The getTransitGatewayConnectionTunnels options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
greTunnelId
Required*
string
The tunnel identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
gre_tunnel_id
Required*
str
The tunnel identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

GetTransitGatewayConnectionTunnelsOptions

The GetTransitGatewayConnectionTunnels options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/tunnels/{gre_tunnel_id}?version={version}"

Example request

getTransitGatewayConnectionTunnelsOptions := transitGatewayApisService.NewGetTransitGatewayConnectionTunnelsOptions(
  "testString",
  "testString",
  "testString",
)

redundantGreTunnelReference, response, err := transitGatewayApisService.GetTransitGatewayConnectionTunnels(getTransitGatewayConnectionTunnelsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(redundantGreTunnelReference, "", "  ")
fmt.Println(string(b))

Example request

GetTransitGatewayConnectionTunnelsOptions getTransitGatewayConnectionTunnelsOptions = new GetTransitGatewayConnectionTunnelsOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .greTunnelId("testString")
  .build();

Response<RedundantGRETunnelReference> response = transitGatewayApisService.getTransitGatewayConnectionTunnels(getTransitGatewayConnectionTunnelsOptions).execute();
RedundantGRETunnelReference redundantGreTunnelReference = response.getResult();

System.out.println(redundantGreTunnelReference);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  greTunnelId: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.getTransitGatewayConnectionTunnels(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.get_transit_gateway_connection_tunnels(
  transit_gateway_id='testString',
  id='testString',
  gre_tunnel_id='testString',
)
redundant_gre_tunnel_reference = response.get_result()

print(json.dumps(redundant_gre_tunnel_reference, indent=2))

Response

Response Body

TransitGatewayTunnel

Details for a redundant GRE tunnel

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

Status Code

200
The connection tunnel was retrieved successfully.
404
A connection, gateway or tunnel with the specified identifier(s) could not be found.

Example responses

Status 200

{
  "base_network_type": "classic",
  "created_at": "2023-11-13T17:12:36.625Z",
  "id": "0a06fb9b-820f-4c44-8a31-77f1f0806d32",
  "local_bgp_asn": 45876,
  "local_gateway_ip": "192.168.100.1",
  "local_tunnel_ip": "192.168.129.2",
  "mtu": 9000,
  "name": "gre1",
  "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
  "redundant_gre_id": "83792525-471c-47d0-9e84-jdy830jd",
  "remote_bgp_asn": 65010,
  "remote_gateway_ip": "10.242.63.12",
  "remote_tunnel_ip": "192.168.129.1",
  "status": "attached",
  "updated_at": "2023-11-13T17:11:55.625Z",
  "zone": {
    "name": "us-south-1"
  }
}

Success example

{
  "base_network_type": "classic",
  "created_at": "2023-11-13T17:12:36.625Z",
  "id": "0a06fb9b-820f-4c44-8a31-77f1f0806d32",
  "local_bgp_asn": 45876,
  "local_gateway_ip": "192.168.100.1",
  "local_tunnel_ip": "192.168.129.2",
  "mtu": 9000,
  "name": "gre1",
  "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
  "redundant_gre_id": "83792525-471c-47d0-9e84-jdy830jd",
  "remote_bgp_asn": 65010,
  "remote_gateway_ip": "10.242.63.12",
  "remote_tunnel_ip": "192.168.129.1",
  "status": "attached",
  "updated_at": "2023-11-13T17:11:55.625Z",
  "zone": {
    "name": "us-south-1"
  }
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection Tunnel",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection Tunnel",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Update the name of a connection tunnel.

PATCH /transit_gateways/{transit_gateway_id}/connections/{id}/tunnels/{gre_tunnel_id}

ServiceCall<RedundantGRETunnelReference> updateTransitGatewayConnectionTunnels(UpdateTransitGatewayConnectionTunnelsOptions updateTransitGatewayConnectionTunnelsOptions)

updateTransitGatewayConnectionTunnels(params)

update_transit_gateway_connection_tunnels(
        self,
        transit_gateway_id: str,
        id: str,
        gre_tunnel_id: str,
        *,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnectionTunnels(updateTransitGatewayConnectionTunnelsOptions *UpdateTransitGatewayConnectionTunnelsOptions) (result *RedundantGRETunnelReference, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnectionTunnelsWithContext(ctx context.Context, updateTransitGatewayConnectionTunnelsOptions *UpdateTransitGatewayConnectionTunnelsOptions) (result *RedundantGRETunnelReference, response *core.DetailedResponse, err error)

Request

Use the UpdateTransitGatewayConnectionTunnelsOptions.Builder to create a UpdateTransitGatewayConnectionTunnelsOptions object that contains the parameter values for the updateTransitGatewayConnectionTunnels method.

Instantiate the UpdateTransitGatewayConnectionTunnelsOptions struct and set the fields to provide parameter values for the UpdateTransitGatewayConnectionTunnels method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
gre_tunnel_id
Required*
string
The tunnel identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

application/merge-patch+jsonTransitGatewayTunnelPatch

The update connection tunnel template

UpdateTransitGatewayConnectionTunnelsOptions

The updateTransitGatewayConnectionTunnels options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
greTunnelId
Required*
string
The tunnel identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
name
string
The user-defined name for this connection tunnel.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
gre_tunnel_id
Required*
str
The tunnel identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
name
str
The user-defined name for this connection tunnel.

Possible values: 1 ≤ length ≤ 63, Value must match regular expression /^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:
value
_source
_lines
_html

parameter

WithContext method only

UpdateTransitGatewayConnectionTunnelsOptions

The UpdateTransitGatewayConnectionTunnels options.

Example request

curl -X PATCH --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{}'   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/tunnels/{gre_tunnel_id}?version={version}"

Example request

updateTransitGatewayConnectionTunnelsOptions := transitGatewayApisService.NewUpdateTransitGatewayConnectionTunnelsOptions(
  "testString",
  "testString",
  "testString",
)

redundantGreTunnelReference, response, err := transitGatewayApisService.UpdateTransitGatewayConnectionTunnels(updateTransitGatewayConnectionTunnelsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(redundantGreTunnelReference, "", "  ")
fmt.Println(string(b))

Example request

UpdateTransitGatewayConnectionTunnelsOptions updateTransitGatewayConnectionTunnelsOptions = new UpdateTransitGatewayConnectionTunnelsOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .greTunnelId("testString")
  .build();

Response<RedundantGRETunnelReference> response = transitGatewayApisService.updateTransitGatewayConnectionTunnels(updateTransitGatewayConnectionTunnelsOptions).execute();
RedundantGRETunnelReference redundantGreTunnelReference = response.getResult();

System.out.println(redundantGreTunnelReference);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  greTunnelId: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.updateTransitGatewayConnectionTunnels(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.update_transit_gateway_connection_tunnels(
  transit_gateway_id='testString',
  id='testString',
  gre_tunnel_id='testString',
)
redundant_gre_tunnel_reference = response.get_result()

print(json.dumps(redundant_gre_tunnel_reference, indent=2))

Response

Response Body

TransitGatewayTunnel

Details for a redundant GRE tunnel

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

RedundantGRETunnelReference

Details for a redundant GRE tunnel.

Status Code

200
The connection tunnel was updated successfully.
400
The connection tunnel update template was invalid.
404
A connection, gateway or tunnel with the specified identifier(s) could not be found.

Example responses

Status 200

{
  "base_network_type": "classic",
  "created_at": "2023-11-13T17:12:36.625Z",
  "id": "0a06fb9b-820f-4c44-8a31-77f1f0806d32",
  "local_bgp_asn": 45876,
  "local_gateway_ip": "192.168.100.1",
  "local_tunnel_ip": "192.168.129.2",
  "mtu": 9000,
  "name": "gre2",
  "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
  "redundant_gre_id": "83792525-471c-47d0-9e84-fdb830fd",
  "remote_bgp_asn": 65010,
  "remote_gateway_ip": "10.242.63.12",
  "remote_tunnel_ip": "192.168.129.1",
  "status": "attached",
  "updated_at": "2023-12-10T07:52:22.234Z",
  "zone": {
    "name": "us-south-1"
  }
}

Success example

{
  "base_network_type": "classic",
  "created_at": "2023-11-13T17:12:36.625Z",
  "id": "0a06fb9b-820f-4c44-8a31-77f1f0806d32",
  "local_bgp_asn": 45876,
  "local_gateway_ip": "192.168.100.1",
  "local_tunnel_ip": "192.168.129.2",
  "mtu": 9000,
  "name": "gre2",
  "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
  "redundant_gre_id": "83792525-471c-47d0-9e84-fdb830fd",
  "remote_bgp_asn": 65010,
  "remote_gateway_ip": "10.242.63.12",
  "remote_tunnel_ip": "192.168.129.1",
  "status": "attached",
  "updated_at": "2023-12-10T07:52:22.234Z",
  "zone": {
    "name": "us-south-1"
  }
}

Status 400

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection Tunnel",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Connection Tunnel",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

List all locations that support Transit Gateways.

GET /locations

ServiceCall<TSCollection> listGatewayLocations(ListGatewayLocationsOptions listGatewayLocationsOptions)

listGatewayLocations(params)

list_gateway_locations(
        self,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) ListGatewayLocations(listGatewayLocationsOptions *ListGatewayLocationsOptions) (result *TSCollection, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) ListGatewayLocationsWithContext(ctx context.Context, listGatewayLocationsOptions *ListGatewayLocationsOptions) (result *TSCollection, response *core.DetailedResponse, err error)

Request

Use the ListGatewayLocationsOptions.Builder to create a ListGatewayLocationsOptions object that contains the parameter values for the listGatewayLocations method.

Instantiate the ListGatewayLocationsOptions struct and set the fields to provide parameter values for the ListGatewayLocations method.

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

parameters

parameter

WithContext method only

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/locations?version={version}"

Example request

listGatewayLocationsOptions := transitGatewayApisService.NewListGatewayLocationsOptions()

tsCollection, response, err := transitGatewayApisService.ListGatewayLocations(listGatewayLocationsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(tsCollection, "", "  ")
fmt.Println(string(b))

Example request

ListGatewayLocationsOptions listGatewayLocationsOptions = new ListGatewayLocationsOptions();

Response<TSCollection> response = transitGatewayApisService.listGatewayLocations(listGatewayLocationsOptions).execute();
TSCollection tsCollection = response.getResult();

System.out.println(tsCollection);

Example request

let res;
try {
  res = await transitGatewayApisService.listGatewayLocations({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.list_gateway_locations()
ts_collection = response.get_result()

print(json.dumps(ts_collection, indent=2))

Response

Response Body

TSCollection

A list of Transit Gateway locations

TSCollection

A list of Transit Gateway locations.

TSCollection

A list of Transit Gateway locations.

TSCollection

A list of Transit Gateway locations.

TSCollection

A list of Transit Gateway locations.

Status Code

200
Successfully retrieved the list of Transit Gateway locations.

Example responses

Status 200

{
  "locations": [
    {
      "billing_location": "us",
      "name": "us-south",
      "type": "region"
    },
    {
      "billing_location": "us",
      "name": "us-east",
      "type": "region"
    },
    {
      "billing_location": "ap",
      "name": "au-syd",
      "type": "region"
    },
    {
      "billing_location": "eu",
      "name": "eu-de",
      "type": "region"
    },
    {
      "billing_location": "ap",
      "name": "jp-jok",
      "type": "region"
    }
  ]
}

Success example

{
  "locations": [
    {
      "billing_location": "us",
      "name": "us-south",
      "type": "region"
    },
    {
      "billing_location": "us",
      "name": "us-east",
      "type": "region"
    },
    {
      "billing_location": "ap",
      "name": "au-syd",
      "type": "region"
    },
    {
      "billing_location": "eu",
      "name": "eu-de",
      "type": "region"
    },
    {
      "billing_location": "ap",
      "name": "jp-jok",
      "type": "region"
    }
  ]
}

Get the details of a Transit Gateway Location.

GET /locations/{name}

ServiceCall<TSLocation> getGatewayLocation(GetGatewayLocationOptions getGatewayLocationOptions)

getGatewayLocation(params)

get_gateway_location(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) GetGatewayLocation(getGatewayLocationOptions *GetGatewayLocationOptions) (result *TSLocation, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) GetGatewayLocationWithContext(ctx context.Context, getGatewayLocationOptions *GetGatewayLocationOptions) (result *TSLocation, response *core.DetailedResponse, err error)

Request

Use the GetGatewayLocationOptions.Builder to create a GetGatewayLocationOptions object that contains the parameter values for the getGatewayLocation method.

Instantiate the GetGatewayLocationOptions struct and set the fields to provide parameter values for the GetGatewayLocation method.

Path Parameters

name
Required*
string
The Transit Gateway location Name

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[a-z]([a-z-0-9]){0,35}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

GetGatewayLocationOptions

The getGatewayLocation options.

parameters

name
Required*
string
The Transit Gateway location Name.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[a-z]([a-z-0-9]){0,35}$/

parameters

name
Required*
str
The Transit Gateway location Name.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[a-z]([a-z-0-9]){0,35}$/

parameter

WithContext method only

GetGatewayLocationOptions

The GetGatewayLocation options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/locations/{name}?version={version}"

Example request

getGatewayLocationOptions := transitGatewayApisService.NewGetGatewayLocationOptions(
  "testString",
)

tsLocation, response, err := transitGatewayApisService.GetGatewayLocation(getGatewayLocationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(tsLocation, "", "  ")
fmt.Println(string(b))

Example request

GetGatewayLocationOptions getGatewayLocationOptions = new GetGatewayLocationOptions.Builder()
  .name("testString")
  .build();

Response<TSLocation> response = transitGatewayApisService.getGatewayLocation(getGatewayLocationOptions).execute();
TSLocation tsLocation = response.getResult();

System.out.println(tsLocation);

Example request

const params = {
  name: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.getGatewayLocation(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.get_gateway_location(
  name='testString',
)
ts_location = response.get_result()

print(json.dumps(ts_location, indent=2))

Response

Response Body

TSLocation

Details of a Transit Gateway location

TSLocation

Details of a Transit Gateway location.

TSLocation

Details of a Transit Gateway location.

TSLocation

Details of a Transit Gateway location.

TSLocation

Details of a Transit Gateway location.

Status Code

200
Successfully retrieved the Transit Gateway Location.
404
The given location name could not be found.

Example responses

Status 200

{
  "billing_location": "us",
  "local_connection_locations": [
    {
      "display_name": "Dallas",
      "name": "us-south",
      "type": "region"
    }
  ],
  "name": "us-south",
  "type": "region",
  "zones": [
    {
      "zone": {
        "name": "us-south-1"
      }
    }
  ]
}

Success example

{
  "billing_location": "us",
  "local_connection_locations": [
    {
      "display_name": "Dallas",
      "name": "us-south",
      "type": "region"
    }
  ],
  "name": "us-south",
  "type": "region",
  "zones": [
    {
      "zone": {
        "name": "us-south-1"
      }
    }
  ]
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Location not found",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Location not found",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

This request retrieves all prefix filters in a Transit Gateway connection.

GET /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters

ServiceCall<PrefixFilterCollection> listTransitGatewayConnectionPrefixFilters(ListTransitGatewayConnectionPrefixFiltersOptions listTransitGatewayConnectionPrefixFiltersOptions)

listTransitGatewayConnectionPrefixFilters(params)

list_transit_gateway_connection_prefix_filters(
        self,
        transit_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnectionPrefixFilters(listTransitGatewayConnectionPrefixFiltersOptions *ListTransitGatewayConnectionPrefixFiltersOptions) (result *PrefixFilterCollection, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnectionPrefixFiltersWithContext(ctx context.Context, listTransitGatewayConnectionPrefixFiltersOptions *ListTransitGatewayConnectionPrefixFiltersOptions) (result *PrefixFilterCollection, response *core.DetailedResponse, err error)

Request

Use the ListTransitGatewayConnectionPrefixFiltersOptions.Builder to create a ListTransitGatewayConnectionPrefixFiltersOptions object that contains the parameter values for the listTransitGatewayConnectionPrefixFilters method.

Instantiate the ListTransitGatewayConnectionPrefixFiltersOptions struct and set the fields to provide parameter values for the ListTransitGatewayConnectionPrefixFilters method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

ListTransitGatewayConnectionPrefixFiltersOptions

The listTransitGatewayConnectionPrefixFilters options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

ListTransitGatewayConnectionPrefixFiltersOptions

The ListTransitGatewayConnectionPrefixFilters options.

Example request

listTransitGatewayConnectionPrefixFiltersOptions := transitGatewayApisService.NewListTransitGatewayConnectionPrefixFiltersOptions(
  "testString",
  "testString",
)

prefixFilterCollection, response, err := transitGatewayApisService.ListTransitGatewayConnectionPrefixFilters(listTransitGatewayConnectionPrefixFiltersOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(prefixFilterCollection, "", "  ")
fmt.Println(string(b))

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters?version={version}"

Example request

ListTransitGatewayConnectionPrefixFiltersOptions listTransitGatewayConnectionPrefixFiltersOptions = new ListTransitGatewayConnectionPrefixFiltersOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .build();

Response<PrefixFilterCollection> response = transitGatewayApisService.listTransitGatewayConnectionPrefixFilters(listTransitGatewayConnectionPrefixFiltersOptions).execute();
PrefixFilterCollection prefixFilterCollection = response.getResult();

System.out.println(prefixFilterCollection);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.listTransitGatewayConnectionPrefixFilters(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.list_transit_gateway_connection_prefix_filters(
  transit_gateway_id='testString',
  id='testString',
)
prefix_filter_collection = response.get_result()

print(json.dumps(prefix_filter_collection, indent=2))

Response

Response Body

PrefixFilterCollection

prefix filters

PrefixFilterCollection

prefix filters.

PrefixFilterCollection

prefix filters.

PrefixFilterCollection

prefix filters.

PrefixFilterCollection

prefix filters.

Status Code

200
The prefix filters were retrieved successfully.
404
The specified Transit Gateway could not be found.

Example responses

Status 200

{
  "prefix_filters": [
    {
      "action": "permit",
      "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
      "created_at": "2021-11-15T12:08:05Z",
      "ge": 0,
      "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
      "le": 32,
      "prefix": "192.168.100.0/24",
      "updated_at": "2021-11-15T12:08:05Z"
    }
  ]
}

Success example

{
  "prefix_filters": [
    {
      "action": "permit",
      "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
      "created_at": "2021-11-15T12:08:05Z",
      "ge": 0,
      "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
      "le": 32,
      "prefix": "192.168.100.0/24",
      "updated_at": "2021-11-15T12:08:05Z"
    }
  ]
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Adds a prefix filter to a Transit Gateway Connection.

Add a prefix filter to a Transit Gateway Connection.

POST /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters

ServiceCall<PrefixFilterCust> createTransitGatewayConnectionPrefixFilter(CreateTransitGatewayConnectionPrefixFilterOptions createTransitGatewayConnectionPrefixFilterOptions)

createTransitGatewayConnectionPrefixFilter(params)

create_transit_gateway_connection_prefix_filter(
        self,
        transit_gateway_id: str,
        id: str,
        action: str,
        prefix: str,
        *,
        before: Optional[str] = None,
        ge: Optional[int] = None,
        le: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionPrefixFilter(createTransitGatewayConnectionPrefixFilterOptions *CreateTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, createTransitGatewayConnectionPrefixFilterOptions *CreateTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)

Request

Use the CreateTransitGatewayConnectionPrefixFilterOptions.Builder to create a CreateTransitGatewayConnectionPrefixFilterOptions object that contains the parameter values for the createTransitGatewayConnectionPrefixFilter method.

Instantiate the CreateTransitGatewayConnectionPrefixFilterOptions struct and set the fields to provide parameter values for the CreateTransitGatewayConnectionPrefixFilter method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

PrefixFilterTemplate

The prefix filters template

CreateTransitGatewayConnectionPrefixFilterOptions

The createTransitGatewayConnectionPrefixFilter options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
action
Required*
string
Whether or not this prefix filter should allow or deny prefixes matching this filter's prefix definition.

Allowable values: [permit,deny]
Examples:
value
_source
_lines
_html
prefix
Required*
string
The IPv4 Prefix to be matched by this filter. If both the le and ge are zero, then this filter will only apply to routes that exactly match this prefix, while a non-zero value for either le or ge, this filter can apply to multiple routes with different prefix lengths, but will still only apply to prefixes contained in the address space defined by prefix.

Possible values: 0 ≤ length ≤ 50, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:
value
_source
_lines
_html
before
string
A reference to the prefix filter that will be the next filter applied to the Transit Gateway connection.

If this field is blank, this prefix filter will be the last rule applied before the connection's default rule.

When a prefix filter is created with the same before field as an existing prefix filter, the existing filter will be applied before the new filter, and the existing filter's before field will be updated accordingly.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:
value
_source
_lines
_html
ge
number
Defines the minimum matched prefix precision. If this field is non-zero then the filter will match all routes within the prefix that have a prefix length greater than or equal to this value.

This value can be zero, or a non-negative number greater than or equal to the prefix length of the filter's prefix or less then or equal to 32. If this value is set to zero, the filter will not use the ge route matching behavior. If the le value is non-zero the the ge value must between the prefix length and the le value, inclusive.

Possible values: 0 ≤ value ≤ 32
Default: 0
Examples:
value
_source
_lines
_html
le
number
Defines the maximum matched prefix precision. If this field is non-zero then the filter will match all routes within the prefix that have a prefix length less than or equal to this value.

This value can be zero, or a non-negative number greater than or equal to the prefix length of the filter's prefix or less then or equal to 32. If this value is set to zero, the filter will not use the le route matching behavior. If the ge value is non-zero the the le value must between the ge value and 32, inclusive.

Possible values: 0 ≤ value ≤ 32
Default: 0
Examples:
value
_source
_lines
_html

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
action
Required*
str
Whether or not this prefix filter should allow or deny prefixes matching this filter's prefix definition.

Allowable values: [permit,deny]
Examples:
value
_source
_lines
_html
prefix
Required*
str
The IPv4 Prefix to be matched by this filter. If both the le and ge are zero, then this filter will only apply to routes that exactly match this prefix, while a non-zero value for either le or ge, this filter can apply to multiple routes with different prefix lengths, but will still only apply to prefixes contained in the address space defined by prefix.

Possible values: 0 ≤ length ≤ 50, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:
value
_source
_lines
_html
before
str
A reference to the prefix filter that will be the next filter applied to the Transit Gateway connection.

If this field is blank, this prefix filter will be the last rule applied before the connection's default rule.

When a prefix filter is created with the same before field as an existing prefix filter, the existing filter will be applied before the new filter, and the existing filter's before field will be updated accordingly.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:
value
_source
_lines
_html
ge
int
Defines the minimum matched prefix precision. If this field is non-zero then the filter will match all routes within the prefix that have a prefix length greater than or equal to this value.

This value can be zero, or a non-negative number greater than or equal to the prefix length of the filter's prefix or less then or equal to 32. If this value is set to zero, the filter will not use the ge route matching behavior. If the le value is non-zero the the ge value must between the prefix length and the le value, inclusive.

Possible values: 0 ≤ value ≤ 32
Default: 0
Examples:
value
_source
_lines
_html
le
int
Defines the maximum matched prefix precision. If this field is non-zero then the filter will match all routes within the prefix that have a prefix length less than or equal to this value.

This value can be zero, or a non-negative number greater than or equal to the prefix length of the filter's prefix or less then or equal to 32. If this value is set to zero, the filter will not use the le route matching behavior. If the ge value is non-zero the the le value must between the ge value and 32, inclusive.

Possible values: 0 ≤ value ≤ 32
Default: 0
Examples:
value
_source
_lines
_html

parameter

WithContext method only

CreateTransitGatewayConnectionPrefixFilterOptions

The CreateTransitGatewayConnectionPrefixFilter options.

Example request

createTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewCreateTransitGatewayConnectionPrefixFilterOptions(
  "testString",
  "testString",
  "permit",
  "192.168.100.0/24",
)

prefixFilterCust, response, err := transitGatewayApisService.CreateTransitGatewayConnectionPrefixFilter(createTransitGatewayConnectionPrefixFilterOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(prefixFilterCust, "", "  ")
fmt.Println(string(b))

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "action": "permit", "prefix": "192.168.100.0/24" }'   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters?version={version}"

Example request

CreateTransitGatewayConnectionPrefixFilterOptions createTransitGatewayConnectionPrefixFilterOptions = new CreateTransitGatewayConnectionPrefixFilterOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .action("permit")
  .prefix("192.168.100.0/24")
  .build();

Response<PrefixFilterCust> response = transitGatewayApisService.createTransitGatewayConnectionPrefixFilter(createTransitGatewayConnectionPrefixFilterOptions).execute();
PrefixFilterCust prefixFilterCust = response.getResult();

System.out.println(prefixFilterCust);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  action: 'permit',
  prefix: '192.168.100.0/24',
};

let res;
try {
  res = await transitGatewayApisService.createTransitGatewayConnectionPrefixFilter(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.create_transit_gateway_connection_prefix_filter(
  transit_gateway_id='testString',
  id='testString',
  action='permit',
  prefix='192.168.100.0/24',
)
prefix_filter_cust = response.get_result()

print(json.dumps(prefix_filter_cust, indent=2))

Response

Response Body

PrefixFilterCust

prefix filter

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

Status Code

201
The Transit Gateway connection prefix filters was created successfully.
400
An invalid prefix filter template was provided.
404
The specified Transit Gateway could not be found.

Example responses

Status 201

{
  "action": "permit",
  "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
  "created_at": "2021-11-15T12:08:05Z",
  "ge": 0,
  "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
  "le": 32,
  "prefix": "192.168.100.0/24",
  "updated_at": "2021-11-15T12:08:05Z"
}

Success example

{
  "action": "permit",
  "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
  "created_at": "2021-11-15T12:08:05Z",
  "ge": 0,
  "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
  "le": 32,
  "prefix": "192.168.100.0/24",
  "updated_at": "2021-11-15T12:08:05Z"
}

Status 400

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Replaces the prefix filters of the Transit Gateway Connection.

PUT /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters

ServiceCall<PrefixFilterCollection> replaceTransitGatewayConnectionPrefixFilter(ReplaceTransitGatewayConnectionPrefixFilterOptions replaceTransitGatewayConnectionPrefixFilterOptions)

replaceTransitGatewayConnectionPrefixFilter(params)

replace_transit_gateway_connection_prefix_filter(
        self,
        transit_gateway_id: str,
        id: str,
        prefix_filters: List['PrefixFilterPut'],
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) ReplaceTransitGatewayConnectionPrefixFilter(replaceTransitGatewayConnectionPrefixFilterOptions *ReplaceTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCollection, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) ReplaceTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, replaceTransitGatewayConnectionPrefixFilterOptions *ReplaceTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCollection, response *core.DetailedResponse, err error)

Request

Use the ReplaceTransitGatewayConnectionPrefixFilterOptions.Builder to create a ReplaceTransitGatewayConnectionPrefixFilterOptions object that contains the parameter values for the replaceTransitGatewayConnectionPrefixFilter method.

Instantiate the ReplaceTransitGatewayConnectionPrefixFilterOptions struct and set the fields to provide parameter values for the ReplaceTransitGatewayConnectionPrefixFilter method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

PrefixFilterPutCollection

The prefix filter list template

ReplaceTransitGatewayConnectionPrefixFilterOptions

The replaceTransitGatewayConnectionPrefixFilter options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
prefixFilters
Required*
Array of prefix filters.

Possible values: 1 ≤ number of items ≤ 10

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
prefix_filters
Required*
Array of prefix filters.

Possible values: 1 ≤ number of items ≤ 10

parameter

WithContext method only

ReplaceTransitGatewayConnectionPrefixFilterOptions

The ReplaceTransitGatewayConnectionPrefixFilter options.

Example request

prefixFilterPutModel := &transitgatewayapisv1.PrefixFilterPut{
  Action: core.StringPtr("permit"),
  Prefix: core.StringPtr("192.168.100.0/24"),
}

replaceTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewReplaceTransitGatewayConnectionPrefixFilterOptions(
  "testString",
  "testString",
  []transitgatewayapisv1.PrefixFilterPut{*prefixFilterPutModel},
)

prefixFilterCollection, response, err := transitGatewayApisService.ReplaceTransitGatewayConnectionPrefixFilter(replaceTransitGatewayConnectionPrefixFilterOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(prefixFilterCollection, "", "  ")
fmt.Println(string(b))

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "prefix_filters": [] }'   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters?version={version}"

Example request

PrefixFilterPut prefixFilterPutModel = new PrefixFilterPut.Builder()
  .action("permit")
  .prefix("192.168.100.0/24")
  .build();
ReplaceTransitGatewayConnectionPrefixFilterOptions replaceTransitGatewayConnectionPrefixFilterOptions = new ReplaceTransitGatewayConnectionPrefixFilterOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .prefixFilters(java.util.Arrays.asList(prefixFilterPutModel))
  .build();

Response<PrefixFilterCollection> response = transitGatewayApisService.replaceTransitGatewayConnectionPrefixFilter(replaceTransitGatewayConnectionPrefixFilterOptions).execute();
PrefixFilterCollection prefixFilterCollection = response.getResult();

System.out.println(prefixFilterCollection);

Example request

// Request models needed by this operation.

// PrefixFilterPut
const prefixFilterPutModel = {
  action: 'permit',
  prefix: '192.168.100.0/24',
};

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  prefixFilters: [prefixFilterPutModel],
};

let res;
try {
  res = await transitGatewayApisService.replaceTransitGatewayConnectionPrefixFilter(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

prefix_filter_put_model = {
  'action': 'permit',
  'prefix': '192.168.100.0/24',
}

response = transit_gateway_apis_service.replace_transit_gateway_connection_prefix_filter(
  transit_gateway_id='testString',
  id='testString',
  prefix_filters=[prefix_filter_put_model],
)
prefix_filter_collection = response.get_result()

print(json.dumps(prefix_filter_collection, indent=2))

Response

Response Body

PrefixFilterCollection

prefix filters

PrefixFilterCollection

prefix filters.

PrefixFilterCollection

prefix filters.

PrefixFilterCollection

prefix filters.

PrefixFilterCollection

prefix filters.

Status Code

201
The Transit Gateway connection prefix filters was replaced successfully.
400
An invalid prefix filter template was provided.
404
The specified Transit Gateway could not be found.

Example responses

Status 201

{
  "prefix_filters": [
    {
      "action": "permit",
      "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
      "created_at": "2021-11-15T12:08:05Z",
      "ge": 0,
      "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
      "le": 32,
      "prefix": "192.168.100.0/24",
      "updated_at": "2021-11-15T12:08:05Z"
    }
  ]
}

Success example

{
  "prefix_filters": [
    {
      "action": "permit",
      "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
      "created_at": "2021-11-15T12:08:05Z",
      "ge": 0,
      "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
      "le": 32,
      "prefix": "192.168.100.0/24",
      "updated_at": "2021-11-15T12:08:05Z"
    }
  ]
}

Status 400

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Delete a prefix filter.

DELETE /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}

ServiceCall<Void> deleteTransitGatewayConnectionPrefixFilter(DeleteTransitGatewayConnectionPrefixFilterOptions deleteTransitGatewayConnectionPrefixFilterOptions)

deleteTransitGatewayConnectionPrefixFilter(params)

delete_transit_gateway_connection_prefix_filter(
        self,
        transit_gateway_id: str,
        id: str,
        filter_id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnectionPrefixFilter(deleteTransitGatewayConnectionPrefixFilterOptions *DeleteTransitGatewayConnectionPrefixFilterOptions) (response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, deleteTransitGatewayConnectionPrefixFilterOptions *DeleteTransitGatewayConnectionPrefixFilterOptions) (response *core.DetailedResponse, err error)

Request

Use the DeleteTransitGatewayConnectionPrefixFilterOptions.Builder to create a DeleteTransitGatewayConnectionPrefixFilterOptions object that contains the parameter values for the deleteTransitGatewayConnectionPrefixFilter method.

Instantiate the DeleteTransitGatewayConnectionPrefixFilterOptions struct and set the fields to provide parameter values for the DeleteTransitGatewayConnectionPrefixFilter method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
filter_id
Required*
string
Prefix filter identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

DeleteTransitGatewayConnectionPrefixFilterOptions

The deleteTransitGatewayConnectionPrefixFilter options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
filterId
Required*
string
Prefix filter identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
filter_id
Required*
str
Prefix filter identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

DeleteTransitGatewayConnectionPrefixFilterOptions

The DeleteTransitGatewayConnectionPrefixFilter options.

Example request

deleteTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewDeleteTransitGatewayConnectionPrefixFilterOptions(
  "testString",
  "testString",
  "testString",
)

response, err := transitGatewayApisService.DeleteTransitGatewayConnectionPrefixFilter(deleteTransitGatewayConnectionPrefixFilterOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteTransitGatewayConnectionPrefixFilter(): %d\n", response.StatusCode)
}

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}?version={version}"

Example request

DeleteTransitGatewayConnectionPrefixFilterOptions deleteTransitGatewayConnectionPrefixFilterOptions = new DeleteTransitGatewayConnectionPrefixFilterOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .filterId("testString")
  .build();

Response<Void> response = transitGatewayApisService.deleteTransitGatewayConnectionPrefixFilter(deleteTransitGatewayConnectionPrefixFilterOptions).execute();

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  filterId: 'testString',
};

try {
  await transitGatewayApisService.deleteTransitGatewayConnectionPrefixFilter(params);
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.delete_transit_gateway_connection_prefix_filter(
  transit_gateway_id='testString',
  id='testString',
  filter_id='testString',
)

Response

Status Code

204
Prefix filter deleted successfully.
404
A Prefix Filter with the specified identifier could not be found.

Example responses

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Prefix Filter",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Prefix Filter",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

This request retrieves a prefix filter from the Transit Gateway Connection.

GET /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}

ServiceCall<PrefixFilterCust> getTransitGatewayConnectionPrefixFilter(GetTransitGatewayConnectionPrefixFilterOptions getTransitGatewayConnectionPrefixFilterOptions)

getTransitGatewayConnectionPrefixFilter(params)

get_transit_gateway_connection_prefix_filter(
        self,
        transit_gateway_id: str,
        id: str,
        filter_id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnectionPrefixFilter(getTransitGatewayConnectionPrefixFilterOptions *GetTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, getTransitGatewayConnectionPrefixFilterOptions *GetTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)

Request

Use the GetTransitGatewayConnectionPrefixFilterOptions.Builder to create a GetTransitGatewayConnectionPrefixFilterOptions object that contains the parameter values for the getTransitGatewayConnectionPrefixFilter method.

Instantiate the GetTransitGatewayConnectionPrefixFilterOptions struct and set the fields to provide parameter values for the GetTransitGatewayConnectionPrefixFilter method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
filter_id
Required*
string
Prefix filter identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

GetTransitGatewayConnectionPrefixFilterOptions

The getTransitGatewayConnectionPrefixFilter options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
filterId
Required*
string
Prefix filter identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
filter_id
Required*
str
Prefix filter identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

GetTransitGatewayConnectionPrefixFilterOptions

The GetTransitGatewayConnectionPrefixFilter options.

Example request

getTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewGetTransitGatewayConnectionPrefixFilterOptions(
  "testString",
  "testString",
  "testString",
)

prefixFilterCust, response, err := transitGatewayApisService.GetTransitGatewayConnectionPrefixFilter(getTransitGatewayConnectionPrefixFilterOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(prefixFilterCust, "", "  ")
fmt.Println(string(b))

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}?version={version}"

Example request

GetTransitGatewayConnectionPrefixFilterOptions getTransitGatewayConnectionPrefixFilterOptions = new GetTransitGatewayConnectionPrefixFilterOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .filterId("testString")
  .build();

Response<PrefixFilterCust> response = transitGatewayApisService.getTransitGatewayConnectionPrefixFilter(getTransitGatewayConnectionPrefixFilterOptions).execute();
PrefixFilterCust prefixFilterCust = response.getResult();

System.out.println(prefixFilterCust);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  filterId: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.getTransitGatewayConnectionPrefixFilter(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.get_transit_gateway_connection_prefix_filter(
  transit_gateway_id='testString',
  id='testString',
  filter_id='testString',
)
prefix_filter_cust = response.get_result()

print(json.dumps(prefix_filter_cust, indent=2))

Response

Response Body

PrefixFilterCust

prefix filter

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

Status Code

200
The prefix filter was retrieved successfully.
404
A prefix filter with the specified identifier could not be found.

Example responses

Status 200

{
  "action": "permit",
  "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
  "created_at": "2021-11-15T12:08:05Z",
  "ge": 0,
  "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
  "le": 32,
  "prefix": "192.168.100.0/24",
  "updated_at": "2021-11-15T12:08:05Z"
}

Success example

{
  "action": "permit",
  "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
  "created_at": "2021-11-15T12:08:05Z",
  "ge": 0,
  "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
  "le": 32,
  "prefix": "192.168.100.0/24",
  "updated_at": "2021-11-15T12:08:05Z"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Prefix Filter",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Prefix Filter",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Update prefix filter for a Transit Gateway Connection.

PATCH /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}

ServiceCall<PrefixFilterCust> updateTransitGatewayConnectionPrefixFilter(UpdateTransitGatewayConnectionPrefixFilterOptions updateTransitGatewayConnectionPrefixFilterOptions)

updateTransitGatewayConnectionPrefixFilter(params)

update_transit_gateway_connection_prefix_filter(
        self,
        transit_gateway_id: str,
        id: str,
        filter_id: str,
        *,
        action: Optional[str] = None,
        before: Optional[str] = None,
        ge: Optional[int] = None,
        le: Optional[int] = None,
        prefix: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnectionPrefixFilter(updateTransitGatewayConnectionPrefixFilterOptions *UpdateTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, updateTransitGatewayConnectionPrefixFilterOptions *UpdateTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)

Request

Use the UpdateTransitGatewayConnectionPrefixFilterOptions.Builder to create a UpdateTransitGatewayConnectionPrefixFilterOptions object that contains the parameter values for the updateTransitGatewayConnectionPrefixFilter method.

Instantiate the UpdateTransitGatewayConnectionPrefixFilterOptions struct and set the fields to provide parameter values for the UpdateTransitGatewayConnectionPrefixFilter method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
The connection identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
filter_id
Required*
string
Prefix filter identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Request Body

Required*

PrefixFilterPatch

The prefix filter patch template

UpdateTransitGatewayConnectionPrefixFilterOptions

The updateTransitGatewayConnectionPrefixFilter options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
filterId
Required*
string
Prefix filter identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
action
string
Whether or not this prefix filter should allow or deny prefixes matching this filter's prefix definition.

Allowable values: [permit,deny]
Examples:
value
_source
_lines
_html
before
string
A reference to the prefix filter that will be the next filter applied to the Transit Gateway connection.

If this field is blank, this prefix filter will be the last rule applied before the connection's default rule.

When a prefix filter is created with the same before field as an existing prefix filter, the existing filter will be applied before the new filter, and the existing filter's before field will be updated accordingly.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:
value
_source
_lines
_html
ge
number
Defines the minimum matched prefix precision. If this field is non-zero then the filter will match all routes within the prefix that have a prefix length greater or equal to this value.

This value can be zero, or a non-negative number greater than or equal to the prefix length of the filter's prefix or less then or equal to 32. If this value is set to zero, the filter will not use the ge route matching behavior. If the le value is non-zero the the ge value must between the prefix length and the le value, inclusive.

Examples:
value
_source
_lines
_html
le
number
Defines the maximum matched prefix precision. If this field is non-zero then the filter will match all routes within the prefix that have a prefix length less than or equal to this value.

This value can be zero, or a non-negative number greater than or equal to the prefix length of the filter's prefix or less then or equal to 32. If this value is set to zero, the filter will not use the le route matching behavior. If the ge value is non-zero the the le value must between the ge value and 32, inclusive.

Possible values: 0 ≤ value ≤ 32
Default: 0
Examples:
value
_source
_lines
_html
prefix
string
The IPv4 Prefix to be matched by this filter.

Possible values: 0 ≤ length ≤ 50, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:
value
_source
_lines
_html

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
The connection identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
filter_id
Required*
str
Prefix filter identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
action
str
Whether or not this prefix filter should allow or deny prefixes matching this filter's prefix definition.

Allowable values: [permit,deny]
Examples:
value
_source
_lines
_html
before
str
A reference to the prefix filter that will be the next filter applied to the Transit Gateway connection.

If this field is blank, this prefix filter will be the last rule applied before the connection's default rule.

When a prefix filter is created with the same before field as an existing prefix filter, the existing filter will be applied before the new filter, and the existing filter's before field will be updated accordingly.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:
value
_source
_lines
_html
ge
int
Defines the minimum matched prefix precision. If this field is non-zero then the filter will match all routes within the prefix that have a prefix length greater or equal to this value.

This value can be zero, or a non-negative number greater than or equal to the prefix length of the filter's prefix or less then or equal to 32. If this value is set to zero, the filter will not use the ge route matching behavior. If the le value is non-zero the the ge value must between the prefix length and the le value, inclusive.

Examples:
value
_source
_lines
_html
le
int
Defines the maximum matched prefix precision. If this field is non-zero then the filter will match all routes within the prefix that have a prefix length less than or equal to this value.

This value can be zero, or a non-negative number greater than or equal to the prefix length of the filter's prefix or less then or equal to 32. If this value is set to zero, the filter will not use the le route matching behavior. If the ge value is non-zero the the le value must between the ge value and 32, inclusive.

Possible values: 0 ≤ value ≤ 32
Default: 0
Examples:
value
_source
_lines
_html
prefix
str
The IPv4 Prefix to be matched by this filter.

Possible values: 0 ≤ length ≤ 50, Value must match regular expression /^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:
value
_source
_lines
_html

parameter

WithContext method only

UpdateTransitGatewayConnectionPrefixFilterOptions

The UpdateTransitGatewayConnectionPrefixFilter options.

Example request

updateTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewUpdateTransitGatewayConnectionPrefixFilterOptions(
  "testString",
  "testString",
  "testString",
)

prefixFilterCust, response, err := transitGatewayApisService.UpdateTransitGatewayConnectionPrefixFilter(updateTransitGatewayConnectionPrefixFilterOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(prefixFilterCust, "", "  ")
fmt.Println(string(b))

Example request

curl -X PATCH --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{}'   "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}?version={version}"

Example request

UpdateTransitGatewayConnectionPrefixFilterOptions updateTransitGatewayConnectionPrefixFilterOptions = new UpdateTransitGatewayConnectionPrefixFilterOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .filterId("testString")
  .build();

Response<PrefixFilterCust> response = transitGatewayApisService.updateTransitGatewayConnectionPrefixFilter(updateTransitGatewayConnectionPrefixFilterOptions).execute();
PrefixFilterCust prefixFilterCust = response.getResult();

System.out.println(prefixFilterCust);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
  filterId: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.updateTransitGatewayConnectionPrefixFilter(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.update_transit_gateway_connection_prefix_filter(
  transit_gateway_id='testString',
  id='testString',
  filter_id='testString',
)
prefix_filter_cust = response.get_result()

print(json.dumps(prefix_filter_cust, indent=2))

Response

Response Body

PrefixFilterCust

prefix filter

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

PrefixFilterCust

prefix filter.

Status Code

200
The prefix was updated successfully.
400
The prefix filter update template was invalid.
404
A prefix filter with the specified identifier could not be found.

Example responses

Status 200

{
  "action": "deny",
  "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
  "created_at": "2021-11-15T12:08:05Z",
  "ge": 0,
  "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
  "le": 32,
  "prefix": "192.168.100.0/24",
  "updated_at": "2021-11-16T12:08:05Z"
}

Success example

{
  "action": "deny",
  "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782",
  "created_at": "2021-11-15T12:08:05Z",
  "ge": 0,
  "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865",
  "le": 32,
  "prefix": "192.168.100.0/24",
  "updated_at": "2021-11-16T12:08:05Z"
}

Status 400

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "bad_request",
      "message": "The information given was invalid, malformed, or missing a required field.",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling",
      "target": {
        "name": "request_body",
        "type": "field"
      }
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Prefix Filter",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Prefix Filter",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Retrieve all route reports for the specified Transit Gateway. There will normally be at most one completed report and one pending report. Additionally, completed route reports are written to IBM Cloud Activity Tracker.

GET /transit_gateways/{transit_gateway_id}/route_reports

ServiceCall<RouteReportCollection> listTransitGatewayRouteReports(ListTransitGatewayRouteReportsOptions listTransitGatewayRouteReportsOptions)

listTransitGatewayRouteReports(params)

list_transit_gateway_route_reports(
        self,
        transit_gateway_id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayRouteReports(listTransitGatewayRouteReportsOptions *ListTransitGatewayRouteReportsOptions) (result *RouteReportCollection, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayRouteReportsWithContext(ctx context.Context, listTransitGatewayRouteReportsOptions *ListTransitGatewayRouteReportsOptions) (result *RouteReportCollection, response *core.DetailedResponse, err error)

Request

Use the ListTransitGatewayRouteReportsOptions.Builder to create a ListTransitGatewayRouteReportsOptions object that contains the parameter values for the listTransitGatewayRouteReports method.

Instantiate the ListTransitGatewayRouteReportsOptions struct and set the fields to provide parameter values for the ListTransitGatewayRouteReports method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

ListTransitGatewayRouteReportsOptions

The listTransitGatewayRouteReports options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

ListTransitGatewayRouteReportsOptions

The ListTransitGatewayRouteReports options.

Example request

listTransitGatewayRouteReportsOptions := transitGatewayApisService.NewListTransitGatewayRouteReportsOptions(
  "testString",
)

routeReportCollection, response, err := transitGatewayApisService.ListTransitGatewayRouteReports(listTransitGatewayRouteReportsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(routeReportCollection, "", "  ")
fmt.Println(string(b))

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/route_reports?version={version}"

Example request

ListTransitGatewayRouteReportsOptions listTransitGatewayRouteReportsOptions = new ListTransitGatewayRouteReportsOptions.Builder()
  .transitGatewayId("testString")
  .build();

Response<RouteReportCollection> response = transitGatewayApisService.listTransitGatewayRouteReports(listTransitGatewayRouteReportsOptions).execute();
RouteReportCollection routeReportCollection = response.getResult();

System.out.println(routeReportCollection);

Example request

const params = {
  transitGatewayId: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.listTransitGatewayRouteReports(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.list_transit_gateway_route_reports(
  transit_gateway_id='testString',
)
route_report_collection = response.get_result()

print(json.dumps(route_report_collection, indent=2))

Response

Response Body

RouteReportCollection

route reports

RouteReportCollection

route reports.

RouteReportCollection

route reports.

RouteReportCollection

route reports.

RouteReportCollection

route reports.

Status Code

200
Reports retrieved successfully.
404
The specified Transit Gateway could not be found.

Example responses

Status 200

{
  "route_reports": [
    {
      "connections": [
        {
          "bgps": [
            {
              "as_path": "(65201 4201065544) 4203065544",
              "is_used": true,
              "local_preference": "190",
              "prefix": "172.17.0.0/16"
            }
          ],
          "id": "3c265a62-91da-4261-a950-950b6af0eb58",
          "name": "transit-connection-vpc1",
          "routes": [
            {
              "prefix": "172.17.0.0/16"
            }
          ],
          "type": "vpc"
        },
        {
          "bgps": [
            {
              "as_path": "(65201 4201065544) 4203065545",
              "is_used": true,
              "local_preference": "190",
              "prefix": "172.17.0.0/16"
            }
          ],
          "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
          "name": "transit-connection-vpc2",
          "routes": [
            {
              "prefix": "172.17.0.0/16"
            }
          ],
          "type": "vpc"
        }
      ],
      "created_at": "2020-03-31T12:08:05Z",
      "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
      "overlapping_routes": [
        {
          "routes": [
            {
              "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58",
              "prefix": "172.17.0.0/16"
            },
            {
              "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
              "prefix": "172.17.0.0/16"
            }
          ]
        }
      ],
      "status": "complete"
    }
  ]
}

Success example

{
  "route_reports": [
    {
      "connections": [
        {
          "bgps": [
            {
              "as_path": "(65201 4201065544) 4203065544",
              "is_used": true,
              "local_preference": "190",
              "prefix": "172.17.0.0/16"
            }
          ],
          "id": "3c265a62-91da-4261-a950-950b6af0eb58",
          "name": "transit-connection-vpc1",
          "routes": [
            {
              "prefix": "172.17.0.0/16"
            }
          ],
          "type": "vpc"
        },
        {
          "bgps": [
            {
              "as_path": "(65201 4201065544) 4203065545",
              "is_used": true,
              "local_preference": "190",
              "prefix": "172.17.0.0/16"
            }
          ],
          "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
          "name": "transit-connection-vpc2",
          "routes": [
            {
              "prefix": "172.17.0.0/16"
            }
          ],
          "type": "vpc"
        }
      ],
      "created_at": "2020-03-31T12:08:05Z",
      "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
      "overlapping_routes": [
        {
          "routes": [
            {
              "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58",
              "prefix": "172.17.0.0/16"
            },
            {
              "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
              "prefix": "172.17.0.0/16"
            }
          ]
        }
      ],
      "status": "complete"
    }
  ]
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Request route report generation. While report generation is in progress, additional requests to generate a report are ignored and return the current pending report.

POST /transit_gateways/{transit_gateway_id}/route_reports

ServiceCall<RouteReport> createTransitGatewayRouteReport(CreateTransitGatewayRouteReportOptions createTransitGatewayRouteReportOptions)

createTransitGatewayRouteReport(params)

create_transit_gateway_route_report(
        self,
        transit_gateway_id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayRouteReport(createTransitGatewayRouteReportOptions *CreateTransitGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayRouteReportWithContext(ctx context.Context, createTransitGatewayRouteReportOptions *CreateTransitGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)

Request

Use the CreateTransitGatewayRouteReportOptions.Builder to create a CreateTransitGatewayRouteReportOptions object that contains the parameter values for the createTransitGatewayRouteReport method.

Instantiate the CreateTransitGatewayRouteReportOptions struct and set the fields to provide parameter values for the CreateTransitGatewayRouteReport method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

CreateTransitGatewayRouteReportOptions

The createTransitGatewayRouteReport options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

CreateTransitGatewayRouteReportOptions

The CreateTransitGatewayRouteReport options.

Example request

createTransitGatewayRouteReportOptions := transitGatewayApisService.NewCreateTransitGatewayRouteReportOptions(
  "testString",
)

routeReport, response, err := transitGatewayApisService.CreateTransitGatewayRouteReport(createTransitGatewayRouteReportOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(routeReport, "", "  ")
fmt.Println(string(b))

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/route_reports?version={version}"

Example request

CreateTransitGatewayRouteReportOptions createTransitGatewayRouteReportOptions = new CreateTransitGatewayRouteReportOptions.Builder()
  .transitGatewayId("testString")
  .build();

Response<RouteReport> response = transitGatewayApisService.createTransitGatewayRouteReport(createTransitGatewayRouteReportOptions).execute();
RouteReport routeReport = response.getResult();

System.out.println(routeReport);

Example request

const params = {
  transitGatewayId: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.createTransitGatewayRouteReport(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.create_transit_gateway_route_report(
  transit_gateway_id='testString',
)
route_report = response.get_result()

print(json.dumps(route_report, indent=2))

Response

Response Body

RouteReport

route report

RouteReport

route report.

RouteReport

route report.

RouteReport

route report.

RouteReport

route report.

Status Code

202
Route report request successful. If not already in progress, report generation has begun.
404
The specified Transit Gateway could not be found.

Example responses

Status 202

{
  "connections": [
    {
      "bgps": [
        {
          "as_path": "(65201 4201065544) 4203065544",
          "is_used": true,
          "local_preference": "190",
          "prefix": "172.17.0.0/16"
        }
      ],
      "id": "3c265a62-91da-4261-a950-950b6af0eb58",
      "name": "transit-connection-vpc1",
      "routes": [
        {
          "prefix": "172.17.0.0/16"
        }
      ],
      "type": "vpc"
    },
    {
      "bgps": [
        {
          "as_path": "(65201 4201065544) 4203065545",
          "is_used": true,
          "local_preference": "190",
          "prefix": "172.17.0.0/16"
        }
      ],
      "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
      "name": "transit-connection-vpc2",
      "routes": [
        {
          "prefix": "172.17.0.0/16"
        }
      ],
      "type": "vpc"
    }
  ],
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "overlapping_routes": [
    {
      "routes": [
        {
          "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58",
          "prefix": "172.17.0.0/16"
        },
        {
          "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
          "prefix": "172.17.0.0/16"
        }
      ]
    }
  ],
  "status": "complete"
}

Success example

{
  "connections": [
    {
      "bgps": [
        {
          "as_path": "(65201 4201065544) 4203065544",
          "is_used": true,
          "local_preference": "190",
          "prefix": "172.17.0.0/16"
        }
      ],
      "id": "3c265a62-91da-4261-a950-950b6af0eb58",
      "name": "transit-connection-vpc1",
      "routes": [
        {
          "prefix": "172.17.0.0/16"
        }
      ],
      "type": "vpc"
    },
    {
      "bgps": [
        {
          "as_path": "(65201 4201065544) 4203065545",
          "is_used": true,
          "local_preference": "190",
          "prefix": "172.17.0.0/16"
        }
      ],
      "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
      "name": "transit-connection-vpc2",
      "routes": [
        {
          "prefix": "172.17.0.0/16"
        }
      ],
      "type": "vpc"
    }
  ],
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "overlapping_routes": [
    {
      "routes": [
        {
          "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58",
          "prefix": "172.17.0.0/16"
        },
        {
          "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
          "prefix": "172.17.0.0/16"
        }
      ]
    }
  ],
  "status": "complete"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Cannot find Gateway",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Delete a route report.

DELETE /transit_gateways/{transit_gateway_id}/route_reports/{id}

ServiceCall<Void> deleteTransitGatewayRouteReport(DeleteTransitGatewayRouteReportOptions deleteTransitGatewayRouteReportOptions)

deleteTransitGatewayRouteReport(params)

delete_transit_gateway_route_report(
        self,
        transit_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayRouteReport(deleteTransitGatewayRouteReportOptions *DeleteTransitGatewayRouteReportOptions) (response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayRouteReportWithContext(ctx context.Context, deleteTransitGatewayRouteReportOptions *DeleteTransitGatewayRouteReportOptions) (response *core.DetailedResponse, err error)

Request

Use the DeleteTransitGatewayRouteReportOptions.Builder to create a DeleteTransitGatewayRouteReportOptions object that contains the parameter values for the deleteTransitGatewayRouteReport method.

Instantiate the DeleteTransitGatewayRouteReportOptions struct and set the fields to provide parameter values for the DeleteTransitGatewayRouteReport method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
Route report identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

DeleteTransitGatewayRouteReportOptions

The deleteTransitGatewayRouteReport options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
Route report identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
Route report identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

DeleteTransitGatewayRouteReportOptions

The DeleteTransitGatewayRouteReport options.

Example request

deleteTransitGatewayRouteReportOptions := transitGatewayApisService.NewDeleteTransitGatewayRouteReportOptions(
  "testString",
  "testString",
)

response, err := transitGatewayApisService.DeleteTransitGatewayRouteReport(deleteTransitGatewayRouteReportOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteTransitGatewayRouteReport(): %d\n", response.StatusCode)
}

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/transit_gateways/{transit_gateway_id}/route_reports/{id}?version={version}"

Example request

DeleteTransitGatewayRouteReportOptions deleteTransitGatewayRouteReportOptions = new DeleteTransitGatewayRouteReportOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .build();

Response<Void> response = transitGatewayApisService.deleteTransitGatewayRouteReport(deleteTransitGatewayRouteReportOptions).execute();

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
};

try {
  await transitGatewayApisService.deleteTransitGatewayRouteReport(params);
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.delete_transit_gateway_route_report(
  transit_gateway_id='testString',
  id='testString',
)

Response

Status Code

204
Route report deleted successfully.
404
A Transit Gateway or route report with the specified identifier could not be found.

Example responses

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Route report not found",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Route report not found",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Retrieve a route report.

GET /transit_gateways/{transit_gateway_id}/route_reports/{id}

ServiceCall<RouteReport> getTransitGatewayRouteReport(GetTransitGatewayRouteReportOptions getTransitGatewayRouteReportOptions)

getTransitGatewayRouteReport(params)

get_transit_gateway_route_report(
        self,
        transit_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayRouteReport(getTransitGatewayRouteReportOptions *GetTransitGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)

(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayRouteReportWithContext(ctx context.Context, getTransitGatewayRouteReportOptions *GetTransitGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)

Request

Use the GetTransitGatewayRouteReportOptions.Builder to create a GetTransitGatewayRouteReportOptions object that contains the parameter values for the getTransitGatewayRouteReport method.

Instantiate the GetTransitGatewayRouteReportOptions struct and set the fields to provide parameter values for the GetTransitGatewayRouteReport method.

Path Parameters

transit_gateway_id
Required*
string
The Transit Gateway identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
id
Required*
string
Route report identifier

Possible values: 0 ≤ length ≤ 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

version
Required*
string
Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version.

Possible values: length = 10, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

GetTransitGatewayRouteReportOptions

The getTransitGatewayRouteReport options.

parameters

transitGatewayId
Required*
string
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
string
Route report identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameters

transit_gateway_id
Required*
str
The Transit Gateway identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
id
Required*
str
Route report identifier.

Possible values: 0 ≤ length ≤ 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

parameter

WithContext method only

GetTransitGatewayRouteReportOptions

The GetTransitGatewayRouteReport options.

Example request

getTransitGatewayRouteReportOptions := transitGatewayApisService.NewGetTransitGatewayRouteReportOptions(
  "testString",
  "testString",
)

routeReport, response, err := transitGatewayApisService.GetTransitGatewayRouteReport(getTransitGatewayRouteReportOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(routeReport, "", "  ")
fmt.Println(string(b))

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/transit_gateways/{transit_gateway_id}/route_reports/{id}?version={version}"

Example request

GetTransitGatewayRouteReportOptions getTransitGatewayRouteReportOptions = new GetTransitGatewayRouteReportOptions.Builder()
  .transitGatewayId("testString")
  .id("testString")
  .build();

Response<RouteReport> response = transitGatewayApisService.getTransitGatewayRouteReport(getTransitGatewayRouteReportOptions).execute();
RouteReport routeReport = response.getResult();

System.out.println(routeReport);

Example request

const params = {
  transitGatewayId: 'testString',
  id: 'testString',
};

let res;
try {
  res = await transitGatewayApisService.getTransitGatewayRouteReport(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

response = transit_gateway_apis_service.get_transit_gateway_route_report(
  transit_gateway_id='testString',
  id='testString',
)
route_report = response.get_result()

print(json.dumps(route_report, indent=2))

Response

Response Body

RouteReport

route report

RouteReport

route report.

RouteReport

route report.

RouteReport

route report.

RouteReport

route report.

Status Code

200
Route report retrieved successfully.
404
A route report or gateway with the specified identifier(s) could not be found.

Example responses

Status 200

{
  "connections": [
    {
      "bgps": [
        {
          "as_path": "(65201 4201065544) 4203065544",
          "is_used": true,
          "local_preference": "190",
          "prefix": "172.17.0.0/16"
        }
      ],
      "id": "3c265a62-91da-4261-a950-950b6af0eb58",
      "name": "transit-connection-vpc1",
      "routes": [
        {
          "prefix": "172.17.0.0/16"
        }
      ],
      "type": "vpc"
    },
    {
      "bgps": [
        {
          "as_path": "(65201 4201065544) 4203065545",
          "is_used": true,
          "local_preference": "190",
          "prefix": "172.17.0.0/16"
        }
      ],
      "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
      "name": "transit-connection-vpc2",
      "routes": [
        {
          "prefix": "172.17.0.0/16"
        }
      ],
      "type": "vpc"
    }
  ],
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "overlapping_routes": [
    {
      "routes": [
        {
          "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58",
          "prefix": "172.17.0.0/16"
        },
        {
          "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
          "prefix": "172.17.0.0/16"
        }
      ]
    }
  ],
  "status": "complete"
}

Success example

{
  "connections": [
    {
      "bgps": [
        {
          "as_path": "(65201 4201065544) 4203065544",
          "is_used": true,
          "local_preference": "190",
          "prefix": "172.17.0.0/16"
        }
      ],
      "id": "3c265a62-91da-4261-a950-950b6af0eb58",
      "name": "transit-connection-vpc1",
      "routes": [
        {
          "prefix": "172.17.0.0/16"
        }
      ],
      "type": "vpc"
    },
    {
      "bgps": [
        {
          "as_path": "(65201 4201065544) 4203065545",
          "is_used": true,
          "local_preference": "190",
          "prefix": "172.17.0.0/16"
        }
      ],
      "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
      "name": "transit-connection-vpc2",
      "routes": [
        {
          "prefix": "172.17.0.0/16"
        }
      ],
      "type": "vpc"
    }
  ],
  "created_at": "2020-03-31T12:08:05Z",
  "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531",
  "overlapping_routes": [
    {
      "routes": [
        {
          "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58",
          "prefix": "172.17.0.0/16"
        },
        {
          "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff",
          "prefix": "172.17.0.0/16"
        }
      ]
    }
  ],
  "status": "complete"
}

Status 404

{
  "errors": [
    {
      "code": "not_found",
      "message": "Route report not found",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Error example

{
  "errors": [
    {
      "code": "not_found",
      "message": "Route report not found",
      "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling"
    }
  ],
  "trace": "86780a34-e651-4b47-9fb0-184a169cc9af"
}

Introduction

Authentication

Authorization

API Endpoint

Versioning

Pagination

Best practices

Error handling

Auditing

Methods

Retrieves all Transit Gateways

Request

Query Parameters

version

limit

start

ListTransitGatewaysOptions

limit

start

parameters

limit

start

parameters

limit

start

parameter

ctx

ListTransitGatewaysOptions

Limit

Start

Response

Response Body

first

limit

transit_gateways

next

TransitGatewayCollection

first

href

limit

next

href

start

transitGateways

id

crn

name

location

createdAt

global

resourceGroup

href

id

status

updatedAt

TransitGatewayCollection

first

href

limit

next

href

start

transit_gateways

id

crn

name

location

created_at

global

resource_group

href

id

status

updated_at

TransitGatewayCollection

first

href

limit

next

href