[{"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/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Get Credentials

Description

Get the Credentials

Request

URL

get

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

Copy

Query Parameters

string

accountType Optional

Type of the account that needs to be fetched by filtering

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

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

string

pageSize Optional

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

string

resourceIp Optional

The IP address of the resource

string

resourceName Optional

The name of the resource

string

resourceType Optional

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

Response

Response Body

200 OK

Returns PageOfCredential of type(s) application/json

{
	"elements": [
		{
			"accountType": "One among: USER, SYSTEM, SERVICE",
			"autoRotatePolicy": {
				"frequencyInDays": 0,
				"nextSchedule": "string"
			},
			"creationTimestamp": "string",
			"credentialType": "One among: SSO, SSH, API, FTP, AUDIT",
			"expiry": {
				"connectivityStatus": "One among: ACTIVE, ERROR, UNKNOWN",
				"expiryDate": "string",
				"lastCheckedDate": "string",
				"status": "One among: ACTIVE, EXPIRING, EXPIRED, UNKNOWN"
			},
			"id": "string",
			"modificationTimestamp": "string",
			"password": "string",
			"resource": {
				"domainName": "string",
				"resourceId": "string",
				"resourceIp": "string",
				"resourceName": "string",
				"resourceType": "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"
			},
			"username": "string"
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}

array of Credential

elements Optional

The list of elements included in this page

PageMetadata

pageMetadata Optional

Pageable elements pagination metadata information

Errors

Error

400

Bad Request

Error

401

Unauthorized

Error

403

Forbidden

Error

500

Internal Server Error

Code Samples

cURL Command

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

vcf

Credentials Operations

delete

Cancel Credentials Task

post

Fetch Password Expiration

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

patch

Retry Credentials Task

patch

Update Or Rotate Passwords

Get Credentials

Request

URL

Query Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Credentials Operations

Was this page helpful?