{
  "opencollection": "1.0.0",
  "info": {
    "name": "Metal Authentication Batches API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Batches",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a Batch",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/batches/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Batch 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."
              }
            ]
          },
          "docs": "Returns a Batch"
        },
        {
          "info": {
            "name": "Delete the Batch",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/metal/v1/batches/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Batch UUID"
              },
              {
                "name": "remove_associated_instances",
                "value": "",
                "type": "query",
                "description": "Delete all instances created from this batch"
              }
            ]
          },
          "docs": "Deletes the Batch."
        },
        {
          "info": {
            "name": "Retrieve all batches by project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects/:id/batches",
            "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."
              }
            ]
          },
          "docs": "Returns all batches for the given project"
        },
        {
          "info": {
            "name": "Create a devices batch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/projects/:id/devices/batch",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates new devices in batch and provisions them in our datacenter."
        }
      ]
    }
  ],
  "bundled": true
}