Get Security project link candidates

Base URL
https://api.elastic-cloud.com
  • GET /api/v1/serverless/projects/security/{id}/link-candidates
Auth

The response contains the list of projects which can be linked to the specified Security project in a cross-project search configuration.

Path parameters

id string · pattern: ^[a-z0-9]{32}$ required

The ID of the project

Query parameters

types enum[]

One or more types of projects to return as link candidates.

Values: elasticsearch observability security vectordb
csp string

The Cloud Service Provider to filter the link candidate projects by.

region string

The region to filter the link candidate projects by.

name string

The project name to filter the link candidates by.

alias string

The project alias to filter the link candidates by.

tags map string to string · min properties: 1 · max properties: 64

If specified, the result will be filtered to only those projects that have the specified tags and corresponding values.

Example: {"tags[environment]":"production","tags[team]":"team-a"}
<string> string · min length: 1 · max length: 128 · pattern: ^[a-z0-9][a-z0-9_-]*$

Responses

The requested link candidate projects

application/json
items object[] required

The linked candidates.

id string · pattern: ^[a-z0-9]{32}$ required

ID of the project.

name string · min length: 1 · max length: 255 required

Descriptive name for a project.

alias string · min length: 1 · max length: 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.

type enum required

The type of the linked project

Values: elasticsearch observability security vectordb
csp string required
region string required

Unique human-readable identifier for a region in Elastic Cloud.

tags map string to string · min properties: 1 · max properties: 64 required

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.

<string> string · min length: 1 · max length: 128 · pattern: ^[a-z0-9][a-z0-9_-]*$
linked boolean required

Indicates whether the project is already linked to the requesting project.

Not Found

application/json
errors object[] required
message string required

A human-readable message of the error.

code string required

An identifier for this type of error.

Base URL
https://api.elastic-cloud.com