Save APM server schema

deprecated

Server: https://{kibana_url}

POST /api/apm/fleet/apm_server_schema
POST /s/{space_id}/api/apm/fleet/apm_server_schema

Refer to Spaces for more information.

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.

Request

schema object: Schema object

Responses

Successful response

application/json

Bad Request response

application/json

Unauthorized response

application/json

Forbidden response

application/json

Not found response

application/json

Examples

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

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X POST "https://{kibana_url}/api/apm/fleet/apm_server_schema" \
  -H "elastic-api-version: string" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "schema": {
    "foo": "bar"
  }
}'

Response

{}

{
  "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
}