Esper pipelines_Operation Lists API

openapi: 3.2.0
info:
  title: ESPER API REFERENCE pipelines_Operation Lists 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_Operation Lists
  description: APIs to modify Operation List
  x-displayName: Operation Lists
paths:
  /pipelines/v0/stages/{stage_id}/operationlists/:
    get:
      description: 'Retrieves all Operation Lists attached to a Pipeline stage.


        Returns the Operation Lists linked to the specified stage — these define the sequence of actions (Operations) that the stage performs on its Target Lists during a pipeline run.


        **About Operation Lists**

        An Operation List groups the individual Operations that a Stage executes. Pipelines are built from Stages, and each Stage''s behavior is defined by the Operation List(s) attached to it.


        **Key Fields / Query Parameters**

        - `stage_id` — UUID of the Stage whose Operation Lists you want to retrieve'
      x-badges:
      - name: Stable
        color: green
      summary: Get all Operation Lists attached to the Stage
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: getStageOperationLists
      tags:
      - pipelines_Operation Lists
      parameters:
      - name: stage_id
        in: path
        description: ID of the Stage
        required: true
        schema:
          type: string
      responses:
        '200':
          description: All Operation Lists attached to the Stage
          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_OperationList'
        '401':
          description: Operation List get error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
    post:
      description: 'Creates a new Operation List for a Pipeline stage.


        Creates an Operation List scoped to the specified stage and pipeline, which will hold the ordered set of Operations that stage executes during a pipeline run.


        **About Operation Lists**

        An Operation List groups the individual Operations that a Stage executes. Creating one is typically the first step in defining what a new pipeline stage actually does.


        **Key Fields / Query Parameters**

        - `stage_id` — UUID of the Stage this Operation List belongs to (path parameter)

        - `name` — Name of the Operation List

        - `description` — Free-text description of the Operation List''s purpose

        - `pipeline_id` — UUID of the parent Pipeline'
      x-badges:
      - name: Stable
        color: green
      summary: Create an Operation list for the Stage
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: addStageOperationList
      tags:
      - pipelines_Operation Lists
      parameters:
      - name: stage_id
        in: path
        description: ID of the Stage
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipelines_OperationList_POST'
      responses:
        '200':
          description: Attach Operation list to a Stage
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_OperationList'
        '401':
          description: Operation list attach error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
  /pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/:
    put:
      x-badges:
      - name: Stable
        color: green
      summary: Update an Operation List
      description: '⚠️ **Android only.** Pipelines run on Android devices only.


        Fully updates an existing Operation List for a Pipeline stage.


        Replaces the Operation List''s metadata (name and description) for the specified stage. This is a full-replacement update, so include all writable fields in the request body. Returns the updated Operation List.


        **About Operation Lists**

        An Operation List groups the individual Operations that a Stage executes. Updating it changes how the list is named and described, but it doesn''t reorder or change the Operations inside it. Use the Operations endpoints for that.


        **Key Fields / Query Parameters**

        - `stage_id` — UUID of the Stage (path parameter)

        - `operationlist_id` — UUID of the Operation List to update (path parameter)

        - `name` — Updated name of the Operation List

        - `description` — Updated description


        **Common Use Cases**

        - Renaming an Operation List after a stage''s purpose changes

        - Updating descriptions so pipeline runs are easier to read in reporting


        **Best Practices**

        - Read the current Operation List first so you don''t overwrite fields you meant to keep

        - Use the Operations endpoints, not this one, to add, remove, or change actions


        **Workflow**

        1. Call `GET /pipelines/v0/stages/{stage_id}/operationlists/` to find the Operation List

        2. Build the full request body with your changes

        3. Call this endpoint and confirm the returned values'
      operationId: updatePipelineOperationList
      tags:
      - pipelines_Operation Lists
      security:
      - pipelines_SCAPIAuthToken: []
      parameters:
      - name: stage_id
        in: path
        description: ID of the Stage
        required: true
        schema:
          type: string
      - 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_OperationList'
      responses:
        '200':
          description: Updated Operation List Information
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_OperationList'
        '400':
          description: Operation List update error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_400_Bad_Data'
        '401':
          description: Operation List update error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines_Error_401_Unauthorized'
    delete:
      x-badges:
      - name: Stable
        color: green
      summary: Delete stage operation list
      description: '⚠️ **Android only.** Pipelines run on Android devices only.


        Removes an Operation List from a Pipeline stage.


        Deletes the specified Operation List from the stage and returns the deleted record. The stage no longer runs the Operations in that list during future pipeline runs.


        **About Deleting Operation Lists**

        An Operation List defines what a Stage does. Removing it changes the stage''s behavior for every future run of the pipeline, so review the list''s Operations before deleting it.


        **Key Fields / Query Parameters**

        - `stage_id` — UUID of the Stage (path parameter)

        - `operationlist_id` — UUID of the Operation List to delete (path parameter)


        **Common Use Cases**

        - Removing an obsolete set of actions from a stage

        - Cleaning up a stage before rebuilding its Operation List


        **Best Practices**

        - Check the list''s Operations with `GET /pipelines/v0/operationlists/{operationlist_id}/operations/` before deleting

        - Avoid deleting an Operation List while a run of its pipeline is in progress


        **Workflow**

        1. Call `GET /pipelines/v0/stages/{stage_id}/operationlists/` to confirm the target

        2. Review its Operations

        3. Call this endpoint'
      security:
      - pipelines_SCAPIAuthToken: []
      operationId: deleteStageOperationList
      tags:
      - pipelines_Operation Lists
      parameters:
      - name: stage_id
        in: path
        description: ID of the Stage
        required: true
        schema:
          type: string
      - name: operationlist_id
        in: path
        description: ID of the Operation List
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Delete operation list from stage
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  content:
                    $ref: '#/components/schemas/pipelines_OperationList'
        '401':
          description: Operation list detach 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_OperationList_POST:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        pipeline_id:
          type: string
          format: uuid
      required:
      - name
    pipelines_Error_401_Unauthorized:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 401
        message:
          type: string
        content:
          type: object
      required:
      - code
      - message
    pipelines_OperationList:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        pipeline_id:
          type: string
        stage_id:
          type: string
        name:
          type: string
        description:
          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
  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)