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

Supportbundles

Description

Initiates Support bundle download

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/system/support-bundles

Copy

Request Body

SupportBundleSpec of type(s) application/json Required

supportbundlespec

{
	"logs": {
		"apiLogs": false,
		"esxLogs": false,
		"nsxLogs": false,
		"sddcManagerLogs": false,
		"systemDebugLogs": false,
		"vcLogs": false,
		"vmScreenshots": false,
		"vraLogs": false,
		"vrliLogs": false,
		"vropsLogs": false,
		"vrslcmLogs": false,
		"vxrailManagerLogs": false,
		"wcpLogs": false
	},
	"options": {
		"config": {
			"force": false,
			"skipKnownHostCheck": false
		},
		"include": {
			"healthCheck": false,
			"summaryReport": false
		}
	},
	"scope": {
		"domains": [
			{
				"clusterNames": [
					"string"
				],
				"domainName": "string"
			}
		],
		"includeFreeHosts": false
	}
}

Logs

logs Optional

Logs of different components.

SupportBundleOption

options Optional

Sos options for support bundle collection.

SupportBundleScope

scope Optional

Domain and cluster under which logs should be collected.

Response

Response Body

200 OK returns SupportBundle of type(s) application/json

{
	"bundleAvailable": "string",
	"bundleName": "string",
	"completionTimestamp": "string",
	"creationTimestamp": "string",
	"description": "string",
	"id": "string",
	"status": "string"
}

string

bundleAvailable Optional

Indicate if bundle is available in file system.

string

bundleName Optional

Name of the Support Bundle.

string

completionTimestamp Optional

CompletionTimestamp.

string

creationTimestamp Optional

CreationTimestamp.

string

description Optional

Name of the Operation.

string

id Optional

Id of the Support Bundle task.

string

status Optional

Support Bundle Status.

Errors

Error

400

Bad request! Invalid Headers or Data. Error: {error}

Error

401

Bad request! Authorization Header is missing or not in correct format.

Error

409

Operation is in progress for Id {id}. Wait for the operation to complete.

Error

500

Something went wrong. Internal server error occurred. Error {error}

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"logs":{"apiLogs":false,"esxLogs":false,"nsxLogs":false,"sddcManagerLogs":false,"systemDebugLogs":false,"vcLogs":false,"vmScreenshots":false,"vraLogs":false,"vrliLogs":false,"vropsLogs":false,"vrslcmLogs":false,"vxrailManagerLogs":false,"wcpLogs":false},"options":{"config":{"force":false,"skipKnownHostCheck":false},"include":{"healthCheck":false,"summaryReport":false}},"scope":{"domains":[{"clusterNames":["string"],"domainName":"string"}],"includeFreeHosts":false}}' https://sfo-vcf01.rainpole.io/v1/system/support-bundles

vcf

SOS Operations

get

Gethealthsummary

get

Gethealthsummarytasks

get

Getsupport Bundle

get

Getsupport Bundle Tasks

post

Health Summary

get

Healthsummarydata

get

Support Bundledata

post

Supportbundles

Supportbundles

Request

URL

Request Body

Response

Response Body

Errors

Code Samples

cURL Command

On This Page

SOS Operations

Was this page helpful?