Upload a source map

Base URL: https://{kibana_url}

POST /api/apm/sourcemaps
POST /s/{space_id}/api/apm/sourcemaps

Auth

Upload a source map for a specific service and version. You must have all Kibana privileges for the APM and User Experience feature. The maximum payload size is 1mb. If you attempt to upload a source map that exceeds the maximum payload size, you will get a 413 error. Before uploading source maps that exceed this default, change the maximum payload size allowed by Kibana with the server.maxPayload variable.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

elastic-api-version enum · default: 2023-10-31 required: The version of the API to use; Values: 2023-10-31
kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

bundle_filepath string required: The absolute path of the final bundle as used in the web application.
service_name string required: The name of the service that the service map should apply to.
service_version string required: The version of the service that the service map should apply to.
sourcemap string · format: binary required: The source map. It can be a string or file upload. It must follow the source map format specification.

Responses

Successful response

application/json

body string
compressionAlgorithm string: Compression Algorithm
created string: Created date
decodedSha256 string: Decoded SHA-256
decodedSize number: Decoded size
encodedSha256 string: Encoded SHA-256
encodedSize number: Encoded size
encryptionAlgorithm string: Encryption Algorithm
id string: Identifier
identifier string: Identifier
packageName string: Package name
relative_url string: Relative URL
type string: Type

Bad Request response

application/json

Unauthorized response

application/json

Forbidden response

application/json

Internal Server Error response

application/json

Not Implemented response

application/json

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

An example of a multipart/form-data request body for POST /api/apm/sourcemaps. Each field is a separate form part; sourcemap is the source map file content (typically uploaded as a file).

curl Shell

curl -X POST "http://localhost:5601/api/apm/sourcemaps" \
-H 'Content-Type: multipart/form-data' \
-H 'kbn-xsrf: true' \
-H 'Authorization: ApiKey ${YOUR_API_KEY}' \
-F 'service_name="foo"' \
-F 'service_version="1.0.0"' \
-F 'bundle_filepath="/test/e2e/general-usecase/bundle.js"' \
-F 'sourcemap="{\"version\":3,\"file\":\"static/js/main.chunk.js\",\"sources\":[\"fleet-source-map-client/src/index.css\",\"fleet-source-map-client/src/App.js\",\"webpack:///./src/index.css?bb0a\",\"fleet-source-map-client/src/index.js\",\"fleet-source-map-client/src/reportWebVitals.js\"],\"sourcesContent\":[\"content\"],\"mappings\":\"mapping\",\"sourceRoot\":\"\"}"' 

Request

Request example

{
  "bundle_filepath": "/test/e2e/general-usecase/bundle.js.map",
  "service_name": "opbeans-node",
  "service_version": "1.0.0",
  "sourcemap": "{\u0022version\u0022:3,\u0022sources\u0022:[\u0022bundle.js\u0022],\u0022names\u0022:[],\u0022mappings\u0022:\u0022AAAA\u0022,\u0022file\u0022:\u0022bundle.js\u0022,\u0022sourcesContent\u0022:[\u0022console.log(\u0027hello\u0027);\u0022]}"
}

Response

A successful response from POST /api/apm/sourcemaps.

{
  "body": "eJyFkL1OwzAUhd/Fc\u002BMbYMuCEBIbHRjKgBgc96R16tiWr1OQqr47NwqJxEK3q/PzWccXxchnZ7E1A1SjuhjVZtF2yOxiEPlO17oWox3D3uPFeSRTjmJQARfCPeiAgGx8NTKsYdAc1T3rwaSJGcds8Sp3c1HnhfywUZ3QhMTFFGepZxqMC9oex3CS9tpk1XyozgOlmoVKuJX1DqEQZ0su7PGtLU\u002BV/3JPKc3cL7TJ2FNDRPov4bFta3MDM4f7W69lpJjLO9qdK8bzVPhcJz3HUCQ4LbO/p5hCSC4cZPByrp/wFqOklbpefwAhzpqI",
  "compressionAlgorithm": "zlib",
  "created": "2021-07-09T20:47:44.812Z",
  "decodedSha256": "644fd5a997d1ddd90ee131ba18e2b3d03931d89dd1fe4599143c0b3264b3e456",
  "decodedSize": 441,
  "encodedSha256": "024c72749c3e3dd411b103f7040ae62633558608f480bce4b108cf5b2275bd24",
  "encodedSize": 237,
  "encryptionAlgorithm": "none",
  "id": "apm:foo-1.0.0-644fd5a997d1ddd90ee131ba18e2b3d03931d89dd1fe4599143c0b3264b3e456",
  "identifier": "foo-1.0.0",
  "packageName": "apm",
  "relative_url": "/api/fleet/artifacts/foo-1.0.0/644fd5a997d1ddd90ee131ba18e2b3d03931d89dd1fe4599143c0b3264b3e456",
  "type": "sourcemap"
}

{
  "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": "Internal Server Error",
  "message": "An internal server error occurred. Check the Kibana server logs for details.",
  "statusCode": 500
}

{
  "error": "Not Implemented",
  "message": "Not Implemented",
  "statusCode": 501
}