{
  "opencollection": "1.0.0",
  "info": {
    "name": "Metal Authentication Projects API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Projects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve all projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter results by name."
              },
              {
                "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": "Returns a collection of projects that the current user is a member of."
        },
        {
          "info": {
            "name": "Create a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/projects",
            "params": [
              {
                "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 project for the user default organization. If the user don't have an organization, a new one will be created."
        },
        {
          "info": {
            "name": "Retrieve a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects/:id",
            "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."
              }
            ]
          },
          "docs": "Returns a single project if the user has access"
        },
        {
          "info": {
            "name": "Update the project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.equinix.com/metal/v1/projects/:id",
            "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": "Updates the project."
        },
        {
          "info": {
            "name": "Delete the project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/metal/v1/projects/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              }
            ]
          },
          "docs": "Deletes the project."
        },
        {
          "info": {
            "name": "Retrieve the custom metadata of a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects/:id/customdata",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              }
            ]
          },
          "docs": "Provides the custom metadata stored for this project in json format"
        },
        {
          "info": {
            "name": "Create a transfer request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/projects/:id/transfers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "UUID of the project to be transferred"
              },
              {
                "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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Organization owners can transfer their projects to other organizations."
        },
        {
          "info": {
            "name": "Retrieve project invitations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects/:project_id/invitations",
            "params": [
              {
                "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": "page",
                "value": "",
                "type": "query",
                "description": "Page to return"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Items returned per page"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              }
            ]
          },
          "docs": "Returns all invitations in a project."
        },
        {
          "info": {
            "name": "Create an invitation for a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/projects/:project_id/invitations",
            "params": [
              {
                "name": "project_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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "In order to add a user to a project, they must first be invited."
        },
        {
          "info": {
            "name": "Retrieve the custom metadata of an IP Reservation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects/:project_id/ips/:id/customdata",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Ip Reservation UUID"
              }
            ]
          },
          "docs": "Provides the custom metadata stored for this IP Reservation in json format"
        },
        {
          "info": {
            "name": "Retrieve project memberships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/projects/:project_id/memberships",
            "params": [
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Search by member full name, id and email."
              },
              {
                "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": "page",
                "value": "",
                "type": "query",
                "description": "Page to return"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Items returned per page"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project UUID"
              }
            ]
          },
          "docs": "Returns all memberships in a project."
        }
      ]
    }
  ],
  "bundled": true
}