Verify the address and credentials of a cluster
Verifies the address and credentials of a cluster, retrieving the cluster information to confirm connectivity and authentication details. Use this to ensure the cluster is accessible and properly configured.
HTTP method and endpoint
GET /onprem/metadata/cluster-info
Usage notes
Verifies the address and credentials of the specified cluster by retrieving the cluster information.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
clusterAddress |
string |
header |
False |
|
clusterUsername |
string |
header |
False |
|
clusterPassword |
string |
header |
False |
Error
Status: Default, Default response
| Name | Type | Required | Description |
|---|---|---|---|
clusterIp |
string |
False |
|
clusterName |
string |
False |
|
clusterUuid |
string |
False |
|
isAdmin |
boolean |
True |
|
nodeModels |
array[string] |
True |
|
ontapVersion |
string |
False |
|
serialNumber |
string |
True |
Example error response
{
"clusterIp": "string",
"clusterName": "string",
"clusterUuid": "string",
"isAdmin": false,
"nodeModels": [
"string"
],
"ontapVersion": "string",
"serialNumber": "string"
}