Get Credentials

Get Credentials

Retrieve a list of credentials

Request
URI
GET
https://{api_host}/v1/credentials
COPY
Query Parameters
string
resourceName
Optional

The name of the resource

string
resourceIp
Optional Deprecated

The IP address of the resource

string
resourceType
Optional

The type of the resource. One among: ESXI, VCENTER, PSC, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, NSX_ALB, BACKUP

string
domainName
Optional

The name of the domain to which the resource belongs to (may be null in case there is no associated domain)

string
pageNumber
Optional
Constraints: default: 0

The page number (must be a positive number), starts with 0

string
pageSize
Optional
Constraints: default: 0

The page size (must be a positive number, 0 as page size returns all records in one page

string
accountType
Optional

Type of the account that needs to be fetched by filtering


Responses
200

Ok

Returns PageOfCredential of type(s) application/json
{
    "elements": [
        {
            "id": "string",
            "credentialType": "One among: SSO, SSH, API, FTP, AUDIT",
            "accountType": "One among: USER, SYSTEM, SERVICE",
            "username": "string",
            "password": "string",
            "creationTimestamp": "string",
            "modificationTimestamp": "string",
            "expiry": {
                "expiryDate": "string",
                "lastCheckedDate": "string",
                "connectivityStatus": "One among: ACTIVE, ERROR, UNKNOWN",
                "status": "One among: ACTIVE, EXPIRING, EXPIRED, UNKNOWN"
            },
            "resource": {
                "resourceId": "string",
                "resourceName": "string",
                "resourceIp": "string",
                "resourceType": "One among: ESXI, VCENTER, PSC, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, NSX_ALB, BACKUP",
                "domainNames": [
                    "string"
                ],
                "domainName": "string"
            },
            "autoRotatePolicy": {
                "frequencyInDays": 0,
                "nextSchedule": "string"
            }
        }
    ],
    "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


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


401

Unauthorized

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


403

Forbidden

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/credentials