Skip to main content
API docs by Redocly

Project APIs (2.0.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

API documentation for project APIs

Find more information on Equinix Developer Portal

Project

Project related APIs

To retrieve projects of a root organization

To get projects associated to a root organization based on the user permissions

Authorizations:
BearerAuth
query Parameters
includePermissions
boolean
Default: false

whether to include the user permissions on the project resource

includeInbox
boolean
Default: false

Whether to include the projects with inbox classification or not

limit
integer [ 1 .. 100 ]
Default: 20
Example: limit=50

Limits the number of returned results

offset
integer >= 0
Default: 0
Example: offset=0

Offset from which start returned results

Responses

Response Schema: application/json
object (Pagination)
offset
integer

the data items would be fetched from the user input offset point

limit
integer
Default: 20

max number of data items that can be fetched in current request

total
integer

total number of data items available

previous
string

Url to fetch previous set of paginated data

next
string

Url to fetch next set of paginated data

Array of objects (ProjectV2Response)
Array
projectId
string

Project id

projectName
string

Project name

inboxResource
boolean

Inbox project or not

parentOrganizationId
string

Parent organization id

object

Resource Labels as JSON key, value pairs

silentProject
boolean

Whether the returned project is a SILENT project or not

Array of objects

Available user permissions on the project resource, if requested by query param

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}