Skip to main content

getConfiguredIntegrations

This method allows you to get a list of all the integrations configured on a specific company under the Integrations hub.

Parameters

Parameter

Description

Included in request

Type

Values

companyID

The ID of the company that you want to retrieve configurations for.

Optional

String

The user making the request must have Network administrator rights for The company the ID belongs to.

Default value: The ID of the company associated with the API key used for the request.

General parameters

These are common parameters, available across all public API methods.

Parameter

Description

Included in request

Type

Values

id

This parameter adds an identifier to the request, linking it to its corresponding response.

The target replies with the same value in the response, allowing easy call tracking.

Mandatory

String

No additional requirements

method

The name of the method you are using to send the request.

Mandatory

String

Must be a valid method name.

jsonrpc

The version of JSON-RPC used by the request and the response.

Mandatory

Integer

Possible values:

  • 2.0

params

An object containing the configuration of the request.

Mandatory

Object

No additional requirements.

Under the params object

page

The results page number.

Optional

Integer

Default value: 1

perPage

The number of results displayed per page.

Optional

Integer

The upper limit is 100 items per page.

Default value: 30

Return value

Attribute

Type

Description

total

Integer

Indicates the total number of integrations configured on the targeted company.

data

Array of objects

A list of objects providing details for each integration.

Objects

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 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 - License usage 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

The type of integration.

Possible values:

  • 1 - VMs and Templates

  • 2 - Hosts and Clusters.

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.

Email Protection

Boolean

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

Email Protection integrations are used to detect and prevent phishing, spam, malware, and other email-based threats.

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": "getConfiguredIntegrations",
  "id": "f197ade6-c4b3-4378-9076-11dccaeebdd6",
  "jsonrpc": "2.0",
  "params": {
    "companyId": "679b694c5dd72429d20a72c3"
  }
}

Response:

{
  "id": "f197ade6-c4b3-4378-9076-11dccaeebdd6",
  "jsonrpc": "2.0",
  "result": {
    "data": [
      {
        "id": "679b6952a5d00afed203cbd7",
        "name": "integrationI4n6dw9O5y0szQDIMpv1",
        "type": 1,
        "specifics": {
          "hostname": "XhYqpld4GW.com",
          "port": 443,
          "username": "username",
          "viewType": 1,
          "retryAuthentication": true,
          "retryAuthenticationTimeToWait": 5,
          "retryAuthenticationMaxAttempts": 3,
          "verifyTLSCertificate": true
        },
        "category": {
          "virtualization": true,
          "directoryServices": true
        },
        "company": {
          "id": "679b694c5dd72429d20a72c3",
          "name": "GetConfiguredIntegrations1738238284.468232BHk5q6E9V2"
        },
        "status": 3
      }
    ],
    "total": 1,
    "page": 1,
    "perPage": 30
  }
}
In this section: