Samsara Configurations API
The Configurations API from Samsara — 2 operation(s) for configurations.
The Configurations API from Samsara — 2 operation(s) for configurations.
openapi: 3.0.1
info:
description: Gain greater visibility by connecting your fleets, equipment, sites, and people.
title: Samsara Configurations API
version: '2024-11-18'
servers:
- url: https://api.samsara.com/
- url: https://api.eu.samsara.com/
security:
- AccessTokenHeader: []
tags:
- name: Configurations
paths:
/alerts/configurations:
delete:
description: "Delete an alert configuration.\n\n <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Write Alerts** under the Alerts 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>\n \n\n **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."
operationId: deleteConfigurations
parameters:
- description: The unqiue Samsara id of the alert configuration.
in: query
name: id
required: true
schema:
type: string
responses:
'204':
content: {}
description: No Content response.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsUnauthorizedErrorResponseBody'
description: Unauthorized response.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsNotFoundErrorResponseBody'
description: Not Found response.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsMethodNotAllowedErrorResponseBody'
description: Method Not Allowed response.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsTooManyRequestsErrorResponseBody'
description: Too Many Requests response.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsInternalServerErrorResponseBody'
description: Internal Server Error response.
'501':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsNotImplementedErrorResponseBody'
description: Not Implemented response.
'502':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsBadGatewayErrorResponseBody'
description: Bad Gateway response.
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsServiceUnavailableErrorResponseBody'
description: Service Unavailable response.
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsGatewayTimeoutErrorResponseBody'
description: Gateway Timeout response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsDeleteConfigurationsBadRequestErrorResponseBody'
description: Bad Request response.
summary: Delete Alert Configurations.
tags:
- Configurations
get:
description: "Get specified Alert Configurations.\n\nThe following trigger types are API enabled and will show up in the results:\nVehicle Speed\nAmbient Temperature\nFuel Level (Percentage)\nVehicle DEF Level (Percentage)\nVehicle Battery\nGateway Unplugged\nDashcam Disconnected\nCamera Connector Disconnected\nAsset starts moving\nInside Geofence\nOutside Geofence\nUnassigned Driving\nDriver HOS Violation\nVehicle Engine Idle\nAsset Engine On\nAsset Engine Off\nHarsh Event\nScheduled Maintenance\nScheduled Maintenance by Odometer\nScheduled Maintenance by Engine Hours\nOut of Route\nGPS Signal Loss\nCell Signal Loss\nFault Code\nTire Faults\nGateway Disconnected\nPanic Button\nTampering Detected\nIf vehicle is severely speeding (as defined by your organization)\nDVIR Submitted for Asset\nDriver Document Submitted\nDriver App Sign In\nDriver App Sign Out\nGeofence Entry\nGeofence Exit\nRoute Stop ETA Alert\nDriver Recorded\nScheduled Date And Time\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Alerts** under the Alerts 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>\n \n\n **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."
operationId: getConfigurations
parameters:
- description: Filter by the IDs. Returns all if no ids are provided.
explode: true
in: query
name: ids
schema:
items:
type: string
type: array
style: form
- description: 'The status of the alert configuration. Valid values: `all`, `enabled`, `disabled`'
in: query
name: status
schema:
default: all
enum:
- all
- enabled
- disabled
type: string
- description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.'
in: query
name: after
schema:
type: string
- description: Optional boolean indicating whether to return external IDs on supported entities
in: query
name: includeExternalIds
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsResponseBody'
description: OK response.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsUnauthorizedErrorResponseBody'
description: Unauthorized response.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsNotFoundErrorResponseBody'
description: Not Found response.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsMethodNotAllowedErrorResponseBody'
description: Method Not Allowed response.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsTooManyRequestsErrorResponseBody'
description: Too Many Requests response.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsInternalServerErrorResponseBody'
description: Internal Server Error response.
'501':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsNotImplementedErrorResponseBody'
description: Not Implemented response.
'502':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsBadGatewayErrorResponseBody'
description: Bad Gateway response.
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsServiceUnavailableErrorResponseBody'
description: Service Unavailable response.
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsGatewayTimeoutErrorResponseBody'
description: Gateway Timeout response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetConfigurationsBadRequestErrorResponseBody'
description: Bad Request response.
summary: Get Alert Configurations.
tags:
- Configurations
patch:
description: "Updates an alert configuration.\n\n <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Write Alerts** under the Alerts 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>\n \n\n **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."
operationId: patchConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsRequestBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsResponseBody'
description: OK response.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsUnauthorizedErrorResponseBody'
description: Unauthorized response.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsNotFoundErrorResponseBody'
description: Not Found response.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsMethodNotAllowedErrorResponseBody'
description: Method Not Allowed response.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsTooManyRequestsErrorResponseBody'
description: Too Many Requests response.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsInternalServerErrorResponseBody'
description: Internal Server Error response.
'501':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsNotImplementedErrorResponseBody'
description: Not Implemented response.
'502':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsBadGatewayErrorResponseBody'
description: Bad Gateway response.
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsServiceUnavailableErrorResponseBody'
description: Service Unavailable response.
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsGatewayTimeoutErrorResponseBody'
description: Gateway Timeout response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPatchConfigurationsBadRequestErrorResponseBody'
description: Bad Request response.
summary: Update Alert Configurations.
tags:
- Configurations
x-codegen-request-body-name: PatchConfigurationsRequestBody
post:
description: "Creates an alert configuration.\n\n <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Write Alerts** under the Alerts 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>\n \n\n **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."
operationId: postConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsRequestBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsResponseBody'
description: OK response.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsUnauthorizedErrorResponseBody'
description: Unauthorized response.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsNotFoundErrorResponseBody'
description: Not Found response.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsMethodNotAllowedErrorResponseBody'
description: Method Not Allowed response.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsTooManyRequestsErrorResponseBody'
description: Too Many Requests response.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsInternalServerErrorResponseBody'
description: Internal Server Error response.
'501':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsNotImplementedErrorResponseBody'
description: Not Implemented response.
'502':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsBadGatewayErrorResponseBody'
description: Bad Gateway response.
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsServiceUnavailableErrorResponseBody'
description: Service Unavailable response.
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsGatewayTimeoutErrorResponseBody'
description: Gateway Timeout response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsPostConfigurationsBadRequestErrorResponseBody'
description: Bad Request response.
summary: Create Alert Configurations.
tags:
- Configurations
x-codegen-request-body-name: PostConfigurationsRequestBody
/preview/custom-reports/configs:
get:
description: "Get paginated custom report configs created in the organization.\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Custom Reports** under the Closed Beta 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>\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **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."
operationId: getCustomReportConfigs
parameters:
- description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.'
in: query
name: after
schema:
type: string
- description: The limit for how many reports will be in the response. Default and max for this value is 100 objects.
in: query
name: limit
schema:
default: 100
maximum: 100
minimum: 1
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsResponseBody'
description: OK response.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsUnauthorizedErrorResponseBody'
description: Unauthorized response.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsNotFoundErrorResponseBody'
description: Not Found response.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsMethodNotAllowedErrorResponseBody'
description: Method Not Allowed response.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsTooManyRequestsErrorResponseBody'
description: Too Many Requests response.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsInternalServerErrorResponseBody'
description: Internal Server Error response.
'501':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsNotImplementedErrorResponseBody'
description: Not Implemented response.
'502':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsBadGatewayErrorResponseBody'
description: Bad Gateway response.
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsServiceUnavailableErrorResponseBody'
description: Service Unavailable response.
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsGatewayTimeoutErrorResponseBody'
description: Gateway Timeout response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomReportsGetCustomReportConfigsBadRequestErrorResponseBody'
description: Bad Request response.
summary: '[preview] Get Custom Report Configs'
tags:
- Configurations
components:
schemas:
PanicButtonDetailsObjectRequestBody:
description: Details specific to Panic Button
properties:
isFilteringOutPowerLoss:
description: If true, only receive alerts when the panic button is pressed, otherwise receive alerts when the panic button is pressed or looses connection.
example: true
type: boolean
required:
- isFilteringOutPowerLoss
type: object
AlertsPatchConfigurationsBadRequestErrorResponseBody:
description: Bad Request parameters
properties:
message:
description: Message of error
example: Invalid value for parameter.
type: string
requestId:
description: The request ID; used when reaching out to support for issues with requests.
example: 8916e1c1
type: string
required:
- message
- requestId
type: object
CustomReportConfigObjectResponseBody:
description: Full Custom report config object
properties:
columns:
description: List of custom report column objects
items:
$ref: '#/components/schemas/CustomReportColumnsObjectResponseBody'
type: array
id:
description: ID of the custom report config.
example: 4f71fd67-54f0-41de-991c-ee1e031134d1
type: string
reportName:
description: Name of the custom report config.
example: Fuel Custom Report
type: string
required:
- columns
- id
- reportName
type: object
ScopeObjectResponseBody:
description: What the triggers are scoped to. These are the objects this alert applies to.
properties:
all:
description: Whether it applies to all applicable objects.
example: true
type: boolean
assets:
description: The assets these triggers are scoped to.
items:
$ref: '#/components/schemas/TinyAssetObjectResponseBody'
type: array
drivers:
description: The drivers these triggers are scoped to.
items:
$ref: '#/components/schemas/TinyDriverObjectResponseBody'
type: array
tags:
description: The tags these triggers are scoped to.
items:
$ref: '#/components/schemas/GoaTagTinyResponseResponseBody'
type: array
widgets:
description: The widgets these triggers are scoped to.
items:
$ref: '#/components/schemas/TinyWidgetObjectResponseBody'
type: array
required:
- all
type: object
DefLevelTriggerDetailsObjectResponseBody:
description: Details specific to DEF Level
properties:
defLevelPercent:
description: The DEF percentage threshold value.
example: 100
format: int64
type: integer
minDurationMilliseconds:
description: The number of milliseconds the trigger needs to stay active before alerting.
example: 600000
format: int64
type: integer
operation:
description: 'How to evaluate the threshold. Valid values: `GREATER`, `LESS`'
enum:
- GREATER
- LESS
example: GREATER
type: string
required:
- defLevelPercent
- minDurationMilliseconds
- operation
type: object
VehicleFaultCodeDetailsObjectResponseBody:
description: Details specific to Vehicle Fault Code. At least one fault code or fault code group must be selected.
properties:
hasAnyAmberWarningLampCodes:
description: If true then alert on codes for less serious errors that do not warrant stopping. Defaults to false.
example: true
type: boolean
hasAnyFaultCodes:
description: If true this means that any code is alertable. Defaults to false.
example: true
type: boolean
hasAnyMalfunctionIndicatorLampCodes:
description: If true then alert on emission-related codes. Defaults to false.
example: true
type: boolean
hasAnyProtectionLampCodes:
description: If true then alert on codes for non-electric vehicle parts. Defaults to false.
example: true
type: boolean
hasAnyRedStopLampCodes:
description: If true then alert when the vehicle warrants stopping. Defaults to false.
example: true
type: boolean
hasAnyTrailerAbsLampCodes:
description: If true then alert when the ABS light is on. Defaults to false.
example: true
type: boolean
specificFaultCodes:
description: The list of specific fault codes to be alerted on.
items:
$ref: '#/components/schemas/SpecificVehicleFaultCodeObjectResponseBody'
type: array
type: object
FuelLevelTriggerDetailsObjectResponseBody:
description: Details specific to Fuel Level Percentage
properties:
fuelLevelPercent:
description: The fuel level percentage threshold value.
example: 20
format: int64
type: integer
minDurationMilliseconds:
description: The number of milliseconds the trigger needs to stay active before alerting.
example: 600000
format: int64
type: integer
operation:
description: 'How to evaluate the threshold. Valid values: `LESS`'
enum:
- LESS
example: LESS
type: string
required:
- fuelLevelPercent
- minDurationMilliseconds
- operation
type: object
GeofenceEntryTriggerDetailsObjectResponseBody:
description: Details specific to Geofence Entry
properties:
location:
$ref: '#/components/schemas/LocationObjectResponseBody'
required:
- location
type: object
CustomReportsGetCustomReportConfigsMethodNotAllowedErrorResponseBody:
description: Method not allowed
properties:
message:
description: Message of error
example: DELETE not allowed on /endpoint.
type: string
requestId:
description: The request ID; used when reaching out to support for issues with requests.
example: 8916e1c1
type: string
required:
- message
- requestId
type: object
DVIRSubmittedDeviceTriggerDetailsObjectRequestBody:
description: Details specific to DVIR Submitted by Device
properties:
dvirMinDurationMilliseconds:
description: The trigger will only fire if the selected DVIR types are submitted within the duration.
example: 600000
format: int64
type: integer
dvirSubmissionTypes:
description: Filter to these types of DVIR submissions.
example:
- SAFE_WITH_DEFECTS
- SAFE_NO_DEFECTS
- SAFE_WITH_DEFECTS
- SAFE_WITH_DEFECTS
items:
description: 'DVIR submission type Valid values: `SAFE_NO_DEFECTS`, `SAFE_WITH_DEFECTS`, `UNSAFE`'
enum:
- SAFE_NO_DEFECTS
- SAFE_WITH_DEFECTS
- UNSAFE
example: SAFE_NO_DEFECTS
type: string
type: array
type: object
HarshEventTriggerDetailsObjectResponseBody:
description: Details specific to Harsh Events
properties:
types:
description: On which harsh events to trigger on.
example:
- haRollover
- haRolloverProtectionEngineControlActivated
items:
description: 'The type of harsh event. Valid values: `haAccel`, `haBraking`, `haCameraMisaligned`, `haCrash`, `haDistractedDriving`, `haDistractedDrivingCalibration`, `haDrinkPolicy`, `haDriverObstructionPolicy`, `haDrowsinessDetection`, `haEvent`, `haFalsePositive`, `haFoodPolicy`, `haInvalid`, `haLaneDeparture`, `haMaskPolicy`, `haNearCollision`, `haOutwardObstructionPolicy`, `haPassengerPolicy`, `haPhonePolicy`, `haPolicyDetector`, `haRearCollisionWarning`, `haRolledStopSign`, `haRollover`, `haRolloverProtectionBrakeControlActivated`, `haRolloverProtectionEngineControlActivated`, `haSeatbeltPolicy`, `haSharpTurn`, `haSignDetection`, `haSmokingPolicy`, `haSpeeding`, `haTailgating`, `haTileRollingRailroadCrossing`, `haTileRollingStopSign`, `haVulnerableRoadUserCollisionWarning`, `haYawControlBrakeControlActivated`, `haYawControlEngineControlActivated`'
enum:
- haAccel
- haBraking
- haCameraMisaligned
- haCrash
- haDistractedDriving
- haDistractedDrivingCalibration
- haDrinkPolicy
- haDriverObstructionPolicy
- haDrowsinessDetection
- haEvent
- haFalsePositive
- haFoodPolicy
- haInvalid
- haLaneDeparture
- haMaskPolicy
- haNearCollision
- haOutwardObstructionPolicy
- haPassengerPolicy
- haPhonePolicy
- haPolicyDetector
- haRearCollisionWarning
- haRolledStopSign
- haRollover
- haRolloverProtectionBrakeControlActivated
- haRolloverProtectionEngineControlActivated
- haSeatbeltPolicy
- haSharpTurn
- haSignDetection
- haSmokingPolicy
- haSpeeding
- haTailgating
- haTileRollingRailroadCrossing
- haTileRollingStopSign
- haVulnerableRoadUserCollisionWarning
- haYawControlBrakeControlActivated
- haYawControlEngineControlActivated
example: haInvalid
type: string
type: array
required:
- types
type: object
OutOfRouteDetailsObjectRequestBody:
description: Details specific to Out Of Route
properties:
maxOffRouteMeters:
description: The minimum distance in meters a vehicle has to be from its active route path to be considered out of its route.
example: 100
format: int64
type: integer
minDurationMilliseconds:
description: The number of milliseconds the trigger needs to stay active before alerting.
example: 600000
format: int64
type: integer
required:
- maxOffRouteMeters
- minDurationMilliseconds
type: object
AlertsPatchConfigurationsMethodNotAllowedErrorResponseBody:
description: Method not allowed
properties:
message:
description: Message of error
example:
# --- truncated at 32 KB (142 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/samsara/refs/heads/main/openapi/samsara-configurations-api-openapi.yml