Measure Builds API

Upload build sizes, build mappings and Over-The-Air patch mappings.

GitHub OpenAPI

Operations 2

PUT /builds Upload build info and mappings #
PUT /builds/ota Upload Over-The-Air patch mappings #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/measure-sh:measure-sh-builds-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

measure-sh-builds-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Measure SDK Builds API
  version: 1.0.0
  description: 'Reference for the Measure SDK ingestion REST API. Events, builds, config,

    attachments, traces and authentication.


    All endpoints authenticate with a Measure API key sent as a bearer token

    in the `Authorization` header:


    ```

    Authorization: Bearer

    ```


    Endpoints:


    - **PUT `/events`**: send a batch of events, spans, attachments, metrics and traces.

    - **PUT `/builds`**: send build mappings and build sizes.

    - **PUT `/builds/ota`**: send Over-The-Air patch mappings (CodePush, Shorebird) keyed by `patch_id`.

    - **GET `/config`**: fetch the latest SDK configuration for the app.'
servers:
- url: https://{host}
  description: 'Measure ingestion server. Use the API URL configured for your app in the Measure dashboard; self-hosted deployments use their own origin.

    '
  variables:
    host:
      default: your-measure-instance.example
      description: Hostname of the Measure deployment's ingestion endpoint.
- url: http://localhost:8085
  description: Self-hosted Measure ingestion origin (local default)
security:
- measureApiKey: []
tags:
- name: Builds
  description: Upload build sizes, build mappings and Over-The-Air patch mappings.
paths:
  /builds:
    put:
      operationId: putBuilds
      tags:
      - Builds
      summary: Upload build info and mappings
      description: 'Measure will use build information like mapping files and build sizes

        uploaded via this API for deobfuscation and to track app size changes.


        This API only accepts the build metadata and does not actually upload the

        files. It returns pre-signed URLs for uploading the files directly to the

        returned URLs. For uploading the files, you can issue a standard http request

        using cURL or any other way, using the `upload_url` as the URL and `headers`

        as the headers for the upload request.


        Usage notes:


        - Putting `build_size` for the same `version_name`, `version_code` and

        `build_type` combination replaces the last size with the latest size.

        - Depending on the platform, `build_type` can be `aab`, `apk` for Android or

        `ipa` for iOS.

        - Depending on the platform, mapping `type` can be `proguard` for Android,

        `dsym` or `elf_debug` for iOS, or `jsbundle` for React Native.

        - `mappings` is optional. When the `mappings` array is not present, only the

        build size information will be updated.

        - Each mapping file for iOS must be a gzipped tarball of `dSYM` bundles

        ending with a `.tgz` file extension.

        - For React Native, upload the JS bundle and its sourcemap as two separate

        `jsbundle` mappings in the same request, not bundled together. Each must be

        a gzipped tarball ending with `.tgz`, wrapping a single inner file: one

        `.tgz` containing the minified JS bundle (for example `main.jsbundle` for

        iOS, `index.android.bundle` for Android) and a second `.tgz` containing the

        matching sourcemap (for example `main.jsbundle.map`,

        `index.android.bundle.map`). Symbolication pairs the two server-side via

        the inner filename''s `.map` suffix, so the inner filenames must follow the

        `` / `.map` convention.

        - For Over-The-Air patches (for example CodePush for React Native, Shorebird

        for Flutter), use PUT `/builds/ota` instead.

        - For mapping filename, only provide the filename, not a path.

        - When `mappings` is present, the server returns a mappings array containing

        the pre-signed URL for uploading each mapping file.

        - Each pre-signed mapping file upload URL has an expiry set which is the same

        as the `expires_at` field.

        - Each mapping also contains a `headers` object containing all the header

        keys and values that should be added in the file upload request. Make sure

        all the headers are included in the file upload request, otherwise your

        file upload request will fail.

        - File upload requests must use the PUT http method. Example:


        ```sh

        curl -X PUT \

        --header ''x-amz-meta-mapping_id: 77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc'' \

        --header ''x-amz-meta-original_file_name: somefile.tgz'' \

        --data-binary @/path/to/somefile.tgz \


        ```'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 'App version info, build info and optional build mapping info.

                '
              required:
              - version_name
              - version_code
              - build_size
              - build_type
              properties:
                version_name:
                  type: string
                  description: Version name of the build. Like "1.0".
                version_code:
                  type: string
                  description: Version code of the build. Like "999".
                build_size:
                  type: integer
                  description: Size of app in bytes. Must be greater than zero.
                build_type:
                  type: string
                  enum:
                  - aab
                  - apk
                  - ipa
                  description: 'Type of the build. `aab` or `apk` for Android, `ipa` for iOS.

                    '
                mappings:
                  type: array
                  description: List of mapping file objects.
                  items:
                    type: object
                    required:
                    - type
                    - filename
                    properties:
                      type:
                        type: string
                        enum:
                        - proguard
                        - dsym
                        - elf_debug
                        - jsbundle
                        description: Type of the mapping file.
                      filename:
                        type: string
                        description: Filename of the mapping file.
            example:
              version_name: '1.0'
              version_code: '10'
              build_size: 10241024
              build_type: ipa
              mappings:
              - type: dsym
                filename: DemoApp.app.dSYM.tgz
              - type: elf_debug
                filename: app.symbols
              - type: jsbundle
                filename: main.jsbundle.tgz
              - type: jsbundle
                filename: main.jsbundle.map.tgz
      responses:
        '200':
          description: 'Build info uploaded. When the request contains mappings, the response contains a `mappings` array with a pre-signed upload URL for each mapping file; otherwise an acknowledgement is returned.

            '
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Response for a request without mappings.
                  required:
                  - ok
                  properties:
                    ok:
                      type: string
                - type: object
                  description: Response for a request with mappings.
                  required:
                  - mappings
                  properties:
                    mappings:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            description: Id of the mapping.
                          type:
                            type: string
                            description: Type of the mapping file.
                          filename:
                            type: string
                            description: Filename of the mapping file.
                          upload_url:
                            type: string
                            description: 'Pre-signed URL to upload the mapping file to, using an HTTP PUT request.

                              '
                          expires_at:
                            type: string
                            format: date-time
                            description: Expiry time of the pre-signed URL.
                          headers:
                            type: object
                            description: 'Headers that must be included in the file upload request.

                              '
                            additionalProperties:
                              type: string
              examples:
                withoutMappings:
                  summary: Request without mappings
                  value:
                    ok: build info updated
                withMappings:
                  summary: Request with mappings
                  value:
                    mappings:
                    - id: e2bbcad8-0566-44ea-af43-9dd114c64e8c
                      type: dsym
                      filename: DemoApp.app.dSYM.tgz
                      upload_url: http://localhost:9119/msr-symbols-sandbox/incoming/428f4448-080f-42d2-8b16-c74671a603a9.tgz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&x-id=PutObject
                      expires_at: '2025-08-13T01:59:45.577889184Z'
                      headers:
                        x-amz-meta-mapping_id: e2bbcad8-0566-44ea-af43-9dd114c64e8c
                        x-amz-meta-original_file_name: DemoApp.app.dSYM.tgz
                    - id: 77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc
                      type: elf_debug
                      filename: app.symbols
                      upload_url: http://localhost:9119/msr-symbols-sandbox/incoming/77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc.tgz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&x-id=PutObject
                      expires_at: '2025-08-13T01:59:45.577980476Z'
                      headers:
                        x-amz-meta-mapping_id: 77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc
                        x-amz-meta-original_file_name: app.symbols
        '400':
          description: 'Request body is malformed or does not meet one or more acceptance criteria. Check the `error` field for more details.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: string
        '401':
          description: Either the Measure API key is not present or has expired.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '404':
          description: No app found for this API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '413':
          description: Build/mapping file size exceeded maximum allowed limit.
        '429':
          description: 'Rate limit has exceeded. Retry request respecting the `Retry-After` response header.

            '
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: string
        '500':
          description: 'Measure server encountered an unfortunate error. Report this to your server administrator.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '503':
          description: 'Measure server is temporarily unavailable. Retry request respecting the `Retry-After` response header.

            '
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: string
  /builds/ota:
    put:
      operationId: putOtaBuilds
      tags:
      - Builds
      summary: Upload Over-The-Air patch mappings
      description: 'Uploads mapping files for an Over-The-Air (OTA) patch, a remote update that

        ships new code without a new store build (for example CodePush for React

        Native, Shorebird for Flutter). It is driven by a `patch_id` (a UUID) and

        takes no app version, build number or build size.


        Like PUT `/builds`, this API accepts metadata and returns pre-signed URLs

        for uploading the mapping files directly. Upload each file with a standard

        HTTP PUT using the returned `upload_url` and `headers`.


        Usage notes:


        - `patch_id` is required and must be a UUID. Tag your OTA patch with a UUID;

        it is echoed back on each mapping in the response.

        - `patch_version` is optional. Set it to the human-facing version of the

        patch (max 256 characters); it is echoed back on each mapping in the

        response.

        - The app is determined from your API key. Do not send an app identifier in

        the body.

        - `mappings` is required and must contain at least one mapping. Mapping

        `type` can be `proguard`, `dsym`, `elf_debug`, or `jsbundle` (React

        Native).

        - For React Native, upload the JS bundle and its sourcemap as two separate

        `jsbundle` mappings in the same request (same tarball and

        `` / `.map` conventions as PUT `/builds`).

        - For mapping filename, only provide the filename, not a path.

        - Each pre-signed URL expires at `expires_at`, and includes a `headers`

        object whose entries must all be added to the upload request, otherwise it

        will fail.

        - File upload requests must use the PUT http method.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: The `patch_id` and at least one mapping.
              required:
              - patch_id
              - mappings
              properties:
                patch_id:
                  type: string
                  format: uuid
                  description: UUID identifier for the OTA patch.
                patch_version:
                  type: string
                  maxLength: 256
                  description: 'Optional human-facing version of the OTA patch. Free-form text. Not used for symbolication.

                    '
                mappings:
                  type: array
                  minItems: 1
                  description: 'List of mapping file objects (at least one). Same shape as the PUT `/builds` mappings.

                    '
                  items:
                    type: object
                    required:
                    - type
                    - filename
                    properties:
                      type:
                        type: string
                        enum:
                        - proguard
                        - dsym
                        - elf_debug
                        - jsbundle
                        description: Type of the mapping file.
                      filename:
                        type: string
                        description: Filename of the mapping file.
            example:
              patch_id: 550e8400-e29b-41d4-a716-446655440000
              patch_version: 1.4.2-patch.3
              mappings:
              - type: jsbundle
                filename: main.jsbundle.tgz
              - type: jsbundle
                filename: main.jsbundle.map.tgz
      responses:
        '200':
          description: 'OTA mappings accepted; pre-signed upload URLs returned. The response contains a `mappings` array with the pre-signed upload URL for each mapping file. Each mapping echoes back the request''s `patch_id` and `patch_version` (when sent).

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  mappings:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Id of the mapping.
                        type:
                          type: string
                          description: Type of the mapping file.
                        filename:
                          type: string
                          description: Filename of the mapping file.
                        upload_url:
                          type: string
                          description: 'Pre-signed URL to upload the mapping file to, using an HTTP PUT request.

                            '
                        expires_at:
                          type: string
                          format: date-time
                          description: Expiry time of the pre-signed URL.
                        headers:
                          type: object
                          description: 'Headers that must be included in the file upload request.

                            '
                          additionalProperties:
                            type: string
                        patch_id:
                          type: string
                          format: uuid
                          description: The request's `patch_id`, echoed back.
                        patch_version:
                          type: string
                          description: 'The request''s `patch_version`, echoed back. Omitted when not sent.

                            '
              example:
                mappings:
                - id: e2bbcad8-0566-44ea-af43-9dd114c64e8c
                  type: jsbundle
                  filename: main.jsbundle.tgz
                  upload_url: http://localhost:9119/msr-symbols-sandbox/incoming/e2bbcad8-0566-44ea-af43-9dd114c64e8c.tgz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&x-id=PutObject
                  expires_at: '2025-08-13T01:59:45.577889184Z'
                  headers:
                    x-amz-meta-mapping_id: e2bbcad8-0566-44ea-af43-9dd114c64e8c
                    x-amz-meta-original_file_name: main.jsbundle.tgz
                  patch_id: 550e8400-e29b-41d4-a716-446655440000
                  patch_version: 1.4.2-patch.3
                - id: 77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc
                  type: jsbundle
                  filename: main.jsbundle.map.tgz
                  upload_url: http://localhost:9119/msr-symbols-sandbox/incoming/77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc.tgz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&x-id=PutObject
                  expires_at: '2025-08-13T01:59:45.577980476Z'
                  headers:
                    x-amz-meta-mapping_id: 77ac8159-9f0e-4cc7-a9f1-60c05fccd4dc
                    x-amz-meta-original_file_name: main.jsbundle.map.tgz
                  patch_id: 550e8400-e29b-41d4-a716-446655440000
                  patch_version: 1.4.2-patch.3
        '400':
          description: 'Request body is malformed or is missing `patch_id`/`mappings`. Check the `error` field for more details.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: string
        '401':
          description: Either the Measure API key is not present or has expired.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '404':
          description: No app found for this API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '413':
          description: Mapping file size exceeded maximum allowed limit.
        '429':
          description: 'Rate limit has exceeded. Retry request respecting the `Retry-After` response header.

            '
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: string
        '500':
          description: 'Measure server encountered an unfortunate error. Report this to your server administrator.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '503':
          description: 'Measure server is temporarily unavailable. Retry request respecting the `Retry-After` response header.

            '
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: string
components:
  securitySchemes:
    measureApiKey:
      type: http
      scheme: bearer
      description: 'Measure API key for the app, sent as `Authorization: Bearer <api-key>`.

        The app is determined from the API key.

        '