Esper Pipelines Operations API

openapi: 3.2.0
info:
  title: ESPER API REFERENCE Pipelines Operations 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_Operations
  description: Operations subsystem
  x-displayName: Operations
paths:
  /pipelines/v0/operationlists/{operationlist_id}/operations/:
    get:
      x-badges:
      - name: Stable
        color: green
      summary: Get all Operations in the Operation List
      description: 'Returns a paginated list of Operations belonging to a specific Operation List within a Pipeline. Use it to see all the individual operations queued or defined under one Operation List.


        Supports filtering by operation_type, and returns a count plus previous/next pagination links alongside the Operation records.


        This is the Pipelines Operations endpoint. Use the Operations API for command operations (dispatch commands).


        **About Operations**


        Esper''s Pipelines system orchestrates multi-step device operations. A Pipeline contains Stages, and each Stage can have Target Lists (Targets and/or Device Groups) and Operation Lists; an Operation List groups the individual Operations that get executed as part of a Stage. Pipeline Runs, Stage Runs, and Target Runs track execution against these definitions, with statuses including PENDING, QUEUED, PROCESSING, RUNNING, WAITING, COMPLETE, SUCCESS, FAILURE, CANCELLED, TIMEOUT (default 21 days), and INVALID.


        **Key Fields / Query Parameters**


        - operationlist_id — path parameter identifying the Operation List

        - operation_type — optional query filter to return only operations of a specific type


        **Common Use Cases**


        - Reviewing the individual operations configured under a Pipeline''s Operation List before or after a run

        - Auditing an Operation List''s contents when troubleshooting a Pipeline Run'
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: getOperationListOperations
      tags:
      - pipelines_Operations
      parameters:
      - name: operationlist_id
        in: path
        description: ID of the Operation List
        required: true
        schema:
          type: string
      - name: operation_type
        in: query
        description: Operation Type to filter on as defined in Operation_POST model
        required: false
        schema:
          type: string
      responses:
        '200':
          description: All Operations in Operation List
          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_Operation'
        '401':
          description: Operation List get error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
    post:
      x-badges:
      - name: Stable
        color: green
      summary: Create an Operation for Operation List
      description: 'Adds a new Operation to an existing Operation List in Esper''s Pipelines system.


        Send the operation_type (e.g. LOCK, REBOOT, WIPE, INSTALL, SIMPLE_INSTALL, UNINSTALL, SET_KIOSK_APP, SET_WALLPAPER) and its args in the request body; the created Operation is returned and becomes one of the actions performed when the parent Stage runs.


        This is the Pipelines Operations endpoint. Use the Operations API for command operations (dispatch commands).


        **About Operation Lists**


        An Operation List holds one or more Operations — the individual device actions a Pipeline Stage performs against its targeted devices. Grouping Operations into a list lets a single stage execute multiple actions in sequence when its Stage Run processes. This is an authenticated SCAPI endpoint.


        **Key Fields / Query Parameters**


        - operation_type — the action to perform (e.g. LOCK, REBOOT, WIPE, INSTALL, SET_KIOSK_APP, etc.)

        - args — object containing the arguments for the selected operation_type


        **Common Use Cases**


        - Adding a device action to a stage''s operation list while building out a pipeline'
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: addOperationListOperations
      tags:
      - pipelines_Operations
      parameters:
      - name: operationlist_id
        in: path
        description: ID of the Operation List
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipelines_Operation_POST'
      responses:
        '200':
          description: Created operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_Operation'
        '401':
          description: Operation create error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
  /pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/:
    get:
      x-badges:
      - name: Stable
        color: green
      summary: Get an Operation from the operation list
      description: 'Retrieves the details of a single Operation within an Operation List.


        Returns the Operation''s operation_type, args, and metadata (created_by, updated_by, created_at, updated_at) for the given operation_id.


        This is the Pipelines Operations endpoint. Use the Operations API for command operations (dispatch commands).


        **About Operation Lists**


        An Operation List holds one or more Operations — the individual device actions a Pipeline Stage performs against its targeted devices. Operations are grouped into a list so a single stage can execute multiple actions in sequence. This is an authenticated SCAPI endpoint.'
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: getOperationListOperation
      tags:
      - pipelines_Operations
      parameters:
      - name: operationlist_id
        in: path
        description: ID of the Operation list
        required: true
        schema:
          type: string
      - name: operation_id
        in: path
        description: ID of the Operation
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Get operation from operation list
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_Operation'
        '401':
          description: Operation get error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
    put:
      x-badges:
      - name: Stable
        color: green
      summary: Update an Operation
      description: 'Updates an existing Operation in an Operation List.


        Replace the operation_type and/or args for the Operation identified by operation_id; the updated Operation is returned.


        This is the Pipelines Operations endpoint. Use the Operations API for command operations (dispatch commands).


        **About Operation Lists**


        An Operation List holds one or more Operations — the individual device actions a Pipeline Stage performs against its targeted devices. Operations are grouped into a list so a single stage can execute multiple actions in sequence. This is an authenticated SCAPI endpoint.'
      operationId: updateOperationListOperation
      tags:
      - pipelines_Operations
      security:
      - pipelines_SCAPIAuthToken: []
      parameters:
      - name: operationlist_id
        in: path
        description: ID of the Operation List
        required: true
        schema:
          type: string
      - name: operation_id
        in: path
        description: ID of the Operation
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipelines_Operation'
      responses:
        '200':
          description: Updated Operation Information
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_Operation'
        '400':
          description: Operation update error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_400_Bad_Data'
        '401':
          description: Operation update error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
    delete:
      x-badges:
      - name: Stable
        color: green
      summary: Delete an Operation list operation
      description: 'Removes a specific Operation from an Operation List.


        Deletes the Operation identified by operation_id from the given operationlist_id, so that action no longer runs when the associated Stage executes.


        This is the Pipelines Operations endpoint. Use the Operations API for command operations (dispatch commands).


        **About Operation Lists**


        An Operation List holds one or more Operations — the individual device actions a Pipeline Stage performs against its targeted devices. Operations are grouped into a list so a single stage can execute multiple actions in sequence. This is an authenticated SCAPI endpoint.'
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: deleteOperationListOperation
      tags:
      - pipelines_Operations
      parameters:
      - name: operationlist_id
        in: path
        description: ID of the Operation List
        required: true
        schema:
          type: string
      - name: operation_id
        in: path
        description: ID of the Operation
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Delete operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_Operation'
        '401':
          description: Operation delete error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
