{
  "opencollection": "1.0.0",
  "info": {
    "name": "Equinix API Authentication VRFs API",
    "version": "1.2"
  },
  "items": [
    {
      "info": {
        "name": "VRFs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a BGP Dynamic Neighbor",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/bgp-dynamic-neighbors/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "BGP Dynamic Neighbor UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ]
          },
          "docs": "Return a single BGP Dynamic Neighbor resource"
        },
        {
          "info": {
            "name": "Delete a VRF BGP Dynamic Neighbor",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/bgp-dynamic-neighbors/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "BGP Dynamic Neighbor UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ]
          },
          "docs": "Trigger the removal of a BGP Neighbor range from a VRF"
        },
        {
          "info": {
            "name": "List BGP Dynamic Neighbors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal-gateways/:id/bgp-dynamic-neighbors",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Metal Gateway UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ]
          },
          "docs": "Returns the list of VRF BGP Dynamic Neighbors for this Metal Gateway"
        },
        {
          "info": {
            "name": "Create a VRF BGP Dynamic Neighbor range",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal-gateways/:id/bgp-dynamic-neighbors",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Metal Gateway UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a VRF BGP Dynamic Neighbor range.\n\nBGP Dynamic Neighbor records are limited to 2 per Virtual Network.\n\nNotice: VRFs are a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.\n"
        },
        {
          "info": {
            "name": "Retrieve all VRFs in the project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/projects/:id/vrfs",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              },
              {
                "name": "metro",
                "value": "",
                "type": "query",
                "description": "Filter by Metro ID (uuid) or Metro Code"
              }
            ]
          },
          "docs": "Returns the list of VRFs for a single project."
        },
        {
          "info": {
            "name": "Create a new VRF in the specified project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/projects/:id/vrfs",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new VRF in the specified project"
        },
        {
          "info": {
            "name": "Retrieve a VRF Route",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/routes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF Route UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ]
          },
          "docs": "Returns a single VRF Route resource"
        },
        {
          "info": {
            "name": "Update a VRF Route",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.equinix.com/routes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF Route UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requests a VRF Route be redeployed across the network. Updating the prefix or next-hop address on a route is not currently supported."
        },
        {
          "info": {
            "name": "Delete a VRF Route",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/routes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF Route UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ]
          },
          "docs": "Trigger the deletion of a VRF Route resource. The status of the route will update to 'deleting', and the route resource will remain accessible while background operations remove the route from the network. Once the route has been removed from the network, the resource will be fully deleted."
        },
        {
          "info": {
            "name": "Retrieve a VRF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/vrfs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ]
          },
          "docs": "Returns a single VRF resource"
        },
        {
          "info": {
            "name": "Update the VRF",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.equinix.com/vrfs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the VRF."
        },
        {
          "info": {
            "name": "Delete the VRF",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/vrfs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF UUID"
              }
            ]
          },
          "docs": "Deletes the VRF"
        },
        {
          "info": {
            "name": "Retrieve all VRF IP Reservations in the VRF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/vrfs/:id/ips",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects."
              }
            ]
          },
          "docs": "Returns the list of VRF IP Reservations for the VRF."
        },
        {
          "info": {
            "name": "Retrieve all VRF IP Reservations in the VRF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/vrfs/:vrf_id/ips/:id",
            "params": [
              {
                "name": "vrf_id",
                "value": "",
                "type": "path",
                "description": "VRF UUID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "IP UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects."
              }
            ]
          },
          "docs": "Returns the IP Reservation for the VRF."
        },
        {
          "info": {
            "name": "Retrieve all routes in the VRF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/vrfs/:id/routes",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ]
          },
          "docs": "Returns the list of routes for the VRF"
        },
        {
          "info": {
            "name": "Create a VRF route",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/vrfs/:id/routes",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "VRF UUID"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects."
              },
              {
                "name": "exclude",
                "value": "",
                "type": "query",
                "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a route in a VRF. Currently only static default routes are supported.\n\nNotice: VRFs are a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.\n"
        }
      ]
    }
  ],
  "bundled": true
}