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/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

Query Check Sets

Description

Query for check-sets for the given resources

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/system/check-sets/queries

Copy

Request Body

CheckSetQueryInput of type(s) application/json Required

Check-set query input

{
    "checkSetType": "UPGRADE"
}

string

checkSetType Optional

Type of the check sets to query for. e.g. ‘UPGRADE’

array of CheckSetQueryDomainResources

domains Optional

List of domain resources to query check-sets of the given type for

Response

Response Body

200 OK

Returns CheckSetQueryResult of type(s) application/json

{
	"queryId": "string",
	"resources": [
		{
			"checkSets": [
				{
					"checkSetId": "string",
					"checkSetName": "string",
					"checkSetType": "string"
				}
			],
			"domain": {
				"domainId": "string",
				"domainName": "string",
				"domainType": "MANAGEMENT"
			},
			"extraContext": {},
			"resourceId": "string",
			"resourceName": "string",
			"resourceType": "string",
			"resourceVersion": "string"
		}
	]
}

string

queryId Required

Id of the query, to be provided in the selection API

array of CheckSetQueryResourceResult

resources Required

Resources with check-sets result from the query

Errors

Error

400

Bad Request

Error

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"checkSetType":"UPGRADE"}' https://sfo-vcf01.rainpole.io/v1/system/check-sets/queries

vcf

What's changed in 5.0.0?

INTRODUCED

Check Sets Operations

get

Get Last Assessment Run Info Introduced

get

Get Result Introduced

post

Query Check Sets Introduced

post

Trigger Check Run Introduced

patch

Trigger Partial Retry Of Check Run Introduced

Query Check Sets

Request

URL

Request Body

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

What's changed in 5.0.0?

On This Page

Check Sets Operations

Was this page helpful?