{
  "opencollection": "1.0.0",
  "info": {
    "name": "Equinix API Authentication IPAddresses API",
    "version": "1.2"
  },
  "items": [
    {
      "info": {
        "name": "IPAddresses",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve an ip address",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/ips/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "IP Address 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 ip address if the user has access."
        },
        {
          "info": {
            "name": "Update an ip address",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.equinix.com/ips/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "IP Address 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 details about an ip address"
        },
        {
          "info": {
            "name": "Unassign an ip address",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/ips/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "IP Address UUID"
              }
            ]
          },
          "docs": "This call can be used to un-assign an IP assignment or delete\nan IP reservation.\n\nUn-assign an IP address record.\nUse the assignment UUID you\nget after attaching the IP. This will remove the relationship between an IP and the device or metal gateway and will make the IP address available to be assigned to another device, once the IP has been un-configured from the network.\n\nDelete an IP reservation.\nUse the reservation UUID you get after adding the IP to the project. This will permanently delete"
        },
        {
          "info": {
            "name": "Retrieve all available subnets of a particular reservation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/ips/:id/available",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "IP Reservation UUID"
              },
              {
                "name": "cidr",
                "value": "",
                "type": "query",
                "description": "Size of subnets in bits"
              }
            ]
          },
          "docs": "Provides a list of IP resevations for a single project."
        },
        {
          "info": {
            "name": "Retrieve the custom metadata of an IP Reservation or IP Assignment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/ips/:id/customdata",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Ip Reservation UUID"
              }
            ]
          },
          "docs": "Provides the custom metadata stored for this IP Reservation or IP Assignment in json format"
        },
        {
          "info": {
            "name": "Retrieve all ip reservations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/projects/:id/ips",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Filter project IP reservations by reservation type"
              },
              {
                "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": "per_page",
                "value": "",
                "type": "query",
                "description": "Items returned per page"
              }
            ]
          },
          "docs": "Provides a paginated list of IP reservations for a single project."
        },
        {
          "info": {
            "name": "Requesting IP reservations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/projects/:id/ips",
            "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": "Request more IP space for a project in order to have additional IP addresses to assign to devices.  If the request is within the max quota, an IP reservation will be created. If the project will exceed its IP quota, a request will be submitted for review, and will return an IP Reservation with a `state` of `pending`. You can automatically have the request fail with HTTP status 422 instead of triggering the review process by providing the `fail_on_approval_required` parameter set to `true` in the"
        }
      ]
    }
  ],
  "bundled": true
}