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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Equinix

Equinix Organizations API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 15 operations across 9 paths, and defines 41 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.

15 operations 9 paths 41 schemas 1 DELETE9 GET4 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
Contact
Equinix API Support
Terms of Service
View terms
Resource Areas
1

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 1 DELETE, 9 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Organizations 15

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

GET
/organizations
Retrieve all organizations
findOrganizations 6 params → 200401
POST
/organizations
Create an organization
createOrganization 2 params body → 201401404422
DELETE
/organizations/{id}
Delete the organization
deleteOrganization 1 param → 204401404
GET
/organizations/{id}
Retrieve an organization's details
findOrganizationById 3 params → 200401403404
PUT
/organizations/{id}
Update the organization
updateOrganization 3 params body → 200401403404422
GET
/organizations/{id}/customdata
Retrieve the custom metadata of an organization
findOrganizationCustomdata 1 param → 200401403404
GET
/organizations/{id}/invitations
Retrieve organization invitations
findOrganizationInvitations 4 params → 200401403404
POST
/organizations/{id}/invitations
Create an invitation for an organization
createOrganizationInvitation 2 params body → 201401403404422
GET
/organizations/{id}/operating-systems
Retrieve all operating systems visible by the organization
findOperatingSystemsByOrganization 2 params → 200401403404
GET
/organizations/{id}/payment-methods
Retrieve all payment methods of an organization
findOrganizationPaymentMethods 4 params → 200401404
POST
/organizations/{id}/payment-methods
Create a payment method for the given organization
createPaymentMethod 2 params body → 201401404422
GET
/organizations/{id}/plans
Retrieve all plans visible by the organization
findPlansByOrganization 3 params → 200401403404
GET
/organizations/{id}/projects
Retrieve all projects of an organization
findOrganizationProjects 6 params → 200401
POST
/organizations/{id}/projects
Create a project for the organization
createOrganizationProject 3 params body → 201401422
GET
/organizations/{id}/transfers
Retrieve all project transfer requests from or to an organization
findOrganizationTransfers 2 params → 200401403

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are Project (19 properties), Organization (17 properties), PaymentMethod (15 properties), Plan (14 properties). Each schema is shown below with its type and property counts.

Plan_specs_drives_inner_category
string
Meta
object
8 properties
Plan_available_in_inner_price
object
1 property
Plan_specs
object
5 properties
PaymentMethod
object
15 properties
ProjectList
object
2 properties
Invitation_roles_inner
string
Address
object
7 properties 3 required
Plan_deployment_types_inner
string
Plan_specs_features
object
3 properties
Plan_available_in_metros_inner
object
2 properties
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…
Plan
object
14 properties
PlanList
object
1 property
PaymentMethodCreateInput
object
3 properties 2 required
OrganizationInput
object
9 properties
Organization
object
17 properties
PaymentMethodList
object
1 property
findOrganizations_personal_parameter
string
OperatingSystemList
object
1 property
Plan_specs_memory
object
1 property
InvitationInput
object
5 properties 1 required
TransferRequest
object
6 properties
TransferRequestList
object
1 property
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.
PaymentMethodBillingAddress
object
3 properties
ProjectCreateInput
object
5 properties 1 required
InvitationList
object
1 property
Project
object
19 properties
Plan_specs_cpus_inner
object
2 properties
Plan_available_in_inner
object
2 properties
Plan_type
string
The plan type
Coordinates
object
2 properties
OperatingSystem
object
11 properties
Membership
object
7 properties
OrganizationList
object
2 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
Plan_specs_nics_inner
object
2 properties
Plan_specs_drives_inner
object
4 properties
Href
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-organizations-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
AE Profile APIs.io
Equinix Agents API
AE Profile APIs.io
Equinix Authentication API
AE Profile APIs.io
Equinix availability API
AE Profile APIs.io
Equinix Batches API
AE Profile APIs.io
Equinix BGP API
AE Profile APIs.io
Equinix Capacity API
AE Profile APIs.io
Equinix Cloud Events API
AE Profile APIs.io
Equinix Cloud Routers API
AE Profile APIs.io
Equinix Company Profiles API
AE Profile APIs.io
Equinix Connections API
AE Profile APIs.io
Equinix Console Log Details API
AE Profile APIs.io
#Organizations
← Back to E APIs
API Details
ID
equinix:equinix-organizations-api
Base URL
https://api.equinix.com
Docs
https://developer.equinix.com/catalog/fabricv4
Provider
Equinix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network