# Public Cloud › Analytics › OpenSearch › Integrations API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Public Cloud product's sections: https://developers.eu.ovhcloud.com/reference/public-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 4 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/opensearch/integrations/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/public-cloud/analytics/opensearch/integrations.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/public-cloud/analytics/opensearch/integrations.json?format=openapi3

## Operations

- `GET /publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration` — List integrations
- `GET /publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}` — Get an integration
- `POST /publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration` — Create an integration
- `DELETE /publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}` — Delete an integration

## List integrations

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/opensearch/integrations/#get-publiccloud-project-projectid-managedanalytics-opensearch-serviceid-integration

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/opensearch/integration/get`

Returns the integrations of the service with other services.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.Integration[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `destinationServiceId` | string (uuid) | read-only | Identifier of the destination service. Null for external integrations. |
| `id` | string (uuid) | read-only | Unique identifier of the integration |
| `parameters` | object | read-only | Engine-specific configuration parameters for the integration |
| `sourceServiceId` | string (uuid) | read-only | Identifier of the source service |
| `status` | publicCloud.database.IntegrationStatusEnum | read-only | Current readiness status of the integration — one of `CREATING`, `DELETING`, `ERROR`, `READY`, `UPDATING` |
| `type` | publicCloud.database.IntegrationTypeEnum | read-only | Type of the integration — one of `GRAFANA_DASHBOARD`, `GRAFANA_DATASOURCE`, `KAFKA_CONNECT`, `KAFKA_LOGS`, `KAFKA_MIRROR_MAKER`, `OPENSEARCH_LOGS`, `POSTGRESQL_METRICS`, `PROMETHEUS`, `RSYSLOG` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
[
  {
    "checksum": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "destinationServiceId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "parameters": {
      "key": "string"
    },
    "sourceServiceId": "00000000-0000-0000-0000-000000000000",
    "status": "CREATING",
    "type": "GRAFANA_DASHBOARD",
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration");

print_r($result);
?>
```

## Get an integration

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/opensearch/integrations/#get-publiccloud-project-projectid-managedanalytics-opensearch-serviceid-integration-integrationid

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/opensearch/integration/get`

Returns the integration type, its source and destination services and its status.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `integrationId` | path | string (uuid) | yes | Integration ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.Integration | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `destinationServiceId` | string (uuid) | read-only | Identifier of the destination service. Null for external integrations. |
| `id` | string (uuid) | read-only | Unique identifier of the integration |
| `parameters` | object | read-only | Engine-specific configuration parameters for the integration |
| `sourceServiceId` | string (uuid) | read-only | Identifier of the source service |
| `status` | publicCloud.database.IntegrationStatusEnum | read-only | Current readiness status of the integration — one of `CREATING`, `DELETING`, `ERROR`, `READY`, `UPDATING` |
| `type` | publicCloud.database.IntegrationTypeEnum | read-only | Type of the integration — one of `GRAFANA_DASHBOARD`, `GRAFANA_DATASOURCE`, `KAFKA_CONNECT`, `KAFKA_LOGS`, `KAFKA_MIRROR_MAKER`, `OPENSEARCH_LOGS`, `POSTGRESQL_METRICS`, `PROMETHEUS`, `RSYSLOG` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "destinationServiceId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "parameters": {
    "key": "string"
  },
  "sourceServiceId": "00000000-0000-0000-0000-000000000000",
  "status": "CREATING",
  "type": "GRAFANA_DASHBOARD",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}");

print_r($result);
?>
```

