Esper pipelines_Target Runs API

openapi: 3.2.0
info:
  title: ESPER API REFERENCE pipelines_Target Runs API
  x-logo:
    url: esper-logo-white.svg
    backgroundColor: '#141418'
    altText: Logo
  description: '# Introduction

    Welcome to Esper’s API documentation. The Esper API allows users to accomplish operations outside of the console. Some common uses for our APIs include observing device information and console activity, installing and updating apps, uploading files, and sending files to devices. Our users have also used the API to automate app updates, perform bulk actions, and more. Esper API endpoints use REST-based architecture and return JSON responses. See our documentation for:


    * Getting started guides

    * Commonly used API examples

    * API command examples

    * Automated Script examples

    * And more


    # Authentication


    You need to create an API Key to interact with our APIs. Learn more about generating an API Key. You can also learn more about Esper and sign up for an account at esper.io/signup. Some endpoints also require an Enterprise ID. This ID can be found in the API Management section of the Esper console. # Lifecycle Labels


    Esper uses lifecycle labels to communicate the support status of each API endpoint. Use the following table to understand what each label means and how to respond. Badge

    What it means

    Recommended action


    Stable

    This endpoint is fully supported and safe for production use. No action needed. Beta

    This endpoint is publicly available but may change. It is not recommended for production integrations. Use with caution. Monitor the API changelog for updates before relying on this endpoint. Legacy

    This endpoint uses an older architecture and is still supported, but a newer equivalent exists. It is not recommended for new integrations. Plan migration to the recommended replacement when possible. See the endpoint description for the alternative. Deprecated

    This endpoint has stopped being supported. A removal date may be added at a later time. A replacement is available or the feature is entirely retired. Migrate before the removal date listed in the endpoint description. Do not use this endpoint in new integrations. # Pagination


    Responses may be paginated. Use the following parameters to query the data. A full list of parameters can be found on the endpoint’s documentation page. Parameter

    Data Type

    Explanation


    limit

    integer

    Limit the data returned. Default = 20. offset

    integer

    Offset to the first item returned. Default = 0. ordering

    string

    Order the results set by the field name. Varies by endpoint. next

    string

    Paginate to the next response set. previous

    string

    Paginate to the last set response. # Errors

    We use standard HTTP status codes for success or failure. A typical error response may look something like this:


    ```json

    {

    "errors": [],

    "message": "error message",

    "status": 400

    }

    ```

    * `errors` - List of error details

    * `message` - Error description

    * `status` - HTTP status code


    Some common status codes and messages are:


    Number

    Message

    Explanation


    200

    OK

    The request succeeded. 201

    Resource creation

    A resource was created. 401

    Unauthorized

    The API key is invalid. 404

    Not found

    The resource was not found. 429

    Rate limit exceeded

    Too many requests. Wait a moment and try again. 500

    Server error

    Internal error. Wait a moment and try again. If the issue persists, contact Esper. See how our systems are doing by checking our status page. # Rate Limits

    To ensure quality of service for all customers, we enforce rate limits for API requests. Most customers won’t hit this limit with normal use. In case you experience 429 or rate limit exceeded errors, we recommend the following:

    * Try sending requests in batches. * Begin with about 20 requests at a time and building up from there. * Ensure your scripts are efficient and don’t contain redundant calls. * Reach out to your account manager to discuss your options.'
  termsOfService: https://esper.io/terms-of-service
  contact:
    email: developer@esper.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
  x-prefix-tag: esper cloud api
servers:
- url: https://{foo}-api.esper.cloud/api
  variables:
    foo:
      default: develop
      description: Custom end point
