{
  "opencollection": "1.0.0",
  "info": {
    "name": "Metal Authentication Interconnections API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Interconnections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get interconnection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/connections/:connection_id",
            "params": [
              {
                "name": "connection_id",
                "value": "",
                "type": "path",
                "description": "Interconnection 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": "Get the details of a interconnection"
        },
        {
          "info": {
            "name": "Update interconnection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.equinix.com/metal/v1/connections/:connection_id",
            "params": [
              {
                "name": "connection_id",
                "value": "",
                "type": "path",
                "description": "Interconnection 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": "Update the details of a interconnection"
        },
        {
          "info": {
            "name": "Delete interconnection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/metal/v1/connections/:connection_id",
            "params": [
              {
                "name": "connection_id",
                "value": "",
                "type": "path",
                "description": "Interconnection 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": "Delete a interconnection, its associated ports and virtual circuits."
        },
        {
          "info": {
            "name": "List a interconnection's ports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/connections/:connection_id/ports",
            "params": [
              {
                "name": "connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the interconnection"
              }
            ]
          },
          "docs": "List the ports associated to an interconnection."
        },
        {
          "info": {
            "name": "List a interconnection's virtual circuits",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/connections/:connection_id/virtual-circuits",
            "params": [
              {
                "name": "connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the interconnection"
              }
            ]
          },
          "docs": "List the virtual circuit record(s) associated with a particular interconnection id."
        },
        {
          "info": {
            "name": "Get a interconnection port",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/connections/:connection_id/ports/:id",
            "params": [
              {
                "name": "connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the interconnection"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Port 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": "Get the details of an interconnection port."
        },
        {
          "info": {
            "name": "List a interconnection port's virtual circuits",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/connections/:connection_id/ports/:port_id/virtual-circuits",
            "params": [
              {
                "name": "connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the interconnection"
              },
              {
                "name": "port_id",
                "value": "",
                "type": "path",
                "description": "UUID of the interconnection port"
              },
              {
                "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": "List the virtual circuit record(s) associatiated with a particular interconnection port."
        },
        {
          "info": {
            "name": "Create a new Virtual Circuit",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/connections/:connection_id/ports/:port_id/virtual-circuits",
            "params": [
              {
                "name": "connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the interconnection"
              },
              {
                "name": "port_id",
                "value": "",
                "type": "path",
                "description": "UUID of the interconnection port"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Virtual Circuit on a Dedicated Port. To create a regular Virtual Circuit, specify a Virtual Network record and an NNI VLAN value. To create a VRF-based Virtual Circuit, specify the VRF ID and subnet, along with the NNI VLAN value."
        },
        {
          "info": {
            "name": "List organization connections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:organization_id/connections",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "UUID of the organization"
              },
              {
                "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": "List the connections belonging to the organization"
        },
        {
          "info": {
            "name": "Request a new interconnection for the organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/organizations/:organization_id/connections",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "UUID of the organization"
              },
              {
                "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 interconnection request. A Project ID must be specified in the request body for connections on shared ports."
        },
        {
          "info": {
            "name": "List project connections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects/:project_id/connections",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "UUID of the project"
              },
              {
                "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": "page",
                "value": "",
                "type": "query",
                "description": "Page to return"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Items returned per page"
              }
            ]
          },
          "docs": "List the connections belonging to the project"
        },
        {
          "info": {
            "name": "Request a new interconnection for the project's organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/projects/:project_id/connections",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "UUID of the project"
              },
              {
                "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 interconnection request"
        },
        {
          "info": {
            "name": "Get a virtual circuit",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/virtual-circuits/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Virtual Circuit 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": "Get the details of a virtual circuit"
        },
        {
          "info": {
            "name": "Update a virtual circuit",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.equinix.com/metal/v1/virtual-circuits/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Virtual Circuit 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": "Update the details of a virtual circuit."
        },
        {
          "info": {
            "name": "Delete a virtual circuit",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/metal/v1/virtual-circuits/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Virtual Circuit 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": "Delete a virtual circuit from a Dedicated Port."
        }
      ]
    }
  ],
  "bundled": true
}