Beta APIs

[beta] Start a Function run.

Start an asynchronous run for the specified Function. This endpoint allows you to override parameters available at runtime.

<b>Rate limit:</b> 2 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Functions under the Functions category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

post/functions/{name}/runs

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Path parameters

namestring required

The name of the Function to run.

Request body

paramsOverrideobject required

Parameter overrides for the Function execution. Can be an empty object but must be provided.

Example request

{
  "paramsOverride": {
    "param1": "value1",
    "param2": "value2"
  }
}

Response

OK response.

Example response

{
  "data": {
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.