Update VCF Integration

Update existing VCF integration with provided parameters

NOTE: while providing any certificate via this API, certificateDetails field must be populated.

Request

URI

PUT

https://{api_host}/suite-api/api/integrations/vcf

COPY

Query Parameters

boolean

force

Optional

Constraints: default: false

Update VCF even if connection test fails

Request Body

The VCF integration update request

VCFIntegration of type(s) application/json

Required

This request body class requires all of the following: CloudAccountIntegration , InlineVCFIntegration1

"{\n  \"id\" : \"afa3f229-b41b-43f2-934b-87f20a66fa26\",\n  \"name\" : \"TestVCFIntegration\",\n  \"description\" : \"VCF adapter for test purposes\",\n  \"collectorGroupId\" : \"a0fdd915-34ea-485e-95fe-3149c36cf1ef\",\n  \"resourceIdentifiers\" : [ {\n    \"name\" : \"SDDCManager_Hostname\",\n    \"value\" : \"SDDC_manager_hostname\"\n  }, {\n    \"name\" : \"vcf_config_limits_file_name\",\n    \"value\" : \"file_name\"\n  }, {\n    \"name\" : \"DomainMonitoringOnCreation\",\n    \"value\" : \"false\"\n  } ],\n  \"certificates\" : [ ],\n  \"credentialInstanceId\" : \"8a5b0218-edcb-4663-8e30-cd62b1aca527\",\n  \"serviceCredentialsUsed\" : false\n}"

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The model of the updated VCF integration.

Returns VCFIntegration of type(s) application/json

This response body class contains all of the following: CloudAccountIntegration , InlineVCFIntegration1

"{\n  \"id\" : \"afa3f229-b41b-43f2-934b-87f20a66fa26\",\n  \"name\" : \"TestVCFIntegration\",\n  \"description\" : \"VCF adapter for test purposes\",\n  \"collectorGroupId\" : \"a0fdd915-34ea-485e-95fe-3149c36cf1ef\",\n  \"resourceIdentifiers\" : [ {\n    \"name\" : \"SDDCManager_Hostname\",\n    \"value\" : \"SDDC_manager_hostname\"\n  }, {\n    \"name\" : \"vcf_config_limits_file_name\",\n    \"value\" : \"file_name\"\n  }, {\n    \"name\" : \"DomainMonitoringOnCreation\",\n    \"value\" : \"false\"\n  } ],\n  \"certificates\" : [ ],\n  \"credentialInstanceId\" : \"8a5b0218-edcb-4663-8e30-cd62b1aca527\",\n  \"serviceCredentialsUsed\" : false\n}"

400

If update 'VCF integration' failed. Typically the service will return extra information as to why the update failed. In case if connection testing failed due to certificates, untrusted certificates will be returned for acceptance.

Returns OneOfErrorMessage of type(s) application/json

OneOf

This class returns at least one of the following:

certificates-error

error

"{\n  \"type\" : \"CertificatesError\",\n  \"certificates\" : [ {\n    \"integrationType\" : \"VCENTER\",\n    \"certificates\" : [ {\n      \"thumbprint\" : \"certificate_thumbprint\",\n      \"certificateDetails\" : \"certificate_details\",\n      \"issuedTo\" : \"issuedTo\",\n      \"issuedBy\" : \"issuedBy\",\n      \"expires\" : \"expirationDate\"\n    } ]\n  } ],\n  \"httpStatusCode\" : 400,\n  \"apiErrorCode\" : 400,\n  \"message\" : \"No valid certificates were found, while testing connection. Returning provided untrusted certificates for acceptance.\"\n}"

422

If update 'VCF integration' failed. Typically the service will return extra information as to why the update failed.

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '}' https://{api_host}/suite-api/api/integrations/vcf

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Integrations Operations

GET

Get Integrated Services