Save APM server schema

deprecated

Base URL: https://{kibana_url}

POST /api/apm/fleet/apm_server_schema

Warning

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.

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

Request body

Responses

Successful response

application/json

Bad Request response

application/json

Unauthorized response

application/json

Forbidden response

application/json

Not found response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

An example request payload for POST /api/apm/fleet/apm_server_schema.

Console Kibana Dev Tools

POST kbn:/api/apm/fleet/apm_server_schema
{
  "schema": {
    "foo": "bar"
  }
}

Generated from the API spec

curl Shell

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.

{}

{
  "error": "Bad Request",
  "message": "[request body]: expected value of type [string] but got [undefined]",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception]: missing authentication credentials for REST request",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "Insufficient privileges to perform this action. The APM and User Experience feature requires \u0060all\u0060 privileges.",
  "statusCode": 403
}

{
  "error": "Not Found",
  "message": "Not Found",
  "statusCode": 404
}

Authentication

Header parameters

Request body { }

Responses

Request body