Projects

Get Projects

GET /resourceManager/v2/projects
Method GET
Endpoint /resourceManager/v2/projects
Headers Authorization
Path Parameters Not applicable
Query Parameters includePermissions, includeInbox, offset, limit
Body Parameters Not applicable

This API request retrieves all projects in the root organization.


Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/resourceManager/v2/projects?includePermissions=true&includeInbox=true'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter
Description
includePermissions boolean
OPTIONAL		 Include user permissions.
Default: false
includeInbox boolean
OPTIONAL		 Include inbox projects, which aggregate assets ordered offline or using legacy tools.
Default: false
offset integer
OPTIONAL		 Index of the first item returned in the response.
Default: 0
limit integer
OPTIONAL		 Maximum number of items returned per page.
Default: 50

Sample response

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 2
    },
    "data": [
        {
            "projectId": "1234",
            "projectName": "Top Secret Project",
            "labels": {
                "application": "Network Edge"
            },
            "parentOrganizationId": "1234",
            "resourceSubType": "END_CUSTOMER",
            "rootOrgId": "316481000362970",
            "inboxResource": false,
            "silentProject": false,
            "permissions": [
                {
                    "actions": [
                        "networkedge.acl.view",
                        "networkedge.acl.create",
                        "networkedge.acl.modify"
                    ],
                    "resourceType": "ACL"
                },
                {
                    "actions": [
                        "fabric.port.read"
                    ],
                    "resourceType": "PORT"
                }
            ]
        },
        {
            "projectId": "5678",
            "projectName": "Potato Inc. Project",
            "labels": {
                "application": "Network Edge"
            },
            "parentOrganizationId": "1234",
            "resourceSubType": "END_CUSTOMER",
            "rootOrgId": "316481000362970",
            "inboxResource": false,
            "silentProject": false,
            "permissions": [
                {
                    "actions": [
                        "networkedge.l2connection.view",
                        "fabric.l2connection.read",
                        "networkedge.l2connection.create",
                        "networkedge.l2connection.delete",
                        "networkedge.l2connection.modify"
                    ],
                    "resourceType": "L2_CONNECTION"
                }
            ]
        }
    ]
}

Response payload body description

Parameter
Description
pagination object
 Data set pagination information.
offset integer
 Index of the first item returned in the response.
limit integer
 Maximum number of items returned per page.
total integer
 Total number of items.
previous integer
 Previous data page URL.
Example: /resourceManager/v2/projects?offset=0&limit=20
next integer
 Next data page URL.
Example: /resourceManager/v2/projects?offset=10&limit=20
data array[object]
 Data set containing projects information.
projectId string
 Project identifier
Example: 173314000205617
projectName string
 Project name.
Example: Potato Inc. Project
labels object
 Product labels assigned to a resource.
application string
 Application name.
Example: Network Edge
parentOrganizationId string
 Parent organization identifier.
Example: 799989000980371
resourceSubType string
 Resource subtype.
Possible values:
  • RESELLER
  • END_CUSTOMER
  • END_CUSTOMER_ROOT
rootOrgId string
 Root organization identifier.
Example: 799989000980371
inboxResource boolean
 Indicates an inbox project, which aggregates assets ordered offline or using legacy tools.
Example: false
silentProject boolean
 Internal Equinix attribute associated with a project that is currently part of a system upgrade.
Note: Only projects with silentProject attribute set to false can be used for ordering product assets.
Example: false
permissions array[object]
 Permissions assigned to the user on a project level or inherited from a parent entity.
actions array[string]
 List of resource-specific access permissions.
Example: fabric.l2connection.read
resourceType string
 Product resource type.
Example: L2_CONNECTION