Endpoints reference

edit

Endpoints reference

edit

Kibana base URL

edit

For each Elastic deployment, the Kibana base URL is the portion of the Kibana URL that precedes the path. It includes the scheme, domain name, and port. This is abbreviated to <KIBANA_BASE_URL> throughout the docs.

For an Elastic Cloud deployment, navigate to Elastic CloudDeploymentsdeployment. Next to Kibana, Choose Copy endpoint to copy the Kibana base URL to your clipboard. For example, on Cloud a Kibana base URL might look like this:

https://my-deployment.kb.europe-west1.gcp.cloud.es.io:9243

On a self-managed deployment, find the kibana.external_url setting in your Enterprise Search configuration settings. For example, a self-managed Kibana base URL might look like this:

https://localhost:5601

Alternatively, open Kibana in your browser. Remove the path from the URL. The remaining portion of the URL is the base URL.

Enterprise Search base URL

edit

For each Elastic deployment, the Enterprise Search base URL is the portion of the Enterprise Search URL that precedes the path. It includes the scheme, domain name, and port. This is abbreviated to <ENTERPRISE_SEARCH_BASE_URL> throughout the docs.

For an Elastic Cloud deployment, navigate to Elastic CloudDeploymentsdeployment. Next to Enterprise Search, Choose Copy endpoint to copy the Enterprise Search base URL to your clipboard.

For example, on Cloud, an Enterprise Search base URL might look like this:

https://my-enterprise-search-deployment.ent.europe-west1.gcp.cloud.es.io

On a self-managed deployment, find the ent_search.external_url setting in your Enterprise Search configuration settings.

For example, a self-managed Enterprise Search base URL might look like this:

http://localhost:3002

Workplace Search OAuth redirect URL

edit

In Workplace Search, when configuring a connector, it’s often necessary to specify an OAuth redirect URL.

This is also known as a redirect URI, redirect URL, callback URI, or callback URL. The process for finding this value is the same.

Construct the redirect URL using the Kibana base URL and the following path:

<KIBANA_BASE_URL>/app/enterprise_search/workplace_search/sources/added

If you are using Kibana from a non-default space in a self-managed deployment, ensure the following:

  • Make sure your kibana.external_url in your enterprise-search.yml configuration includes the space prefix in the URL
  • Make sure you are using Workplace Search from that non-default space

See Spaces for more information on Kibana Spaces.