Static Route

This page describes operations you can perform on static_routes. List, create, get details for, update, and delete.

List Static Route

List all visible static_routes.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/static_routes

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
aws_gw_id query string hyph-uuid-or-empty - AWS Gateway on which this static route will be set no
azure_gw_id query string hyph-uuid-or-empty - Azure Gateway on which this static route will be set no
description query string - - Description of the Static Route resource no
destination query string cidr-or-ipv4 - CIDR this static route points to no
fic_gw_id query string hyph-uuid-or-empty - FIC Gateway on which this static route will be set no
gcp_gw_id query string hyph-uuid-or-empty - GCP Gateway on which this static route will be set no
id query string hyph-uuid - Unique ID of the Static Route resource no
interdc_gw_id query string hyph-uuid-or-empty - Inter DC Gateway on which this static route will be set no
internet_gw_id query string hyph-uuid-or-empty - Internet Gateway on which this static route will be set no
name query string - - Name of the Static Route resource no
nexthop query string ipv4 - Next Hop address for specified CIDR no
service_type query string - [‘aws’, ‘azure’, ‘fic’, ‘gcp’, ‘vpn’, ‘internet’, ‘interdc’] Service type for this route no
status query string - - Static Route status. no
tenant_id query string non-hyph-uuid - Tenant ID of the owner (UUID) no
vpn_gw_id query string hyph-uuid-or-empty - VPN Gateway on which this static route will be set no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
static_routes array<object> Static Route -
aws_gw_id string hyph-uuid-or-empty AWS Gateway on which this static route will be set
azure_gw_id string hyph-uuid-or-empty Azure Gateway on which this static route will be set
description string - Description of the Static Route resource
destination string cidr-or-ipv4 CIDR this static route points to
fic_gw_id string hyph-uuid-or-empty FIC Gateway on which this static route will be set
gcp_gw_id string hyph-uuid-or-empty GCP Gateway on which this static route will be set
id string hyph-uuid Unique ID of the Static Route resource
interdc_gw_id string hyph-uuid-or-empty Inter DC Gateway on which this static route will be set
internet_gw_id string hyph-uuid-or-empty Internet Gateway on which this static route will be set
name string - Name of the Static Route resource
nexthop string ipv4 Next Hop address for specified CIDR
service_type string - Service type for this route
status string - Static Route status.
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)
vpn_gw_id string hyph-uuid-or-empty VPN Gateway on which this static route will be set

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "static_routes": [
    {
      "aws_gw_id": null,
      "azure_gw_id": null,
      "description": "SRT2",
      "destination": "100.127.254.116/30",
      "fic_gw_id": null,
      "gcp_gw_id": "5af4f343-91a7-4956-aabb-9ac678d215e5",
      "id": "cd1dacf1-0838-4ffc-bbb8-54d3152b9a5a",
      "interdc_gw_id": null,
      "internet_gw_id": null,
      "name": "SRT2",
      "nexthop": "100.127.254.117",
      "service_type": "gcp",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vpn_gw_id": null
    },
    {
      "aws_gw_id": null,
      "azure_gw_id": null,
      "description": "StaticRoute for Scenario-test.",
      "destination": "100.127.255.184/29",
      "fic_gw_id": null,
      "gcp_gw_id": "1331e6a7-2876-4d34-b12f-5aac9517b034",
      "id": "e58162ca-9fef-4f27-898f-af0d495b780c",
      "interdc_gw_id": null,
      "internet_gw_id": null,
      "name": "StaticRoute_GCPGW_02_01",
      "nexthop": "100.127.255.189",
      "service_type": "gcp",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vpn_gw_id": null
    }
  ]
}

Create Static Route

Create static_route.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{endpoint}/v2.0/static_routes

HTTP Request Parameters

Parameter Style Type Format Enumeration Default Description Required
static_route plain object Static Route - - - yes
description plain string - - “” Description of the Static Route resource no
destination plain string cidr-or-ipv4 - - CIDR this static route points to yes
gcp_gw_id plain string hyph-uuid-or-empty - null GCP Gateway on which this static route will be set no
name plain string - - “” Name of the Static Route resource no
nexthop plain string ipv4 - - Next Hop address for specified CIDR yes
service_type plain string - [‘aws’, ‘azure’, ‘fic’, ‘gcp’, ‘vpn’, ‘internet’, ‘interdc’] - Service type for this route yes
tenant_id plain string non-hyph-uuid - See notes. Tenant ID of the owner (UUID) no

Note

tenant_id: The ID of default tenant to which user belongs.

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
static_route object Static Route -
description string - Description of the Static Route resource
destination string cidr-or-ipv4 CIDR this static route points to
gcp_gw_id string hyph-uuid-or-empty GCP Gateway on which this static route will be set
id string hyph-uuid Unique ID of the Static Route resource
name string - Name of the Static Route resource
nexthop string ipv4 Next Hop address for specified CIDR
service_type string - Service type for this route
status string - Static Route status.
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

