Get Elasticsearch project link candidates
https://api.elastic-cloud.com
- GET /api/v1/serverless/projects/elasticsearch/{id}/link-candidates
The response contains the list of projects which can be linked to the specified Elasticsearch project in a cross-project search configuration.
Responses
The requested link candidate projects
-
itemsLinkedCandidateProjectrequired -
The linked candidates.
-
idstring · pattern: ^[a-z0-9]{32}$required -
ID of the project.
-
namestring · min: 1 · max: 255required -
Descriptive name for a project.
-
aliasstring · min: 1 · max: 50 · pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$required -
A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
-
typeProjectTyperequired -
The type of the linked project
-
Values:
elasticsearchobservabilitysecurityvectordb -
cspstringrequired -
regionstringrequired -
Unique human-readable identifier for a region in Elastic Cloud.
-
Tags associated with a project in the form of key-value pairs. Tags are limited to a minimum of 1 and a maximum of 64 per project. Each tag key must begin with a lowercase letter (a-z), contain only lowercase letters, digits, underscores, and hyphens (a-z0-9_-), and have a maximum length of 32 characters.
-
linkedbooleanrequired -
Indicates whether the project is already linked to the requesting project.