Retrieve all custom actions for the tenant
ESPER API REFERENCE (1.0.0)
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:
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.
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. |
We use standard HTTP status codes for success or failure. A typical error response may look something like this:
{
"errors": [],
"message": "error message",
"status": 400
}errors- List of error detailsmessage- Error descriptionstatus- 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.
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.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://api.esper.io/_mock/openapi
https://{foo}-api.esper.cloud/api
Query
Order the results by a specific field (-field for descending order). Valid fields are 'name', 'created_at', 'updated_at', 'created_by', 'updated_by'.
Filter by action type. Comma-separated list. Valid values: button, toggle, radio, dropdown.
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.
Filter by device settings position. Comma-separated list. Valid values: none, device_quick_settings.
- Mock serverhttps://api.esper.io/_mock/openapi/v2/custom-actions/
- https://develop-api.esper.cloud/api/v2/custom-actions/
curl -i -X GET \
'https://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'Response
application/json
{ "content": { "count": 0, "next": "string", "previous": "string", "results": [ … ] }, "message": "string", "code": 0 }
Bodyapplication/jsonrequired
The UI component type for this custom action
Enum"button""toggle""radio""dropdown"
The current operational state of the custom action. Only active custom actions can be deployed to Linux devices.
Enum"draft""active""inactive"
The location in the blueprint where the custom action will be added
Enum"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"
The location in the device's Quick Actions where the custom action will be added
Enum"none""device_quick_settings"
List of options for the custom action
Platform-specific scripts. Currently only Linux platform is supported. Platform key must be lowercase "linux".
The script content to be executed on Linux devices
- Mock serverhttps://api.esper.io/_mock/openapi/v2/custom-actions/
- https://develop-api.esper.cloud/api/v2/custom-actions/
curl -i -X POST \
https://api.esper.io/_mock/openapi/v2/custom-actions/ \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"type": "button",
"state": "draft",
"position_in_blueprints": "none",
"position_in_device_settings": "none",
"properties": {},
"options": [
{
"label": "string",
"key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
"scripts": {
"linux": {
"script": "string",
"interpreter": "bash"
}
}
}
]
}'Response
application/json
{ "content": { "name": "string", "type": "button", "state": "draft", "position_in_blueprints": "none", "position_in_device_settings": "none", "properties": {}, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "options": [ … ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by": 0, "updated_by": 0 }, "message": "string", "code": 201 }
- Mock serverhttps://api.esper.io/_mock/openapi/v2/custom-actions/{custom_action_id}/
- https://develop-api.esper.cloud/api/v2/custom-actions/{custom_action_id}/
curl -i -X GET \
'https://api.esper.io/_mock/openapi/v2/custom-actions/{custom_action_id}/'Response
application/json
{ "content": { "name": "string", "type": "button", "state": "draft", "position_in_blueprints": "none", "position_in_device_settings": "none", "properties": {}, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "options": [ … ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by": 0, "updated_by": 0 }, "message": "string", "code": 200 }