components:
  schemas:
    pipelines_Error_400_Bad_Data:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 400
        message:
          type: string
        content:
          type: object
      required:
      - code
      - message
    pipelines_Operation_POST:
      type: object
      properties:
        args:
          type: object
          description: Arguments for the operation
        operation_type:
          type: string
          enum:
          - LOCK
          - REBOOT
          - SET_NEW_POLICY
          - UPDATE_HEARTBEAT
          - REQUEST_BUGREPORT
          - REQUEST_DPCLOG
          - ADD_TO_WHITELIST
          - REMOVE_FROM_WHITELIST
          - SET_APP_PERMISSION
          - WIPE
          - CAPTURE_SCREENSHOT
          - SET_WIFI_STATE
          - SET_BLUETOOTH_STATE
          - SET_ROTATION_STATE
          - SET_GPS_STATE
          - SET_BRIGHTNESS_SCALE
          - SET_STREAM_VOLUME
          - SET_SCREEN_OFF_TIMEOUT
          - SET_ADB_STATE
          - INITIATE_OFFER
          - INSTALL
          - SIMPLE_INSTALL
          - UNINSTALL
          - REFRESH_APPLIST
          - UPDATE_LATEST_DPC
          - NOTIFY_OTA
          - CLEAR_APP_DATA
          - SET_GEO_FENCE
          - SET_KIOSK_APP
          - SET_DEVICE_LOCKDOWN_STATE
          - SET_TIMEZONE
          - SET_APP_STATE
          - ADD_WIFI_AP
          - REMOVE_WIFI_AP
          - UPDATE_WIFI_AP
          - UPDATE_DEVICE_CONFIG
          - INITIATE_CONFERENCE_CALL
          - ADD_OVERRIDE_APN
          - SYNC_CONTENT
          - SET_WALLPAPER
    pipelines_Operation:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        operation_list_id:
          type: string
        pipeline_id:
          type: string
        operation_type:
          type: string
        args:
          type: string
        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
    pipelines_Error_401_Unauthorized:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 401
        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:
