Save APM server schema
Base URL
https://{kibana_url}
POST
/api/apm/fleet/apm_server_schema
Auth
Deprecated
This endpoint is intended for internal use by Fleet integrations to push the APM Server configuration schema. Do not use for new integrations. It stores the provided schema object as a Kibana saved object. If Fleet migration is not available on the current deployment, the API returns a 404.
Expand all
The version of the API to use
Values:
2023-10-31
A required header to protect against CSRF attacks
{
}
schema
object
Schema object
message
string
Error message
statusCode
number
Error status code
message
string
Error message
statusCode
number
Error status code
message
string
Error message
statusCode
number
Error status code
message
string
Error message
statusCode
number
Error status code
Thank you for your feedback.
Base URL
https://{kibana_url}
Examples
Request
Console
1 / 2 languages
‹
›
An example request payload for POST /api/apm/fleet/apm_server_schema.
Show more
1
2
3
4
5
6
POST kbn:/api/apm/fleet/apm_server_schema
{
"schema": {
"foo": "bar"
}
}
Generated from the API spec
1
2
3
4
5
6
7
8
9
10
curl -X POST "${KIBANA_URL}/api/apm/fleet/apm_server_schema" \
-H "elastic-api-version: 2023-10-31" \
-H "kbn-xsrf: true" \
-H "Authorization: ApiKey ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"schema": {
"foo": "bar"
}
}'
Generated from the API spec
Response
An example of a successful response from POST /api/apm/fleet/apm_server_schema. The response body is intentionally empty.
Show more
An example of a 400 Bad Request response, returned when the request payload or query parameters fail validation.
Show more
An example of a 401 Unauthorized response, returned when the request is missing valid authentication credentials.
Show more
An example of a 403 Forbidden response, returned when the authenticated user lacks the required APM and User Experience privileges.
Show more
An example of a 404 Not Found response, returned when the requested resource does not exist or the feature is not available on the current deployment.
Show more
1
2
3
4
5
{
"error": "Bad Request",
"message": "[request body]: expected value of type [string] but got [undefined]",
"statusCode": 400
}
1
2
3
4
5
{
"error": "Unauthorized",
"message": "[security_exception]: missing authentication credentials for REST request",
"statusCode": 401
}
1
2
3
4
5
{
"error": "Forbidden",
"message": "Insufficient privileges to perform this action. The APM and User Experience feature requires \u0060all\u0060 privileges.",
"statusCode": 403
}
1
2
3
4
5
{
"error": "Not Found",
"message": "Not Found",
"statusCode": 404
}