Managing a Project¶
All servers and infrastructure on Equinix Metal are provisioned as part of a Project. Create multiple Projects in an Organization to logically group your Equinix Metal™ infrastructure. Each Project's servers, storage, and networking can be managed separately.
How To See Your Projects¶
A list of all the Projects you have access to in an Organization is on the Organization's Projects tab, in the Your Projects table.
Click on a Project's name to open its top-level Manage Servers page.
You can switch Projects from the Project drop-down menu. The menu is sorted by the last modified Project. You can navigate back to the Your Projects table by clicking Manage All Projects.
To get a list of all the Project's you have access to, send a GET request to the /projects endpoint.
curl -X GET \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects"
Project-level Infrastructure¶
On the Project's navigation menu is your Project-level Equinix Metal infrastructure, broken down into categories: Bare Metal Servers, Storage, Networking, Interconnections and Project Settings.
Bare Metal Servers¶
Under Bare Metal Servers is where you can provision and manage servers using the Equinix Metal console, with the option to deploy On Demand servers and manage your Reserved Servers.
You can view and manage any servers that are currently in your Project from the Manage Servers page.
Networking¶
Under Networking is where you can provision and manage your Project's networking infrastructure, including:
Interconnections¶
Under Interconnections, you can provision and manage Fabric Virtual Connections and Dedicated Ports. These allow you to expand and connect your Equinix Metal Layer 2 networks across Equinix Fabric to other Cloud Service Providers or to your colocated infrastructure.
More information is available in the Interconnections documentation.
Project Settings¶
Project Settings is where you can:
- Manage the name and description of the Project.
- Access the Project ID, which is used to reference the project in the API and allows it to be renamed at any time.
- Mange the Project's API keys.
- Manage the Project's SSH keys.
- Access the Project's Timeline.
- Monitor the Project's Usage.
If you a Collaborator on a project, then you are also able to leave the project. If you are the Owner or Admin of the organization the project belongs to, then you have the option to delete the project.
To get the details of a Project, send a GET request to the /projects/{id} endpoint.
curl -X GET \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}"
To update a Project, send a PUT request to the /projects/{id} endpoint.
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
https://api.equinix.com/metal/v1/projects/{id}
-d '{
"customdata": {<object>},
"name": "<string>",
"tags": [
"<string>"
]
}'
A full list of updatable fields is available in the API Reference.
Transferring a Project¶
Transferring a Project is not currently supported. Please reach out to support at https://console.equinix.com/support or email support@equinixmetal.com to explore your options.
Deleting a Project¶
Caution
Deleting an project is permanent. You will not be able to recover a project once deleted. When you click delete, all servers, team members, and associated content will be removed forever.
Owners or Admins of the organization that owns the project are the only users that can delete a project. You can't delete a project that has active resources. You have to deprovision all servers and other infrastructure from a project in order to delete it.
You can delete a project from the Project Settings, on the General tab.
Click Delete Project and confirm on the confirmation dialog.
To delete a project in the CLI, use the metal project delete command.
metal project delete --id <project_UUID>
In the API, you can delete an organization by sending a DELETE request to the /projects/{id} endpoint.
curl -X DELETE -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/projects/{project_id}"
Once a project is deleted, it will not accrue additional Usage. Any outstanding usage charges are billed to the organization at the end of the billing cycle.