Add Static Routes on a Logical Router

Adds a new static route on a Logical Router

Request:

Method:

POST

URI Path(s):

/api/v1/logical-routers/<logical-router-id>/routing/static-routes

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

StaticRoute+

StaticRoute (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
logical_router_id	Logical router id	string	Readonly
network	CIDR	IPCIDRBlock	Required
next_hops	Next Hops	array of StaticRouteNextHop	Required Minimum items: 1
resource_type	Must be set to the value StaticRoute	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<nsx-mgr>/api/v1/logical-routers/7a62a0c5-1ea1-4b25-9d43-dce1c0fa4b8c/routing/static-routes { "resource_type": "StaticRoute", "description": "", "display_name": "to customer A", "tags": [], "next_hops": [ { "administrative_distance": "2", "ip_address": "192.168.200.254" } ], "network": "192.168.200.0/24" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

StaticRoute+

StaticRoute (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
logical_router_id	Logical router id	string	Readonly
network	CIDR	IPCIDRBlock	Required
next_hops	Next Hops	array of StaticRouteNextHop	Required Minimum items: 1
resource_type	Must be set to the value StaticRoute	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "StaticRoute", "description": "", "id": "65fb67d8-0485-4c23-8e59-b9ccd8799a4c", "display_name": "to customer A", "tags": [], "next_hops": [ { "administrative_distance": 2, "ip_address": "192.168.200.254" } ], "network": "192.168.200.0/24", "_create_time": 1457391214234, "_last_modified_user": "admin", "_system_owned": false, "_last_modified_time": 1457391214234, "_create_user": "admin", "_revision": 0 }

Add Static Routes on a Logical Router

Request:

StaticRoute (schema)

Example Request:

Successful Response:

StaticRoute (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: