List source maps - RUM

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GEThttps://api.datadoghq.com/api/v2/sourcemaps/listhttps://api.us3.datadoghq.com/api/v2/sourcemaps/listhttps://api.us5.datadoghq.com/api/v2/sourcemaps/listhttps://api.datadoghq.eu/api/v2/sourcemaps/listhttps://api.ap1.datadoghq.com/api/v2/sourcemaps/listhttps://api.ap2.datadoghq.com/api/v2/sourcemaps/listhttps://api.uk1.datadoghq.com/api/v2/sourcemaps/listhttps://api.ddog-gov.com/api/v2/sourcemaps/listhttps://api.us2.ddog-gov.com/api/v2/sourcemaps/list

Présentation

Retrieves a paginated list of source maps. Send filters as query parameters, not in a JSON request body. mapkind defaults to js.

For JavaScript source maps, choose one of the three request shapes below.

Examples: the following commands use the US1 API host. Replace the host with the API host for your site, and the service, version, debug ID, and cursor with values from your organization. Use --get so curl sends the filters in the query string; -X GET with --data-urlencode sends them in the request body instead.

1. List by service and version

Provide both filter[service] and filter[version] to search source maps indexed by service and version. Omit search_by.

Pagination: prefer cursor pagination. Omit page[after] and page[number] on the first request. To get the next page, pass meta.page.next_cursor as page[after], keeping the same filters. Continue until meta.page.has_more_results is false. Do not decode or modify the cursor. Legacy page-number pagination is also supported, starting at page[number]=1.

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "mapkind=js" \
  --data-urlencode "filter[service]=my-web-service" \
  --data-urlencode "filter[version]=1.0.0" \
  --data-urlencode "page[size]=10"

2. Find a specific JavaScript debug ID

Provide filter[debug_id] with a UUID. Service and version filters are not required. Omit search_by.

Pagination: the lookup returns at most one result, so no pagination is needed. page[after] is not supported.

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "mapkind=js" \
  --data-urlencode "filter[debug_id]=00000000-0000-4000-8000-000000000001"

3. Browse source maps indexed by debug ID

Set search_by=debug_id without specifying a debug ID. Do not send service, version, or filename filters in this mode.

Pagination: this mode requires cursor pagination; page[number] is not supported. Omit page[after] on the first request. To get the next page, pass meta.page.next_cursor as page[after], keeping the same search mode and filters. Continue until meta.page.has_more_results is false. Do not decode or modify the cursor.

First page:

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "mapkind=js" \
  --data-urlencode "search_by=debug_id" \
  --data-urlencode "page[size]=10"

curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
  --data-urlencode "mapkind=js" \
  --data-urlencode "search_by=debug_id" \
  --data-urlencode "page[size]=10" \
  --data-urlencode "page[after]=<meta.page.next_cursor>"

For other map kinds, use page[number], starting at 1.

This endpoint requires the rum_apps_read permission.

Arguments

Chaînes de requête

Name

Type

Description

search_by

enum

Set to debug_id to browse JavaScript source maps indexed by debug ID. Only supported for mapkind=js. Omit for service/version searches or a specific filter[debug_id] lookup. In debug-ID browse mode, service, version, and filename filters are not supported.

Allowed enum values: debug_id

mapkind

enum

The type of source map. Defaults to js.

Allowed enum values: js, jvm, ios, react, flutter, elf, ndk, il2cpp, wasm, portable_pdb

page[after]

string

Cursor for the next page of a JavaScript listing. Use the value from meta.page.next_cursor and keep the same search mode and filters. Omit on the first request. Not supported for other map kinds or for a specific filter[debug_id] lookup without search_by=debug_id.

page[size]

integer

The number of results per page. Defaults to 100. Must be at least 1; values above 1000 are capped at 1000.

Default: 100

page[number]

integer

Legacy page number, starting from 1. Prefer page[after] for JavaScript listings. Not supported with search_by=debug_id. Other map kinds default to page 1 when pagination parameters are omitted.

filter[service]

array

Filter by service names (multiple values allowed). Required for jvm, react, and flutter map kinds. Also required for js unless searching by filter[debug_id] or browsing with search_by=debug_id.

filter[version]

array

Filter by version values (multiple values allowed). Required for jvm, react, and flutter map kinds. Also required for js unless searching by filter[debug_id] or browsing with search_by=debug_id.

filter[variant]

array

Filter by variant values (multiple values allowed). Supported for jvm.

filter[id]

array

Filter by source map ID values (multiple values allowed). Supported for all map kinds.

filter[build_id]

array

Filter by build ID values (multiple values allowed). Supported for jvm, ndk, il2cpp, wasm, and portable_pdb.

filter[uuid]

array

Filter by UUID values (multiple values allowed). Supported for ios.

filter[platform]

array

Filter by platform values (multiple values allowed). Supported for react.

filter[build_number]

array

Filter by build number values (multiple values allowed). Supported for react.

filter[bundle_name]

array

Filter by bundle name values (multiple values allowed). Supported for react.

filter[arch]

array

Filter by architecture values (multiple values allowed). Supported for flutter, elf, and ndk.

filter[symbol_source]

array

Filter by symbol source values (multiple values allowed). Supported for elf.

filter[origin]

array

Filter by origin values (multiple values allowed). Supported for elf.

filter[origin_version]

array

Filter by origin version values (multiple values allowed). Supported for elf.

filter[filename]

string

Filter by filename (single value). Supported for js, elf, ndk, wasm, and portable_pdb.

filter[debug_id]

string

Filter by a single debug ID in UUID format. Supported for js and react. For js, the lookup returns at most one result and does not require service/version filters. For react, service/version filters remain required.

filter[gnu_build_id]

string

Filter by GNU build ID (single value). Supported for elf.

filter[go_build_id]

string

Filter by Go build ID (single value). Supported for elf.

filter[file_hash]

string

Filter by file hash (single value). Supported for elf.

Réponse

Response containing a paginated list of source maps.

Champ

Type

Description

data [required]

[<oneOf>]

List of source map data objects.

Object 1

object

JavaScript source map data object.

Object 2

object

React Native source map data object.

Object 3

object

iOS dSYM source map data object.

Object 4

object

JVM (ProGuard/R8) mapping file data object.

Object 5

object

Flutter symbol file data object.

Object 6

object

ELF symbol file data object.

Object 7

object

Android NDK symbol file data object.

Object 8

object

IL2CPP mapping file data object.

Object 9

object

WebAssembly symbol file data object.

Object 10

object

Portable PDB file data object.

meta

object

Pagination metadata for the source maps list response.

{
  "data": [
    {
      "attributes": {
        "absolute_path": "/js/bundle.min.js",
        "blob_storage_sourcemap_path": "org123/1.0.0/bundle.min.js.map",
        "build_id": "abc123",
        "created_at": "2024-01-01T00:00:00Z",
        "debug_id": "00000000-0000-4000-8000-000000000001",
        "domain": "example.com",
        "file_name": "bundle.min.js",
        "mapkind": "js",
        "service": "my-web-service",
        "size": 1024,
        "variant": "release",
        "version": "1.0.0",
        "version_code": "100"
      },
      "id": "5",
      "type": "sourcemaps"
    }
  ],
  "meta": {
    "page": {
      "has_more_results": false,
      "next_cursor": "string",
      "total_filtered_count": 100
    }
  }
}

Bad Request

API error response.

Champ

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Request Entity Too Large

API error response.

Champ

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Champ

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Internal Server Error

API error response.

Champ

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Exemple de code

List source maps

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Required query arguments
export search_by="debug_id"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/sourcemaps/list?search_by=${search_by}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"