Get agent setup info | Kibana Serverless API

Get agent setup info Beta

GET /api/fleet/agents/setup

Headers

elastic-api-version string

The version of the API to use

Value is 2023-10-31. Default value is 2023-10-31.

Responses

200 application/json; Elastic-Api-Version=2023-10-31
Hide response attributes Show response attributes object
- is_secrets_storage_enabled boolean
- is_space_awareness_enabled boolean
- isReady boolean Required
- missing_optional_features array[string] Required
  
  Value is encrypted_saved_object_encryption_key_required.
- missing_requirements array[string] Required
  
  Values are security_required, tls_required, api_keys, fleet_admin_user, or fleet_server.
- package_verification_key_id string
400 application/json; Elastic-Api-Version=2023-10-31
Hide response attributes Show response attributes object
- error string
- message string Required
- statusCode number

GET /api/fleet/agents/setup

curl \
 -X GET https://localhost:5601/api/fleet/agents/setup \
 -H "elastic-api-version: 2023-10-31"

Response examples (200)

{
  "is_secrets_storage_enabled": true,
  "is_space_awareness_enabled": true,
  "isReady": true,
  "missing_optional_features": [
    "encrypted_saved_object_encryption_key_required"
  ],
  "missing_requirements": [
    "security_required"
  ],
  "package_verification_key_id": "string"
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}