blueprints_Background Scripts API

GET /v2/background-scripts/{background_script_id}/

Retrieves a single background script by ID, including its full content.

Returns the background script's metadata along with its full script content.

About Background Scripts Background Scripts let a tenant run custom PowerShell automation on managed devices. This detail endpoint is the only way to retrieve the actual script content, as opposed to the list endpoint which returns metadata only.

Key Fields / Query Parameters

  • background_script_id — ID of the background script to retrieve

Common Use Cases

  • Reviewing a script's full content before modifying or reusing it
  • Auditing exactly what code is running on devices via a specific background script
  • Confirming script content after an update to ensure it matches what was intended

Best Practices

  • Use the list endpoint to find the background_script_id first, since it returns metadata only
  • Review full script content here before assigning it to additional Blueprints, especially for scripts you didn't author
  • Treat script content as sensitive if it includes credentials or internal configuration

Workflow

  1. List background scripts to find the target background_script_id
  2. GET this endpoint to retrieve full script content
  3. Assign the script to a Blueprint to deploy it to devices

Request

  • Base URL
    https://develop-api.esper.cloud/api
  • URL
    https://develop-api.esper.cloud/api/v2/background-scripts/{background_script_id}/
  • Auth
    none declared

Path parameters

background_script_idstring uuid required

Response

Success

messagestring
code200

Changes

No recorded changes to this operation across all 6 revisions of this API.