Skip to main content

createIntegration

Use this method to create a new integration under the Integrations hub.

Parameters

Parameter

Description

Included in request

Type

Values

name

The name of the integration.

Mandatory

String

The value must be between 1 and 128 characters

type

The type of the integration.

Mandatory

Integer

Possible values:

  • 1 - VMware Integration

specifics

The configuration settings for the integration.

Mandatory

Object

Refer to specifics.

Objects

specifics

Parameter

Description

Included in request

Type

hostname

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

Mandatory

String

port

The port used to connect to vCenter.

Default value: 443

Optional

Integer

username

The username to be used for vCenter authentication.

Mandatory

String

password

The password to be used for vCenter authentication.

Mandatory

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 - Virtual Machines & Templates

  • 2 - Hosts & 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.

records

Array of strings

A list of MongoDB object IDs of the created integrations.

Example

Request:

{
  "method": "createIntegration",
  "id": "0a686101-1b31-46d3-b8ee-f59c186fa25b",
  "jsonrpc": "2.0",
  "params": {
    "companyId": "67602c8682f2caf2080d7d67",
    "name": "integrationjDAAdvXoYt77FP6Eu4O3",
    "type": 1,
    "specifics": {
      "hostname": "LMzsN5Arp7.com",
      "port": 443,
      "username": "username",
      "password": "password",
      "retryAuthentication": true,
      "retryAuthenticationTimeToWait": 10,
      "retryAuthenticationMaxAttempts": 6,
      "verifyTLSCertificate": true,
      "viewType": 2
    }
  }
}

Response:

{
  "id": "0a686101-1b31-46d3-b8ee-f59c186fa25b",
  "jsonrpc": "2.0",
  "result": {
    "success": true,
    "records": [
      "67602cbd67c92338e4028e1a"
    ]
  }
}
In this section: