Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Equinix Projects API

Project Management. Check out the product docs to learn more about [Projects](https://metal.equinix.com/developers/docs/accounts/projects/).

Equinix Projects API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Projects. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 7 paths, and defines 20 schemas. It is described by OpenAPI 3.0.1, at version 1.2.

Requests are made against a single base URL, https://api.equinix.com.

11 operations 7 paths 20 schemas 1 DELETE6 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.2
Base URL
https://api.equinix.com
Terms of Service
Resource Areas
1

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 11

Project Management. Check out the product docs to learn more about [Projects](https://metal.equinix.com/developers/docs/accounts/projects/).

GET
/projects
Retrieve all projects
findProjects 5 params → 200401
POST
/projects
Create a project
createProject 2 params body → 201401422
DELETE
/projects/{id}
Delete the project
deleteProject 1 param → 204401403404
GET
/projects/{id}
Retrieve a project
findProjectById 3 params → 200401403404
PUT
/projects/{id}
Update the project
updateProject 3 params body → 200401403404422
GET
/projects/{id}/customdata
Retrieve the custom metadata of a project
findProjectCustomdata 1 param → 200401403404
POST
/projects/{id}/transfersdeprecated
Create a transfer request
createTransferRequest 2 params body → 201401403404422
GET
/projects/{project_id}/invitations
Retrieve project invitations
findProjectInvitations 4 params → 200401403404
POST
/projects/{project_id}/invitations
Create an invitation for a project
createProjectInvitation 2 params body → 201401403404422
GET
/projects/{project_id}/ips/{id}/customdata
Retrieve the custom metadata of an IP Reservation
findIPReservationCustomdata 2 params → 200401403404
GET
/projects/{project_id}/memberships
Retrieve project memberships
findProjectMemberships 5 params → 200401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Project (19 properties), Organization (17 properties), Invitation (11 properties), Meta (8 properties). Each schema is shown below with its type and property counts.

Meta
object
8 properties
MembershipList
object
1 property
ProjectList
object
2 properties
Invitation_roles_inner
string
Address
object
7 properties 3 required
ProjectCreateFromRootInput_type
string
The type of the project. If no type is specified the project type will automatically be default Projects of type 'vmce' are part of an in development feature a…
Organization
object
17 properties
InvitationInput
object
5 properties 1 required
TransferRequest
object
6 properties
ProjectCreateFromRootInput
object
6 properties 1 required
Project_type
string
The type of the project. Projects of type vmce are part of an in development feature and not available to all customers.
TransferRequestInput
object
1 property
InvitationList
object
1 property
Project
object
19 properties
Coordinates
object
2 properties
Membership
object
7 properties
ProjectUpdateInput
object
5 properties
Invitation
object
11 properties
Error
object
Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
2 properties
Href
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-projects-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Cloud Routers API
Equinix Company Profiles API
Equinix Connections API
Equinix Console Log Details API