Path parameters

• id string Required

  The ID of the project

  Format should match the following pattern: ^[a-z0-9]{32}$.

Query parameters

• types array[string]

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

  Values are elasticsearch, observability, security, or workplaceai.

• 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.

Responses

• 200 application/json

  The requested link candidate projects

  Hide response attribute Show response attribute object

  • items array[object] Required

    The linked candidates.

    Hide items attributes Show items attributes object

    • id string Required

      ID of the project.

      Format should match the following pattern: ^[a-z0-9]{32}$.

    • name string Required

      Descriptive name for a project.

      Minimum length is 1, maximum length is 255.

    • alias string Required

      A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.

      Minimum length is 1, maximum length is 50. Format should match the following pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$.

    • type string Required

      The type of the linked project

      Values are elasticsearch, observability, security, or workplaceai.

    • csp string Required
    • region string Required

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

    • tags object 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.

      Hide tags attribute Show tags attribute object

      • * string Additional properties

        Minimum length is 1, maximum length is 128. Format should match the following pattern: ^[a-z0-9][a-z0-9_-]*$.

    • linked boolean Required

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

• 404 application/json

  Not Found

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    An error response returned by the API.

    • message string Required

      A human-readable message of the error.

    • code string Required

      An identifier for this type of error.