Get a vrf object by UUID

get

https://example.com/api/vrfs/{vrf_uuid}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

vrf_uuid

string

required

UUID of Virtual Routing Forwarding to return

Query Params

ip_interfaces

boolean

Include Interface information with each Virtual Routing Forwarding object in the response body.

ip_static_routes

boolean

Include static route information with each Virtual Routing Forwarding object in the response body.

include_referenced_objects

boolean

If returning Virtual Routing Forwarding child objects in the response body, also include any objects referenced by those child objects in the response.

include_bgp_global

boolean

Include Border Gateway Protocol Global configuration with each Virtual Routing Forwarding object in the response body.

include_bgp

boolean

Include Border Gateway Protocol information with each Virtual Routing Forwarding object in the response body.

include_networks

boolean

Include Network objects for the object in the response body

include_ospf_global

boolean

Include Open Shortest Path First Global configuration with each Virtual Routing Forwarding object in the response body.

include_ospf

boolean

Include Open Shortest Path First Routers information with each Virtual Routing Forwarding object in the response body.

filter

string

Filter data results by query string

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json; version=1.0

200Success

400Invalid Input

401Error: Unauthorized

404Virtual Routing Forwarding Not Found