GET v1/bunits/{bunitId}/datacenters/{dataCenterId}/spservers/{spServerId}/credentials
Returns all credentials for a server.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
integer |
Required |
|
dataCenterId |
integer |
Required |
|
spServerId |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ServerCredentials| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
A read-only friendly name for the credentials that matches the server name. |
string |
Read-only. |
Username |
A username for the server. |
string |
Required. |
Password |
A password for the server. |
string |
Required. Passwords are never exposed through the API. |
TotpSecretKey |
Secret key used to generate TOTP codes |
string |
None. |
HasTotpSecretKey |
The TOTP secret key is not available through the API so to indicate that one exists this bool is set accordingly |
boolean |
None. |
AccessToken |
API access to the server can be done with an access-token instead of username and password Beware that access-tokens may expire |
string |
None. |
HasAccessToken |
The acccess token is not available through the API so to indicate that one exists this bool is set accordingly |
boolean |
None. |
Server |
The server to which the credentials work. |
SpServer |
Included when retrieving the keychain for a user resource. |
SpPlusServer |
The server to which the credentials work. |
SpPlusServer |
Included when retrieving the keychain for a user resource. |
RubrikServer |
The server to which the credentials work. |
RubrikServer |
Included when retrieving the keychain for a user resource. |
CohesityServer |
The server to which the credentials work. |
CohesityServer |
Included when retrieving the keychain for a user resource. |
PointServer |
The server to which the credentials work. |
PointServer |
Included when retrieving the keychain for a user resource. |
User |
The user whose credentials it is. The user is always null for the server's default credentials. |
User |
Included when retrieving credentials for a server resource. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.