Skip to content

Custom Actions API

APIs to manage custom actions. Custom actions allow you to define custom scripts and commands that can be executed on Linux devices. Currently, only Linux platform is supported for custom actions.

Operations

/v2/custom-actions/
Stable

Request

Retrieve all custom actions for the tenant

Query
orderingstring

Order the results by a specific field (-field for descending order). Valid fields are 'name', 'created_at', 'updated_at', 'created_by', 'updated_by'.

namestring

Filter the results by name (partial match, case insensitive).

typestring

Filter by action type. Comma-separated list. Valid values: button, toggle, radio, dropdown.

statestring

Filter by action state. Comma-separated list. Valid values: draft, active, inactive.

position_in_blueprintsstring

Filter by blueprint position. Comma-separated list. Valid values: none, blueprints_apps_and_configuration, blueprints_connectivity, blueprints_device_security, blueprints_display_and_branding, blueprints_esper_settings, blueprints_scripts, blueprints_files, blueprints_platform_services, blueprints_hardware_settings, blueprints_sound, blueprints_system_updates, blueprints_time_and_date.

position_in_device_settingsstring

Filter by device settings position. Comma-separated list. Valid values: none, device_quick_settings.

created_byinteger

Filter by user ID who created the action.

updated_byinteger

Filter by user ID who last updated the action.

limitinteger, [ 1 .. 100 ]

Number of results to return per page.

Default:10
offsetinteger, >= 0

The initial index from which to return the results.

Default:0
cURL
curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/v2/custom-actions/?ordering=string&name=string&type=string&state=string&position_in_blueprints=string&position_in_device_settings=string&created_by=0&updated_by=0&limit=10&offset=0'

Responses

Success

Bodyapplication/json
contentobject
messagestring
codeinteger
Response
{
  "content": {
    "count": 0,
    "next": "string",
    "previous": "string",
    "results": [ … ]
  },
  "message": "string",
  "code": 0
}