Generate a Logstash API key

Base URL: https://{kibana_url}

POST /api/fleet/logstash_api_keys

Generate an API key for Logstash to use with a Fleet output.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Responses

Successful response

application/json

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/logstash_api_keys

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/logstash_api_keys" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The generated Logstash API key

{
  "api_key": "TiNAGG4BaaMdaH1tRfuU:KnR6yE41RrSowb0kQ0HWoA"
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}