- name: ESPER CLOUD API
  tags:
  - esper_cloud_api_Company Settings
  - esper_cloud_api_Application
  - esper_cloud_api_Application V1
  - esper_cloud_api_AndroidDevice
  - esper_cloud_api_Device Group
  - esper_cloud_api_Token (Deprecated)
  - esper_cloud_api_Commands V2
  - esper_cloud_api_Enterprise Policy
  - esper_cloud_api_Geofence
  - esper_cloud_api_Content
  - esper_cloud_api_User (Deprecated)
  - esper_cloud_api_User
  - esper_cloud_api_Blueprint (Deprecated)
  - esper_cloud_api_Directory Record
  - esper_cloud_api_Tile Icon
  - esper_cloud_api_Alerts
  - esper_cloud_api_Alarms
  - esper_cloud_api_Wallpapers
  - esper_cloud_api_Device Telemetry
  - esper_cloud_api_Daily and Custom Reports
  - esper_cloud_api_SSO Connections
  - esper_cloud_api_Roles
  - esper_cloud_api_Personal Access Token
- name: BLUEPRINTS
  tags:
  - blueprints_Blueprints API
  - blueprints_Custom Actions API
  - blueprints_Background Scripts API
- name: PIPELINES
  tags:
  - pipelines_System Status Code
  - pipelines_System
  - pipelines_Pipelines
  - pipelines_Stages
  - pipelines_Target Lists
  - pipelines_Targets
  - pipelines_Device Groups
  - pipelines_Operation Lists
  - pipelines_Operations
  - pipelines_Pipeline Runs
  - pipelines_Stage Runs
  - pipelines_Target Runs
- name: DEVICE
  tags:
  - device_Device
  - device_Device Heartbeat
  - device_Device Apps
  - device_Device Enrollment in EMM
  - device_Operations
  - device_DeviceOperations
  - device_MultiOS Remote Viewer
- name: APPS MANAGEMENT
  tags:
  - apps_management_VPP License Management
  - apps_management_VPP App Management
  - apps_management_Tenant Apps
  - apps_management_Apple App Store
  - apps_management_App List
  - apps_management_Webclips
  - apps_management_Provisioning Profiles
  - apps_management_Preferred Regions
  - apps_management_OEM Config Schema
  - apps_management_Esper Apps
  - apps_management_Tenant Esper Apps
- name: COMMANDS
  tags:
  - commands_Command Request
  - commands_Command Status
- name: DRIFT
  tags:
  - drift_Converge
  - drift_Converge Command
  - drift_Blueprint Drift
- name: DEVICE ONBOARDING
  tags:
  - device_onboarding_DEP Sync Request
  - device_onboarding_ABM Provisioning
- name: TENANT
  tags:
  - tenant_APNs certificate
  - tenant_DEP Profile
  - tenant_DEP Tokens
  - tenant_VPP Token Management
  - tenant_Google Enterprise
  - tenant_MDM Service Config
- name: FOUNDATION
  tags:
  - foundation_FoundryBuilds
  - foundation_FoundryDeviceModels
  - foundation_FoundryEvents
- name: REPORTS
  tags:
  - reports_Reports API
- name: GEOFENCE
  tags:
  - geofence_Geofences
  - geofence_Device State
x-provenance:
  method: harvested
  publisher: Esper
  source: https://api.esper.io/_bundle/openapi.json?download
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)