Unregister VCF

Unregister VCF

NOTE: The un-registration of some of the VCs under the VCF may fail because of different issues, e.g. connection issue. In such cases response will be returned with http 200 status code, however the failed resources id's will be reported in the response body. Please check the status field of the response after executing this API, in order to make sure that the operation has fully succeeded.

Request
URI
PUT
https://{api_host}/suite-api/api/integrations/vcf/{integrationId}/unregister
COPY
Path Parameters
string
integrationId
Required

The identifier of the VCF integration in UUID format.


Authentication
This operation uses the following authentication methods.
Responses
200

Successfully registered vcf

Returns VcfRegistrationResult of type(s) application/json
"{\n  \"failedVcenterIds\" : [ \"6340a629-2973-4d76-a647-96097334e0b5\", \"aae7bb66-64e6-4ef4-9682-66db419da791\", \"7484040e-3fab-4a7d-9be7-10d4057211a3\" ],\n  \"status\" : \"PARTIALLY_SUCCEEDED\"\n}"
array of string
failedVcenterIds
Optional

Set of VCF VC ids for which registration update failed.

string
status
Optional

Indicates VCF registration result status

Possible values are : SUCCEEDED, PARTIALLY_SUCCEEDED, FAILED,

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' https://{api_host}/suite-api/api/integrations/vcf/{integrationId}/unregister