Skip to main content

updateIntegration

Use this method to update an integration configured under the Integrations hub.

Parameters

Parameter

Description

Included in request

Type

Values

integrationId

The ID of the integration you want to update.

Mandatory

String

No additional requirements.

name

The new name for the integration.

Optional

String

No additional requirements.

specifics

The configuration settings for the integration.

Optional

Object

Refer to speficics.

Objects

speficics

Parameter

Description

Included in request

Type

hostname

The IP or hostname of the vCenter server you want to update.

Optional

String

port

The port used to connect to the target of the integration.

Default value: 443

Optional

Integer

username

The username to be used for authentication.

Optional

String

password

The password to be used for authentication.

Optional

String

retryAuthentication

Determines if the integration should retry authentication on failure.

Default value: true.

Optional

Boolean

retryAuthenticationTimeToWait

Time in seconds to wait between authentication retries.

Default value: 5

Optional

Integer

retryAuthenticationMaxAttempts

The maximum number of authentication retry attempts allowed.

Default value: 3

Optional

Integer

verifyTLSCertificate

Specifies whether to verify the TLS certificate when connecting to the vCenter server.

Default value: true.

Optional

Boolean

viewType

Defines the view mode for vCenter.

Possible values:

  • 1 - VMs and Templates

  • 2 - Hosts and Clusters.

Default value: 1

Note

Using any invalid value will result in the default value being used.

Optional

Integer

Return value

Attribute

Type

Description

result

Object

Contains the result of the request.

Objects

result

Attribute

Type

Description

success

Boolean

Indicates if the request was successful.

Example

Request:

{
  "method": "updateIntegration",
  "id": "7125364d-f7da-4660-870e-793f2af1941a",
  "jsonrpc": "2.0",
  "params": {
    "integrationId": "6788dd3aae9178700406b8ca",
    "name": "edited05M353Nwh9Dn9BbCkSoD",
    "specifics": {
      "hostname": "K6Qxish1dN.com",
      "port": 555,
      "username": "updated_username",
      "password": "updated_password",
      "retryAuthentication": false,
      "retryAuthenticationTimeToWait": 6,
      "retryAuthenticationMaxAttempts": 4,
      "verifyTLSCertificate": false,
      "viewType": 1
    }
  }
}

Response:

{
  "id": "7125364d-f7da-4660-870e-793f2af1941a",
  "jsonrpc": "2.0",
  "result": {
    "success": true
  }
}
In this section: