Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
summary: Create an ingest API key for a Managed Inputs pipeline
method_request: POST /_security/api_key
description: >
Run `POST /_security/api_key` to create an API key for ingesting data into a specific Managed Inputs pipeline.
The `ingest` application privilege controls access to the Elastic Cloud Managed OTLP (mOTLP) endpoint.
The `pipeline:` resource prefix scopes the key to a named pipeline.
To allow access to all pipelines, use `"resources": ["*"]` or omit the `role_descriptors` field entirely.
# type: request
value: |-
{
"name": "fleet_agent_policy_123-api-key",
"expiration": "1d",
"role_descriptors": {
"motlp_pipeline_write_role": {
"applications": [
{
"application": "ingest",
"privileges": ["write"],
"resources": ["pipeline:.fleet_agent_policy_1"]
}
]
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# summary:
description: A successful response from `POST /_security/api_key`.
# type: response
# response_code: 200
value: |-
{
"id": "VuaCfGcBCdbkQm-e5aOx",
"name": "fleet_agent_policy_123-api-key",
"expiration": 1544068612110,
"api_key": "ui2lp2axTNmsyakw9tvNnw",
"encoded": "VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw=="
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
summary: Check ingest application privileges for a Managed Inputs pipeline
method_request: GET /_security/user/_has_privileges
description: >
Run `GET /_security/user/_has_privileges` to check whether the current user has write access to a specific
Managed Inputs pipeline. The Elastic Cloud Managed OTLP (mOTLP) endpoint performs this check to authorize
client API keys before accepting telemetry data.
# type: request
value: |-
{
"application": [
{
"application": "ingest",
"privileges": ["write"],
"resources": ["pipeline:.fleet_agent_policy_1"]
}
]
}
Loading