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

Trigger Check Run

Description

Trigger a run of the selected checks

Request

URL

post

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

Copy

Request Body

CheckSetRunInput of type(s) application/json Required

Check-set selection for resources

Show optional properties

{
	"queryId": "string",
	"resources": [
		{
			"resourceId": "string",
			"resourceName": "string",
			"resourceType": "string"
		}
	]
}

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

string

queryId Required

Id of the query the selection was based on

array of CheckSetResourceSelection

resources Required

Information about the resource and its selection

Response

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, COMPLETED_WITH_WARNING, SKIPPED",
    "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

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"queryId":"string","resources":[{"checkSets":[{"checkSetId":"string"}],"domain":{"domainId":"string","domainName":"string","domainType":"MANAGEMENT"},"resourceId":"string","resourceName":"string","resourceType":"string"}]}' https://sfo-vcf01.rainpole.io/v1/system/check-sets

vcf-for-vxrail

What's changed in latest?

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

Trigger Check Run

Request

URL

Request Body

Response

Response Body

202 Accepted

Errors

Code Samples

cURL Command

What's changed in latest?

On This Page

Check Sets Operations

Was this page helpful?