Skip to main content

getIntegrationDetails

Use this method to request information about an integration configured under the Integrations hub.

Parameters

Parameter

Description

Included in request

Type

Values

integrationId

The ID of the integration you want to get information for.

Mandatory

String

No additional requirements.

Return value

Attribute

Type

Description

success

Boolean

Indicates if the request was successful.

data

Object

Contains the information related to the integration.

data

Attribute

Type

Description

id

String

The ID of the integration.

name

String

The name of the integration.

type

Integer

The type of the integration.

Possible values:

  • 1 - VMware Integration

specifics

Object

The configuration settings of the integration.

category

Object

Contains the categories associated with the integration.

For more information, refer to category.

company

Object

Contains information regarding the company where the integration was configured.

status

Integer

The status of the integration at the time of the request.

Possible values:

  • 0 - Not licensed

  • 1 - Available

  • 2 - Stopped

  • 3 - Action required

  • 4 - Pending

  • 5 - Active

  • 6 - Error

  • 7 - Usage limit reached

specifics

Attribute

Type

Description

hostname

String

The IP or hostname of the integrated vCenter server.

port

Integer

The port used to connect to vCenter.

username

String

The username used for vCenter authentication.

retryAuthentication

Boolean

Indicates if the integration retries authentication on failure.

retryAuthenticationTimeToWait

Integer

Time in seconds between authentication retries.

retryAuthenticationMaxAttempts

Integer

The maximum number of authentication retry attempts allowed.

verifyTLSCertificate

Boolean

Specifies if the TLS certificate is verified when connecting to the vCenter server.

viewType

Integer

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.

category

Attribute

Type

Description

Backup

Boolean

Indicates if the integration is categorized under the Backup category.

Backup integrations are used to perform regular data backups and help protect against data loss, corruption, or ransomware attacks.

Directory Services

Boolean

Indicates if the integration is categorized under the Directory Services category.

Directory Services integrations are used to manage user identity and access through centralized systems like Active Directory or LDAP.

Inventory Management

Boolean

Indicates if the integration is categorized under the Inventory Management category.

Inventory Management integrations are used to track and manage IT assets, including hardware, software, and system configurations.

Virtualization

Boolean

Indicates if the integration is categorized under the Virtualization category.

Virtualization integrations are used to create, manage, and monitor virtual machines and virtual environments.

Cloud Protection

Boolean

Indicates if the integration is categorized under the Cloud Protection category.

Cloud Protection integrations are used to secure cloud-based infrastructure, SaaS platforms, and cloud-stored data.

Security Training

Boolean

Indicates if the integration is categorized under the Security Training category.

Security Training integrations are used to deliver cybersecurity awareness programs that help educate users and reduce human risk.

company

Attribute

Type

Description

id

String

The ID of the company.

name

String

The name of the company.

Example

Request:

{
  "method": "getIntegrationDetails",
  "id": "2f7cc8ea-8023-4cab-805c-3efd73a916ca",
  "jsonrpc": "2.0",
  "params": {
    "integrationId": "678f89ef8fe5bb14010b3242"
  }
}

Response:

{
  "id": "2f7cc8ea-8023-4cab-805c-3efd73a916ca",
  "jsonrpc": "2.0",
  "result": {
    "success": true,
    "data": {
      "id": "678f89ef8fe5bb14010b3242",
      "name": "integrationn9Hz9I2mTevE9XYCGlGx",
      "type": 1,
      "specifics": {
        "hostname": "X27BW0GeDW.com",
        "port": 443,
        "username": "QIcaqC3Lze",
        "retryAuthentication": true,
        "retryAuthenticationTimeToWait": 5,
        "retryAuthenticationMaxAttempts": 3,
        "verifyTLSCertificate": true,
        "viewType": 1
      },
      "category": {
        "virtualization": true,
        "directoryServices": true
      },
      "company": {
        "id": "678f89e69ae7b0840a00b2ea",
        "name": "GetIntegrationDetails1737460198.7133234BqrRK40SBK"
      },
      "status": 3
    }
  }
}
In this section: