REST API
SUPPORTFEEDBACK

[beta] Set an equipment digital output state

patch
https://api.samsara.com/fleet/equipment//digital-output

Set the state of a digital output on the gateway connected to a piece of powered equipment. The command is delivered to the device synchronously; a success response indicates the device acknowledged and applied the requested state. This requires an AG53 gateway connected to powered equipment via the CBL-AG-BEQP cable.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Equipment Output Control under the Closed Beta category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The Samsara ID of the gateway whose digital output is being controlled. This must be an AG53 connected to powered equipment via the CBL-AG-BEQP cable.

Body Params

A request to set the state of an equipment digital output.

integer
0 to 604800

How long, in seconds, to hold the requested state before the device automatically reverts. Provide 0 (the default) to hold the state indefinitely. The maximum is 604800 seconds (7 days).

integer
required
≥ 1

The digital output pin to control. Only pin 1 is currently supported.

boolean
required

The desired output state. Provide true to energize the output, or false to de-energize it.

Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?