tags:
- name: pipelines_Target Runs
  description: 'APIs to manage Target Runs. Target run status descriptions

    * PENDING - Target run created.

    * QUEUED - Target run queued for processing.

    * PROCESSING - Target run received by scheduler for processing (During target run processing the command request for the target run is created).

    * DISPATCHED - Target run moves to dispatched when a command is successfully queued for the target run. (Command status - QUEUED)

    * RUNNING - Target run moves to running state when the command has been sent to the device (Command status - INITIATED, ACKNOWLEDGED, INPROGRESS)

    * COMPLETE - Target run moves to complete state when it has completed running (Command status - FAILURE, SUCCESS, TIMEOUT, CANCELLED)

    * SUCCESS - A completed target run moves to success when the associated command is successful (Command status - SUCCESS)

    * FAILURE - A completed target run moves to success when the associated command is unsuccessful (Command status - FAILED, TIMEOUT, CANCELLED)

    * CANCELLED - Target run cancelled by the user (Target runs ind Pending, Queued and Processing state can be cancelled by the user)

    * TIMEOUT - The target run has a timed out. This happens when the target run has not completed processing even after the timeout period (7 days).

    * INVALID - Target run is invalid.'
  x-displayName: Target Runs
paths:
  /pipelines/v0/stageruns/{stage_run_id}/targetruns/:
    get:
      description: 'Retrieves all Target Runs for a Stage Run.


        Returns the device-level execution records for the specified Stage Run, showing the per-device outcome of that stage, with optional filters by status and operation.


        **About Target Runs**

        A Target Run is the execution record of one device (Target) within a Stage Run — this is where per-device success/failure detail lives, since a single stage typically acts on many devices at once.


        **Key Fields / Query Parameters**

        - `stage_run_id` — UUID of the Stage Run to list Target Runs for

        - `status` — Optional filter by Target Run status

        - `stage_run_operation_id` — Optional filter to a specific executed Operation

        - `ordering` — Field to sort results by'
      x-badges:
      - name: Stable
        color: green
      summary: Get all Target Runs for the Stage Run
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: getPipelineStageTargetRuns
      tags:
      - pipelines_Target Runs
      parameters:
      - name: stage_run_id
        in: path
        description: Stage run Id
        required: true
        schema:
          type: string
      - name: status
        in: query
        description: Status of target run
        schema:
          type: string
          enum:
          - pending
          - queued
          - processing
          - dispatched
          - running
          - complete
          - success
          - failure
          - cancelled
          - invalid
          - timeout
      - name: stage_run_operation_id
        in: query
        description: Stage run Operation Id to filter on
        schema:
          type: string
          format: uuid
      - name: ordering
        in: query
        description: Sorting target runs based on status field
        schema:
          type: string
          enum:
          - status
          - -status
      responses:
        '200':
          description: All Target runs for the Stage Run
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    type: object
                    properties:
                      count:
                        type: integer
                      previous:
                        type: string
                      next:
                        type: string
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/pipelines_TargetRun'
        '401':
          description: Target run get error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
    post:
      description: 'Creates a new Target Run for a Stage Run.


        Adds a device-level execution record to the specified Stage Run, identifying the Target (device) that the stage should now also act on. Not recommended for pipelines that are currently running.


        **About Target Runs**

        A Target Run is the execution record of one device (Target) within a Stage Run. Creating one directly is an advanced operation, typically used to add a device to an in-progress or newly created stage run outside of the normal automatic scoping from the stage''s Target Lists.


        **Key Fields / Query Parameters**

        - `stage_run_id` — UUID of the Stage Run to add the Target Run to

        - `target_id` — UUID of the Target (device entry) this run applies to

        - `device_name` — Display name of the device

        - `device_alias` — Display alias of the device'
      x-badges:
      - name: Stable
        color: green
      summary: Create a Target Runs for Stage Run
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: createPipelineStageTargetRuns
      tags:
      - pipelines_Target Runs
      parameters:
      - name: stage_run_id
        in: path
        description: Stage run Id
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipelines_TargetRun_POST'
      responses:
        '200':
          description: Created Target Runs
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    type: array
                    items:
                      $ref: '#/components/schemas/pipelines_TargetRun'
        '401':
          description: Target Run create error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
  /pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/:
    get:
      description: 'Retrieves a single Target Run''s details.


        Returns the full record for one device-level Target Run, identified by target_run_id within the specified Stage Run.


        **About Target Runs**

        A Target Run is the execution record of one device (Target) within a Stage Run. This single-record endpoint is the detail view behind the Target Run list.


        **Key Fields / Query Parameters**

        - `stage_run_id` — UUID of the parent Stage Run

        - `target_run_id` — UUID of the specific Target Run to retrieve'
      x-badges:
      - name: Stable
        color: green
      summary: Get Target Run by Target Run ID
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: getPipelineStageTargetRun
      tags:
      - pipelines_Target Runs
      parameters:
      - name: stage_run_id
        in: path
        description: Stage run Id
        required: true
        schema:
          type: string
      - name: target_run_id
        in: path
        description: Id of the Target Run
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Get target run
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_TargetRun'
        '401':
          description: Operation get error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
    put:
      description: 'Updates the status of a Target Run.


        Sets the status (and optionally device_name) of the specified Target Run, typically used to manually intervene in a single device''s execution within a stage. Only Cancelled is supported.


        **About Target Runs**

        A Target Run is the execution record of one device (Target) within a Stage Run. Manual status updates are generally reserved for exceptional cases, since Target Run status otherwise reflects the underlying device command''s real progress.


        **Key Fields / Query Parameters**

        - `target_run_id` — UUID of the Target Run to update

        - `status` — New status — cancelled'
      x-badges:
      - name: Stable
        color: green
      summary: Update a Target Run
      operationId: updatePipelineStageTargetRun
      tags:
      - pipelines_Target Runs
      security:
      - pipelines_SCAPIAuthToken: []
      parameters:
      - name: stage_run_id
        in: path
        description: Stage run Id
        required: true
        schema:
          type: string
      - name: target_run_id
        in: path
        description: Id of the target run
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipelines_TargetRun_PUT'
      responses:
        '200':
          description: Updated Target Run run information
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_TargetRun'
        '400':
          description: Target Run update error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_400_Bad_Data'
        '401':
          description: Target Run update error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
  /pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/:
    get:
      description: 'Retrieves the device command status for a Target Run.


        Returns the status and details of the underlying device command that was dispatched for this Target Run, since a Target Run''s execution is ultimately carried out via a command sent to the device.


        **About Target Run Command**

        Each Target Run corresponds to a command dispatched to a device. This endpoint exposes that command''s live status, which is the most granular level of detail available for troubleshooting why a specific device''s stage execution succeeded or failed.


        **Key Fields / Query Parameters**

        - `stage_run_id` — UUID of the parent Stage Run

        - `target_run_id` — UUID of the Target Run whose command status you want'
      x-badges:
      - name: Stable
        color: green
      summary: Get status of the command running for Target run
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: getTargetRunCommandStatus
      tags:
      - pipelines_Target Runs
      parameters:
      - name: stage_run_id
        in: path
        description: ID of the stage run
        required: true
        schema:
          type: string
      - name: target_run_id
        in: path
        description: Id of the target run
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Command processor request status
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_CommandResponse'
        '401':
          description: Command request create error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
    post:
      description: 'Issues the device command processor request for a Target Run.


        Triggers dispatch of the underlying device command associated with this Target Run, typically as part of the pipeline engine''s normal execution flow.


        **About Target Run Command**

        Each Target Run corresponds to a command dispatched to a device. This endpoint creates that command-processor request; it is primarily used internally by the pipeline execution flow rather than called ad hoc.


        **Key Fields / Query Parameters**

        - `stage_run_id` — UUID of the parent Stage Run

        - `target_run_id` — UUID of the Target Run to dispatch a command for'
      x-badges:
      - name: Stable
        color: green
      summary: Create an command processor request for Target Run
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: createTargetRunCommand
      tags:
      - pipelines_Target Runs
      parameters:
      - name: stage_run_id
        in: path
        description: ID of the stage run
        required: true
        schema:
          type: string
      - name: target_run_id
        in: path
        description: Id of the target run
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipelines_AndroidCommandRequest'
      responses:
        '200':
          description: Created command processor request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_CommandResponse'
        '401':
          description: Command request create error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
  /pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/{command_id}/:
    put:
      description: 'Updates a Target Run''s device command, currently supporting cancellation.


        Sets the request_status of the specified command to cancelled, stopping further execution of that device-level command.


        **About Target Run Command**

        Each Target Run corresponds to a command dispatched to a device. This endpoint is the mechanism for cancelling that command mid-flight, most commonly used to stop a stuck or unwanted device operation without waiting for it to time out.


        **Key Fields / Query Parameters**

        - `stage_run_id` — UUID of the parent Stage Run

        - `target_run_id` — UUID of the Target Run

        - `command_id` — UUID of the specific command to update

        - `request_status` — Currently only supports the value cancelled'
      x-badges:
      - name: Stable
        color: green
      summary: Update target run command information
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: putTargetRunCommandStatus
      tags:
      - pipelines_Target Runs
      parameters:
      - name: stage_run_id
        in: path
        description: ID of the stage run
        required: true
        schema:
          type: string
      - name: target_run_id
        in: path
        description: Id of the target run
        required: true
        schema:
          type: string
      - name: command_id
        in: path
        description: Id of the command
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipelines_CommandRequest_PUT'
      responses:
        '200':
          description: Command processor request status
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_CommandResponse'
        '400':
          description: Target run command update error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_400_Bad_Data'
