Changed1

[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]

vcf-for-vxrail

Fetch Password Expiration

Description

Fetch expiration details of passwords for a list of credentials

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/credentials/expirations

Copy

Request Body

CredentialsExpirationSpec of type(s) application/json Required

credentialsExpirationSpec

Show optional properties

{
    "resourceType": "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"
}

{
    "resourceType": "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"
}

string

resourceType Required

Authenticated Resource Type

array of string

credentialIds Optional

List of credential ids

string

domainName Optional

Domain name

Response

200 OK Response Body>

Response Body

200 OK

Returns CredentialsExpiration of type(s) application/json

{
    "status": "One among: COMPLETED, FAILED, IN_PROGRESS"
}

string

completionTimestamp Optional

Completion timestamp

string

creationTimestamp Optional

Creation timestamp

array of CredentialExpirationCheck

elements Optional

List of one or more expiration checks that are performed as part of the credentials expiration task

string

id Optional

ID of expiration task

string

status Optional

Execution status of the expiration

202 Accepted Response Body>

Response Body

202 Accepted

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

Errors

Error

400

Bad Request

Error

401

Unauthorized

Error

403

Forbidden

Error

429

Too many requests

Error

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"resourceType":"One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"}' https://sfo-vcf01.rainpole.io/v1/credentials/expirations

vcf-for-vxrail

What's changed in 4.5.0?

INTRODUCED

Credentials Operations

delete

Cancel Credentials Task

post

Fetch Password Expiration Introduced

get

Get Credential

get

Get Credentials

get

Get Credentials Sub Task

get

Get Credentials Task

get

Get Credentials Task Resources Credentials

get

Get Credentials Tasks

get

Get Expirations For Passwords Introduced

patch

Retry Credentials Task

patch

Update Or Rotate Passwords

Fetch Password Expiration

Request

URL

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

What's changed in 4.5.0?

On This Page

Credentials Operations

Was this page helpful?