## Create an integration

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/opensearch/integrations/#post-publiccloud-project-projectid-managedanalytics-opensearch-serviceid-integration

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/opensearch/integration/create`

Integrates the service with another database or analytics service. sourceServiceId must be the identifier of this service. Compatible engine pairs are listed on the capabilities endpoint.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Request body (required)

Type: `publicCloud.database.IntegrationCreation`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `destinationServiceId` | string (uuid) | yes | Identifier of the destination service. Compatible source and destination engine pairs can be retrieved from the capabilities endpoint. |
| `parameters` | object |  | Engine-specific configuration parameters for the integration |
| `sourceServiceId` | string (uuid) | yes | Identifier of the source service |
| `type` | publicCloud.database.IntegrationTypeEnum | yes | Type of the integration — one of `GRAFANA_DASHBOARD`, `GRAFANA_DATASOURCE`, `KAFKA_CONNECT`, `KAFKA_LOGS`, `KAFKA_MIRROR_MAKER`, `OPENSEARCH_LOGS`, `POSTGRESQL_METRICS`, `PROMETHEUS`, `RSYSLOG` |

```json
{
  "destinationServiceId": "00000000-0000-0000-0000-000000000000",
  "parameters": {
    "key": "string"
  },
  "sourceServiceId": "00000000-0000-0000-0000-000000000000",
  "type": "GRAFANA_DASHBOARD"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.Integration | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `destinationServiceId` | string (uuid) | read-only | Identifier of the destination service. Null for external integrations. |
| `id` | string (uuid) | read-only | Unique identifier of the integration |
| `parameters` | object | read-only | Engine-specific configuration parameters for the integration |
| `sourceServiceId` | string (uuid) | read-only | Identifier of the source service |
| `status` | publicCloud.database.IntegrationStatusEnum | read-only | Current readiness status of the integration — one of `CREATING`, `DELETING`, `ERROR`, `READY`, `UPDATING` |
| `type` | publicCloud.database.IntegrationTypeEnum | read-only | Type of the integration — one of `GRAFANA_DASHBOARD`, `GRAFANA_DATASOURCE`, `KAFKA_CONNECT`, `KAFKA_LOGS`, `KAFKA_MIRROR_MAKER`, `OPENSEARCH_LOGS`, `POSTGRESQL_METRICS`, `PROMETHEUS`, `RSYSLOG` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "destinationServiceId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "parameters": {
    "key": "string"
  },
  "sourceServiceId": "00000000-0000-0000-0000-000000000000",
  "status": "CREATING",
  "type": "GRAFANA_DASHBOARD",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.database.IntegrationCreation
result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration",
	destinationServiceId = None, # Identifier of the destination service. Compatible source and destination engine pairs can be retrieved from the capabilities endpoint. (type: string)
	parameters = None, # Engine-specific configuration parameters for the integration (type: object, nullable)
	sourceServiceId = None, # Identifier of the source service (type: string)
	type = None, # Type of the integration (type: publicCloud.database.IntegrationTypeEnum)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.database.IntegrationCreation
$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration", array(
	destinationServiceId => null, // Identifier of the destination service. Compatible source and destination engine pairs can be retrieved from the capabilities endpoint. (type: string)
	parameters => null, // Engine-specific configuration parameters for the integration (type: object, nullable)
	sourceServiceId => null, // Identifier of the source service (type: string)
	type => null, // Type of the integration (type: publicCloud.database.IntegrationTypeEnum)
));

print_r($result);
?>
```

## Delete an integration

`DELETE /v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/opensearch/integrations/#delete-publiccloud-project-projectid-managedanalytics-opensearch-serviceid-integration-integrationid

**Status:** Beta version  
**IAM actions:** `publicCloudProject:apiovh:analytics/opensearch/integration/delete`

Deletes the integration.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `integrationId` | path | string (uuid) | yes | Integration ID |
| `projectId` | path | string | yes | Project ID |
| `serviceId` | path | string (uuid) | yes | Service ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.database.Integration | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the resource used for concurrency control |
| `createdAt` | string (date-time) | read-only | Date at which the resource was created |
| `destinationServiceId` | string (uuid) | read-only | Identifier of the destination service. Null for external integrations. |
| `id` | string (uuid) | read-only | Unique identifier of the integration |
| `parameters` | object | read-only | Engine-specific configuration parameters for the integration |
| `sourceServiceId` | string (uuid) | read-only | Identifier of the source service |
| `status` | publicCloud.database.IntegrationStatusEnum | read-only | Current readiness status of the integration — one of `CREATING`, `DELETING`, `ERROR`, `READY`, `UPDATING` |
| `type` | publicCloud.database.IntegrationTypeEnum | read-only | Type of the integration — one of `GRAFANA_DASHBOARD`, `GRAFANA_DATASOURCE`, `KAFKA_CONNECT`, `KAFKA_LOGS`, `KAFKA_MIRROR_MAKER`, `OPENSEARCH_LOGS`, `POSTGRESQL_METRICS`, `PROMETHEUS`, `RSYSLOG` |
| `updatedAt` | string (date-time) | read-only | Date of the last update to the resource |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "destinationServiceId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "parameters": {
    "key": "string"
  },
  "sourceServiceId": "00000000-0000-0000-0000-000000000000",
  "status": "CREATING",
  "type": "GRAFANA_DASHBOARD",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/v2/publicCloud/project/{projectId}/managedAnalytics/opensearch/{serviceId}/integration/{integrationId}");

print_r($result);
?>
```