components:
  schemas:
    pipelines_AndroidCommandRequest:
      type: object
    pipelines_TargetRun_POST:
      type: object
      properties:
        target_id:
          type: string
          format: uuid
        device_name:
          type: string
        device_alias:
          type: string
      required:
      - target_id
    pipelines_TargetRun_PUT:
      type: object
      properties:
        status:
          type: string
          enum:
          - pending
          - queued
          - processing
          - dispatched
          - running
          - complete
          - success
          - failure
          - cancelled
          - invalid
        device_name:
          type: string
    pipelines_Error_401_Unauthorized:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 401
        message:
          type: string
        content:
          type: object
      required:
      - code
      - message
    pipelines_CommandRequest_PUT:
      type: object
      properties:
        request_status:
          type: string
          enum:
          - cancelled
    pipelines_CommandResponse:
      type: object
      properties:
        target_run_id:
          type: string
          format: uuid
        operation_id:
          type: string
          format: uuid
        enterprise_id:
          type: string
          format: uuid
        command:
          type: string
        command_type:
          type: string
          default: DEVICE
        device_type:
          type: string
          default: all
        device_id:
          type: string
          format: uuid
        schedule:
          type: string
          default: IMMEDIATE
        args:
          type: object
        request_id:
          type: string
          format: uuid
        request_status:
          type: string
        request_status_reason:
          type: string
    pipelines_TargetRun:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        target_id:
          type: string
          format: uuid
        device_id:
          type: string
          format: uuid
        device_alias:
          type: string
          format: uuid
        stage_run_id:
          type: string
          format: uuid
        stage_run_operation_id:
          type: string
          format: uuid
        command_id:
          type: string
        command_status:
          type: string
        command_meta:
          type: object
        status:
          type: string
          enum:
          - pending
          - queued
          - processing
          - dispatched
          - running
          - complete
          - success
          - failure
          - cancelled
          - timeout
          - invalid
        created_by:
          type: number
          format: int32
        updated_by:
          type: number
          format: int32
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        started_at:
          type: string
          format: date-time
        ended_at:
          type: string
          format: date-time
    pipelines_Error_400_Bad_Data:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 400
        message:
          type: string
        content:
          type: object
      required:
      - code
      - message
  securitySchemes:
    esper_cloud_api_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    pipelines_SCAPIAuthToken:
      type: http
      scheme: bearer
    device_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    apps_management_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    commands_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    drift_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    device_onboarding_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    tenant_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    foundation_AuthToken:
      type: apiKey
      in: header
      name: Authorization
    reports_bearerAuth:
      type: http
      scheme: bearer
    geofence_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/esper/refs/heads/main/openapi/esper-pipelines-target-runs-api-openapi.yml