{
  "opencollection": "1.0.0",
  "info": {
    "name": "Metal Authentication HardwareReservations API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "HardwareReservations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a hardware reservation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/hardware-reservations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "HardwareReservation 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 hardware reservation"
        },
        {
          "info": {
            "name": "Activate a spare hardware reservation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/hardware-reservations/:id/activate",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Hardware Reservation 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": "Activate a spare hardware reservation"
        },
        {
          "info": {
            "name": "Move a hardware reservation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/hardware-reservations/:id/move",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Hardware Reservation 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": "Move a hardware reservation to another project"
        },
        {
          "info": {
            "name": "Retrieve all hardware reservations for a given project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects/:id/hardware-reservations",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Search by facility code, plan name, project name, reservation short ID or device hostname"
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Filter by hardware reservation state"
              },
              {
                "name": "provisionable",
                "value": "",
                "type": "query",
                "description": "Filter hardware reservation that is provisionable"
              },
              {
                "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": "Provides a collection of hardware reservations for a given project."
        }
      ]
    }
  ],
  "bundled": true
}