[{"label":"Latest (4.4.0)","version":"latest"},{"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

Get Credentials

Description

Get the Credentials

Request

Request

URL

URL


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

Query Parameters

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

Response Body

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",
			"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 Optional

Pageable elements pagination metadata information

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


500

Internal Server Error

Code Samples

Code Samples

cURL Command

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


[{"label":"Latest (4.4.0)","version":"latest"},{"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
Feedback

Was this page helpful?