IBM Cloud API Docs

Introduction

Last updated: 2025-11-04

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.

Methods

Retrieves all Transit Gateways

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

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

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

List 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.

  • curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/transit_gateways?version=${version}"
  • 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))
  • 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));
  • 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);
}
  • 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
  • {
  "first": {
    "href": "https://transit.cloud.ibm.com/v1/transit_gateways?limit=50"
  },
  "limit": 50,
  "transit_gateways": [
    {
      "connection_needs_attention": false,
      "created_at": "2020-03-31T12:08:05Z",
      "crn": "crn:[...]",
      "global": true,
      "gre_enhanced_route_propagation": false,
      "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"
    }
  ]
}
  • {
  "first": {
    "href": "https://transit.cloud.ibm.com/v1/transit_gateways?limit=50"
  },
  "limit": 50,
  "transit_gateways": [
    {
      "connection_needs_attention": false,
      "created_at": "2020-03-31T12:08:05Z",
      "crn": "crn:[...]",
      "global": true,
      "gre_enhanced_route_propagation": false,
      "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"
    }
  ]
}

Creates a Transit Gateway

Create a Transit Gateway based on the supplied input template.

Create a Transit Gateway based on the supplied input template.

Create a Transit Gateway based on the supplied input template.

Create a Transit Gateway based on the supplied input template.

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,
        gre_enhanced_route_propagation: 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: 
  • name
    Required*
    string
    A human readable name for the 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:  
  • global
    boolean
    Allow global routing for a Transit Gateway. If unspecified, the default value is false.
    

    Default: false
    Examples:  
  • greEnhancedRoutePropagation
    boolean
    Allow route propagation across all GREs connected to the same transit gateway. This affects connections on the gateway of type redundant_gre, unbound_gre_tunnel and gre_tunnel.
    

    Default: false
    Examples:  
  • 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:  
  • name
    Required*
    str
    A human readable name for the 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:  
  • global_
    bool
    Allow global routing for a Transit Gateway. If unspecified, the default value is false.
    

    Default: false
    Examples:  
  • gre_enhanced_route_propagation
    bool
    Allow route propagation across all GREs connected to the same transit gateway. This affects connections on the gateway of type redundant_gre, unbound_gre_tunnel and gre_tunnel.
    

    Default: false
    Examples:  
  • 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.


  • curl -X POST --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "location": "us-south", "name": "my-transit-gateway-in-TransitGateway" }'   "${base_url}/transit_gateways?version=${version}"
  • createTransitGatewayOptions := transitGatewayApisService.NewCreateTransitGatewayOptions(
  "us-south",
  "my-transit-gateway-in-TransitGateway",
)

transitGateway, response, err := transitGatewayApisService.CreateTransitGateway(createTransitGatewayOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(transitGateway, "", "  ")
fmt.Println(string(b))
  • CreateTransitGatewayOptions createTransitGatewayOptions = new CreateTransitGatewayOptions.Builder()
  .location("us-south")
  .name("my-transit-gateway-in-TransitGateway")
  .build();

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

System.out.println(transitGateway);
  • const params = {
  location: 'us-south',
  name: 'my-transit-gateway-in-TransitGateway',
};

let res;
try {
  res = await transitGatewayApisService.createTransitGateway(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = transit_gateway_apis_service.create_transit_gateway(
  location='us-south',
  name='my-transit-gateway-in-TransitGateway',
)
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
  • {
  "connection_needs_attention": false,
  "created_at": "2020-03-31T12:08:05Z",
  "crn": "crn:[...]",
  "global": true,
  "gre_enhanced_route_propagation": false,
  "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"
}
  • {
  "connection_needs_attention": false,
  "created_at": "2020-03-31T12:08:05Z",
  "crn": "crn:[...]",
  "global": true,
  "gre_enhanced_route_propagation": false,
  "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"
}
  • {
  "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"
}
  • {
  "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"
}
  • {
  "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"
}
  • {
  "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"
}
  • {
  "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"
}
  • {
  "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"
}
Deletes specified Transit Gateway
This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.


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


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


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


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.


  • curl -X DELETE --location --header "Authorization: Bearer ${iam_token}"   "${base_url}/transit_gateways/${id}?version=${version}"
  • 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)
}
  • DeleteTransitGatewayOptions deleteTransitGatewayOptions = new DeleteTransitGatewayOptions.Builder()
  .id("testString")
  .build();

Response<Void> response = transitGatewayApisService.deleteTransitGateway(deleteTransitGatewayOptions).execute();
  • const params = {
  id: 'testString',
};

try {
  await transitGatewayApisService.deleteTransitGateway(params);
} catch (err) {
  console.warn(err);
}
  • 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
  • {
  "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"
}
  • {
  "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"
}
  • {
  "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"
}
  • {
  "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"
}
Retrieves specified Transit Gateway
This request retrieves a single Transit Gateway specified by the identifier in the URL.


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


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


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


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.


  • curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/transit_gateways/${id}?version=${version}"
  • getTransitGatewayOptions := transitGatewayApisService.NewGetTransitGatewayOptions(
  "testString",
)

transitGateway, response, err := transitGatewayApisService.GetTransitGateway(getTransitGatewayOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(transitGateway, "", "  ")
fmt.Println(string(b))
  • GetTransitGatewayOptions getTransitGatewayOptions = new GetTransitGatewayOptions.Builder()
  .id("testString")
  .build();

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

System.out.println(transitGateway);
  • 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);
}
  • 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.