Get the status of an Elasticsearch project

GET /api/v1/serverless/projects/elasticsearch/{id}/status

The response indicates whether the project is initialized and ready to be used. The phase will change from "initializing" to "initialized" when the project is ready.

Path parameters

  • id string Required

    The ID of the project

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

Responses

  • 200 application/json

    The requested Elasticsearch project status

    Hide response attribute Show response attribute object
    • phase string Required

      Current phase of the project:

      • initializing: the project is still being created and is not ready for use yet
      • initialized: the project has been created successfully and is ready for use

      Values are initializing or initialized.

  • 404 application/json

    Not Found

    Hide response attribute Show response attribute object
    • errors array[object] Required
      Hide errors attributes Show errors attributes object
      • message string Required

        A human-readable message of the error.

      • code string Required

        An identifier for this type of error.

GET /api/v1/serverless/projects/elasticsearch/{id}/status
curl \
 -X GET https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/{id}/status
Response examples (200)
{
  "phase": "initializing"
}
Response examples (404)
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}