---
title: "Exposing Your Logs to Third-Party Tools via the OpenSearch API"
description: "Learn how you can use third-party software that integrates with OpenSearch."
url: https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/integration-opensearch
lang: en
---
> For AI agents: the complete documentation index is available at https://docs.us.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.us.ovhcloud.com/en/llms-full.txt.

# Exposing Your Logs to Third-Party Tools via the OpenSearch API

**Learn how you can use third-party software that integrates with OpenSearch.**

As explained in our [introductory documentation](https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/introduction-to-logs-data-platform.md), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work.

 

## Instructions

### What is a Log Data Platform alias

As explained in the documentation mentioned above, a Logs Data Platform _alias_ is a virtual OpenSearch _index_. You can attach multiple _indices_ **OR** multiple log _streams_ to an _alias_ (but not a mix of _indices_ and _streams_). In both cases, _aliases_ are read-only.

 

### Alias for log streams

#### Logs exposition

When attached to _streams_, an _alias_ allows you to expose the content of your _streams_ exactly as if they were stored in a single OpenSearch _index_. This feature can be used only for read/query purposes.

 

#### Logs ingestion

If you want to ingest logs to a _stream_ using the OpenSearch API, we have a mutualized input that works as a special _alias_ that is pre-configured for this purpose and accessible to any Logs Data Platform user. You can follow [this documentation](https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/mutualized-inputs-opensearch-api.md) to use it. This specific _alias_ is write-only instead of read-only.

 

#### Creating an alias

To create an _alias_ in the management interface, go to the _alias_ tab of your Logs Data Platform account and click `+ Add an alias`.

Choose a name, add a description, and click `Save`.

Once your alias is created, you can use the _more options_ `...` button to manage it.

From this menu, you can:

1. Edit the description for the alias.
2. Attach and detach _streams_ and/or _indices_ to the alias.
3. Access the alias via OpenSearch's web UI.
4. Delete the alias.

 

#### Third-party tool configuration

To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few pieces of information:

- A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://<your_cluster>.logs.ovh.com:9200`.

- An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like this: `<ldp_service_name>-a-<alias_name>`.

- A user: the Logs Data Platform service name associated with the index (the same as the one you use to connect to Graylog).

- A password: same as above.

 

#### Use cases

We currently have specific documentation illustrating the usage of _aliases_ in three cases:

- Using our managed OpenSearch Dashboards instances to visualize logs [here](https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/opensearch-dashboards.md).
- Using Grafana to visualize logs [here](https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/using-grafana-with-logs.md).
- Using ElastAlert to set up alerting on logs [here](https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/elastalert.md).

 

### Alias for OpenSearch _indices_

If you use a single [managed OpenSearch index as a service](https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/index-as-a-service.md), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple _indices_ to an _alias_. In that case, the creation of an _alias_ and configuration of your third-party software follow the same steps as described above.

 

### Alias access management

Like most features of Logs Data Platform, aliases can be shared with other Logs Data Platform users, using [this documentation](https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/iam-migration.md). Due to their nature, they can only be shared in read-only mode.

 

## Go further

Browse all the [Logs Data Platform guides](https://docs.us.ovhcloud.com/en/manage-and-operate/logs-data-platform/landing-page-logs-data-platform.md).

Browse the rest of the [OVHcloud US documentation](https://docs.us.ovhcloud.com/en/index.md) for guides on our other products and services.

Learn more about [Logs Data Platform](https://us.ovhcloud.com/identity-security-operations/logs-data-platform/) on the OVHcloud US website.