Get Projects

Get Projects
Request
URI
GET
https://{api_host}/v1/nsxt-clusters/{nsxtClusterId}/projects
COPY
Path Parameters
string
nsxtClusterId
Required

NSX cluster ID

Query Parameters
boolean
isCompatibleWithSupervisor
Optional
Constraints: default: false

Query Param to fetch Projects compatible with Supervisor Enablement. Set it to true to filter Projects compatible with Supervisor Enablement. If this query param is not provided or set to false, then it will return all Projects for a given NSX-T Cluster.

Responses
200

OK

Returns Page of type(s) application/json 
{
    "elements": [
        {
            "id": "string",
            "name": "string",
            "localizableDescriptionPack": {
                "component": "string",
                "messageKey": "string",
                "arguments": [
                    "string"
                ],
                "message": "string",
                "bundle": "string"
            },
            "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
            "status": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
            "creationTimestamp": "string",
            "completionTimestamp": "string",
            "subTasks": [
                {
                    "name": "string",
                    "type": "string",
                    "description": "string",
                    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED, NOT_APPLICABLE",
                    "creationTimestamp": "string",
                    "completionTimestamp": "string",
                    "stages": [
                        {
                            "name": "string",
                            "type": "string",
                            "description": "string",
                            "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
                            "creationTimestamp": "string",
                            "completionTimestamp": "string",
                            "errors": [
                                {
                                    "errorCode": "string",
                                    "errorType": "string",
                                    "arguments": [
                                        "string"
                                    ],
                                    "context": {
                                        "context": "string"
                                    },
                                    "message": "string",
                                    "remediationMessage": "string",
                                    "causes": [
                                        {
                                            "type": "string",
                                            "message": "string"
                                        }
                                    ],
                                    "nestedErrors": [
                                        "Error Object"
                                    ],
                                    "referenceToken": "string",
                                    "label": "string",
                                    "remediationUrl": "string"
                                }
                            ]
                        }
                    ],
                    "errors": [
                        {
                            "errorCode": "string",
                            "errorType": "string",
                            "arguments": [
                                "string"
                            ],
                            "context": {
                                "context": "string"
                            },
                            "message": "string",
                            "remediationMessage": "string",
                            "causes": [
                                {
                                    "type": "string",
                                    "message": "string"
                                }
                            ],
                            "nestedErrors": [
                                "Error Object"
                            ],
                            "referenceToken": "string",
                            "label": "string",
                            "remediationUrl": "string"
                        }
                    ],
                    "resources": [
                        {
                            "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                            "fqdn": "sfo-vc01.rainpole.io",
                            "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
                            "name": "string",
                            "sans": [
                                "sfo-vc01.rainpole.io"
                            ]
                        }
                    ],
                    "subTasks": [
                        "SubTask Object"
                    ],
                    "documentationLink": {
                        "url": "string",
                        "label": "string"
                    }
                }
            ],
            "errors": [
                {
                    "errorCode": "string",
                    "errorType": "string",
                    "arguments": [
                        "string"
                    ],
                    "context": {
                        "context": "string"
                    },
                    "message": "string",
                    "remediationMessage": "string",
                    "causes": [
                        {
                            "type": "string",
                            "message": "string"
                        }
                    ],
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "label": "string",
                    "remediationUrl": "string"
                }
            ],
            "resources": [
                {
                    "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                    "fqdn": "sfo-vc01.rainpole.io",
                    "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
                    "name": "string",
                    "sans": [
                        "sfo-vc01.rainpole.io"
                    ]
                }
            ],
            "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
            "isCancellable": false,
            "isRetryable": false
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of object
elements
Optional

The list of elements included in this page

object
pageMetadata
Optional

Represents pageable elements pagination metadata


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/nsxt-clusters/{nsxtClusterId}/projects
On This Page
Nsx T Clusters Operations
POST
Scale Out Nsx
POST
Start Nsx Criteria Query
POST
Connect Open Id
POST
Validate Ip Pool
GET
Get Nsx Clusters
GET
Get Projects
GET
Get Vpc Connectivity Profiles
GET
Get Vpc Configuration
GET
Get Nsx Transport Zones
GET
Get Nsx Ip Address Pools
GET
Get Nsx Ip Address Pool
GET
Get Nsx Cluster
GET
Get Nsx Cluster Query Response
GET
Get Validation Result
GET
Get Nsx Criteria
GET
Get Nsx Criterion