{
  "static_route": {
    "description": "SRT2",
    "destination": "100.127.254.116/30",
    "gcp_gw_id": "5af4f343-91a7-4956-aabb-9ac678d215e5",
    "name": "SRT2",
    "nexthop": "100.127.254.117",
    "service_type": "gcp",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body

{
  "static_route": {
    "description": "SRT2",
    "destination": "100.127.254.116/30",
    "gcp_gw_id": "5af4f343-91a7-4956-aabb-9ac678d215e5",
    "id": "cd1dacf1-0838-4ffc-bbb8-54d3152b9a5a",
    "name": "SRT2",
    "nexthop": "100.127.254.117",
    "service_type": "gcp",
    "status": "PENDING_CREATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Show Static Route

Show details for static_route.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/static_routes/{static_route_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
static_route_id URI string hyph-uuid - Unique ID of the Static Route resource yes

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
static_route object Static Route -
aws_gw_id string hyph-uuid-or-empty AWS Gateway on which this static route will be set
azure_gw_id string hyph-uuid-or-empty Azure Gateway on which this static route will be set
description string - Description of the Static Route resource
destination string cidr-or-ipv4 CIDR this static route points to
fic_gw_id string hyph-uuid-or-empty FIC Gateway on which this static route will be set
gcp_gw_id string hyph-uuid-or-empty GCP Gateway on which this static route will be set
id string hyph-uuid Unique ID of the Static Route resource
interdc_gw_id string hyph-uuid-or-empty Inter DC Gateway on which this static route will be set
internet_gw_id string hyph-uuid-or-empty Internet Gateway on which this static route will be set
name string - Name of the Static Route resource
nexthop string ipv4 Next Hop address for specified CIDR
service_type string - Service type for this route
status string - Static Route status.
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)
vpn_gw_id string hyph-uuid-or-empty VPN Gateway on which this static route will be set

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "static_route": {
    "aws_gw_id": null,
    "azure_gw_id": null,
    "description": "SRT2",
    "destination": "100.127.254.116/30",
    "fic_gw_id": null,
    "gcp_gw_id": "5af4f343-91a7-4956-aabb-9ac678d215e5",
    "id": "cd1dacf1-0838-4ffc-bbb8-54d3152b9a5a",
    "interdc_gw_id": null,
    "internet_gw_id": null,
    "name": "SRT2",
    "nexthop": "100.127.254.117",
    "service_type": "gcp",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": null
  }
}

Update Static Route

Update static_route.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{endpoint}/v2.0/static_routes/{static_route_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
static_route_id URI string hyph-uuid - Unique ID of the Static Route resource yes
static_route plain object Static Route - - yes
description plain string - - Description of the Static Route resource no
name plain string - - Name of the Static Route resource no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
static_route object Static Route -
aws_gw_id string hyph-uuid-or-empty AWS Gateway on which this static route will be set
azure_gw_id string hyph-uuid-or-empty Azure Gateway on which this static route will be set
description string - Description of the Static Route resource
destination string cidr-or-ipv4 CIDR this static route points to
fic_gw_id string hyph-uuid-or-empty FIC Gateway on which this static route will be set
gcp_gw_id string hyph-uuid-or-empty GCP Gateway on which this static route will be set
id string hyph-uuid Unique ID of the Static Route resource
interdc_gw_id string hyph-uuid-or-empty Inter DC Gateway on which this static route will be set
internet_gw_id string hyph-uuid-or-empty Internet Gateway on which this static route will be set
name string - Name of the Static Route resource
nexthop string ipv4 Next Hop address for specified CIDR
service_type string - Service type for this route
status string - Static Route status.
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)
vpn_gw_id string hyph-uuid-or-empty VPN Gateway on which this static route will be set

Examples

Sample Request Body

{
  "static_route": {
    "description": "SRT2",
    "name": "SRT2"
  }
}

Sample Response Body

{
  "static_route": {
    "aws_gw_id": null,
    "azure_gw_id": null,
    "description": "SRT2",
    "destination": "100.127.254.116/30",
    "fic_gw_id": null,
    "gcp_gw_id": "5af4f343-91a7-4956-aabb-9ac678d215e5",
    "id": "cd1dacf1-0838-4ffc-bbb8-54d3152b9a5a",
    "interdc_gw_id": null,
    "internet_gw_id": null,
    "name": "SRT2",
    "nexthop": "100.127.254.117",
    "service_type": "gcp",
    "status": "PENDING_UPDATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": null
  }
}

Delete Static Route

Delete static_route.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • DELETE

HTTP Request Path

{endpoint}/v2.0/static_routes/{static_route_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
static_route_id URI string hyph-uuid - Unique ID of the Static Route resource yes

Response

HTTP Response Code List

Response Code Description
204 No Content
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

This operation does not receive a response body.

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

This operation does not receive a response body.