Samsara Configurations API
The Configurations API from Samsara — 2 operation(s) for configurations.
Samsara Configurations API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Configurations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes 5 operations across 2 paths, and defines 164 schemas. It is described by OpenAPI 3.0.1, at version 2024-11-18.
Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.
5 operations
2 paths
164 schemas
1 DELETE2 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Samsara Configurations API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessTokenHeader).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Configurations 5
DELETE
/alerts/configurations
Delete Alert Configurations.
GET
/alerts/configurations
Get Alert Configurations.
PATCH
/alerts/configurations
Update Alert Configurations.
POST
/alerts/configurations
Create Alert Configurations.
GET
/preview/custom-reports/configs
[preview] Get Custom Report Configs
Schemas 164
The contract defines 164 schemas that model the data the API accepts and returns. The most detailed are TriggerParamsObjectResponseBody (30 properties), TriggerParamsObjectRequestBody (30 properties), GetResponseWorkflowConfigurationObjectResponseBody (10 properties), PatchResponseWorkflowConfigurationObjectResponseBody (10 properties). Each schema is shown below with its type and property counts.
PanicButtonDetailsObjectRequestBody
object
Details specific to Panic Button
1 property
1 required
AlertsPatchConfigurationsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
CustomReportConfigObjectResponseBody
object
Full Custom report config object
3 properties
3 required
ScopeObjectResponseBody
object
What the triggers are scoped to. These are the objects this alert applies to.
5 properties
1 required
DefLevelTriggerDetailsObjectResponseBody
object
Details specific to DEF Level
3 properties
3 required
VehicleFaultCodeDetailsObjectResponseBody
object
Details specific to Vehicle Fault Code. At least one fault code or fault code group must be selected.
7 properties
FuelLevelTriggerDetailsObjectResponseBody
object
Details specific to Fuel Level Percentage
3 properties
3 required
GeofenceEntryTriggerDetailsObjectResponseBody
object
Details specific to Geofence Entry
1 property
1 required
CustomReportsGetCustomReportConfigsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DVIRSubmittedDeviceTriggerDetailsObjectRequestBody
object
Details specific to DVIR Submitted by Device
2 properties
HarshEventTriggerDetailsObjectResponseBody
object
Details specific to Harsh Events
1 property
1 required
OutOfRouteDetailsObjectRequestBody
object
Details specific to Out Of Route
2 properties
2 required
AlertsPatchConfigurationsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
AlertsPatchConfigurationsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
GetResponseWorkflowConfigurationObjectResponseBody
object
The configuration of a alert.
10 properties
8 required
AlertsDeleteConfigurationsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
ActionParamsObjectRequestBody
object
The action type specific details. Set webhookIds for Slack or Webhook actions. Set recipients for Notifications. Set driverAppNotification for Driver App Push.…
3 properties
AlertsPostConfigurationsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
UnassignedDrivingTriggerDetailsObjectRequestBody
object
Details specific to Unassigned Driving
1 property
1 required
AlertsGetConfigurationsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
EngineOffDetailsObjectRequestBody
object
Details specific to Engine Off
1 property
1 required
TinyWidgetObjectResponseBody
object
Widget to be tracked.
1 property
1 required
EngineIdleTriggerDetailsObjectResponseBody
object
Details specific to Engine Idle
1 property
1 required
AlertsDeleteConfigurationsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
PatchResponseWorkflowConfigurationObjectResponseBody
object
The configuration of a alert.
10 properties
8 required
AlertsDeleteConfigurationsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
AmbientTemperatureDetailsObjectRequestBody
object
Details specific to Ambient Temperature.
5 properties
3 required
PostResponseResWorkflowConfigurationObjectResponseBody
object
The configuration of a alert.
10 properties
8 required
ScheduledMaintenanceByEngineHoursDetailsObjectRequestBody
object
Details specific to Scheduled Maintenance By Engine Hours
2 properties
2 required
AmbientTemperatureDetailsObjectResponseBody
object
Details specific to Ambient Temperature.
5 properties
3 required
GatewayUnpluggedTriggerDetailsObjectResponseBody
object
Details specific to Gateway Unplugged
1 property
1 required
OutOfRouteDetailsObjectResponseBody
object
Details specific to Out Of Route
2 properties
2 required
TinyDriverObjectRequestBody
object
The driver of a vehicle.
1 property
1 required
PushNotificationOptionsObjectRequestBody
object
Options for push notifications
1 property
1 required
CustomReportColumnsObjectResponseBody
object
Information about a custom report column.
4 properties
2 required
EngineOnDetailsObjectResponseBody
object
Details specific to Engine On
1 property
1 required
PanicButtonDetailsObjectResponseBody
object
Details specific to Panic Button
1 property
1 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
TriggerParamsObjectRequestBody
object
The trigger type specific details. Only the field that corresponds to the trigger type is filled in.
30 properties
PolygonRequestBody
object
Information about a polygon geofence. This field is only needed if the geofence is a polygon.
2 properties
1 required
TinyWidgetObjectRequestBody
object
Widget to be tracked.
1 property
1 required
VehicleBatterVoltageDetailsObjectRequestBody
object
Details specific to Vehicle Battery Voltage
3 properties
3 required
OutsideGeofenceTriggerDetailsObjectRequestBody
object
Details specific to Outside Geofence
2 properties
2 required
TinyAssetObjectResponseBody
object
Vehicle, trailer or other equipment to be tracked.
2 properties
2 required
TriggerParamsObjectResponseBody
object
The trigger type specific details. Only the field that corresponds to the trigger type is filled in.
30 properties
CustomReportsGetCustomReportConfigsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
InAppNotificationOptionsObjectResponseBody
object
Options for in-app notifications
4 properties
1 required
CustomReportsGetCustomReportConfigsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
AlertsDeleteConfigurationsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
AlertsPostConfigurationsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
CustomReportsGetCustomReportConfigsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AlertsDeleteConfigurationsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
CustomReportsGetCustomReportConfigsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
AlertsDeleteConfigurationsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
AlertsDeleteConfigurationsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AlertsPatchConfigurationsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
ScheduledMaintenanceTriggerDetailsObjectRequestBody
object
Details specific to Scheduled Maintenance by Date
2 properties
2 required
AlertsPatchConfigurationsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
VertexResponseBody
object
The vertex of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.
2 properties
2 required
DriverAppNotificationObjectResponseBody
object
Driver app notification settings
2 properties
EngineOnDetailsObjectRequestBody
object
Details specific to Engine On
1 property
1 required
GoaTagTinyResponseRequestBody
object
A minified tag object
3 properties
2 required
HOSViolationTriggerDetailsObjectRequestBody
object
Details specific to HOS Violation
2 properties
2 required
CustomReportsGetCustomReportConfigsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
ActionObjectRequestBody
object
Action to take.
2 properties
1 required
HarshEventTriggerDetailsObjectRequestBody
object
Details specific to Harsh Events
1 property
1 required
AlertsPostConfigurationsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DefLevelTriggerDetailsObjectRequestBody
object
Details specific to DEF Level
3 properties
3 required
AlertsPatchConfigurationsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TireFaultCodeDetailsObjectRequestBody
object
Details specific to Tire Fault Code. At least one fault code or fault code group must be selected.
4 properties
1 required
AlertsPostConfigurationsRequestBody
object
The configuration of a alert.
7 properties
5 required
CircleResponseBody
object
Information about a circular geofence. This field is only needed if the geofence is a circle.
4 properties
2 required
InsideGeofenceTriggerDetailsObjectResponseBody
object
Details specific to Inside Geofence
2 properties
2 required
InsideGeofenceTriggerDetailsObjectRequestBody
object
Details specific to Inside Geofence
2 properties
2 required
VehicleBatterVoltageDetailsObjectResponseBody
object
Details specific to Vehicle Battery Voltage
3 properties
3 required
AlertsGetConfigurationsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
ScheduledMaintenanceOdometerTriggerDetailsObjectRequestBody
object
Details specific to Scheduled Maintenance by Odometer
2 properties
2 required
GpsSignalLossDetailsObjectResponseBody
object
Details specific to GPS Signal Loss
1 property
1 required
AlertsPostConfigurationsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
HOSViolationTriggerDetailsObjectResponseBody
object
Details specific to HOS Violation
2 properties
2 required
AlertsGetConfigurationsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
GoaTagTinyResponseResponseBody
object
A minified tag object
3 properties
2 required
TireFaultCodeDetailsObjectResponseBody
object
Details specific to Tire Fault Code. At least one fault code or fault code group must be selected.
4 properties
1 required
AlertsGetConfigurationsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
CellSignalLossDetailsObjectResponseBody
object
Details specific to Cell Signal Loss
1 property
1 required
AlertsPostConfigurationsResponseBody
object
1 property
1 required
GeofenceExitTriggerDetailsObjectRequestBody
object
Details specific to Geofence Exit
1 property
1 required
DriverDocumentSubmittedDetailsObjectRequestBody
object
Details specific to Driver Document Submitted
1 property
1 required
SpeedTriggerDetailsObjectResponseBody
object
Details specific to Speed
3 properties
3 required
CellSignalLossDetailsObjectRequestBody
object
Details specific to Cell Signal Loss
1 property
1 required
ActionObjectResponseBody
object
Action to take.
2 properties
1 required
SpecificVehicleFaultCodeObjectRequestBody
object
A specific vehicle fault code.
2 properties
2 required
CustomReportsGetCustomReportConfigsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
WebhookParamsObjectRequestBody
object
The webhook configuration for an Action.
2 properties
1 required
DeviceMovementTriggerDetailsObjectRequestBody
object
Details specific to Device Movement
1 property
1 required
WebhookParamsObjectResponseBody
object
The webhook configuration for an Action.
2 properties
1 required
EngineIdleTriggerDetailsObjectRequestBody
object
Details specific to Engine Idle
1 property
1 required
DriverDocumentSubmittedDetailsObjectResponseBody
object
Details specific to Driver Document Submitted
1 property
1 required
CustomReportsGetCustomReportConfigsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
AlertsGetConfigurationsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
InAppNotificationOptionsObjectRequestBody
object
Options for in-app notifications
4 properties
1 required
AlertsPatchConfigurationsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
AlertsDeleteConfigurationsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
GatewayUnpluggedTriggerDetailsObjectRequestBody
object
Details specific to Gateway Unplugged
1 property
1 required
RouteStopEstimatedArrivalDetailsObjectResponseBody
object
Details specific to Route Stop Estimated Arrival
4 properties
2 required
AlertsPostConfigurationsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
ScheduledMaintenanceByEngineHoursDetailsObjectResponseBody
object
Details specific to Scheduled Maintenance By Engine Hours
2 properties
2 required
GatewayDisconnectedDetailsObjectResponseBody
object
Details specific to Gateway Disconnected
1 property
1 required
AlertsPatchConfigurationsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
AlertsGetConfigurationsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
ActionParamsObjectResponseBody
object
The action type specific details. Set webhookIds for Slack or Webhook actions. Set recipients for Notifications. Set driverAppNotification for Driver App Push.…
3 properties
AlertsGetConfigurationsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
ScheduledMaintenanceTriggerDetailsObjectResponseBody
object
Details specific to Scheduled Maintenance by Date
2 properties
2 required
AlertsPostConfigurationsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
AlertsPostConfigurationsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
CircleRequestBody
object
Information about a circular geofence. This field is only needed if the geofence is a circle.
4 properties
2 required
RecipientObjectRequestBody
object
Recipient of an Action. One of userId contactId or roleId needs to be set.
5 properties
1 required
AlertsPostConfigurationsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
AlertsPostConfigurationsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
OperationalSettingsObjectResponseBody
object
Settings on when the alert should be operational.
2 properties
2 required
TinyDriverObjectResponseBody
object
The driver of a vehicle.
1 property
1 required
OutsideGeofenceTriggerDetailsObjectResponseBody
object
Details specific to Outside Geofence
2 properties
2 required
CustomReportsGetCustomReportConfigsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
AlertsPatchConfigurationsResponseBody
object
1 property
1 required
VehicleFaultCodeDetailsObjectRequestBody
object
Details specific to Vehicle Fault Code. At least one fault code or fault code group must be selected.
7 properties
CustomReportsGetCustomReportConfigsResponseBody
object
2 properties
2 required
AlertsPatchConfigurationsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AlertsDeleteConfigurationsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
CustomReportsGetCustomReportConfigsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
PolygonResponseBody
object
Information about a polygon geofence. This field is only needed if the geofence is a polygon.
2 properties
1 required
GatewayDisconnectedDetailsObjectRequestBody
object
Details specific to Gateway Disconnected
1 property
1 required
AlertsDeleteConfigurationsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
GeofenceEntryTriggerDetailsObjectRequestBody
object
Details specific to Geofence Entry
1 property
1 required
WorkflowTriggerObjectResponseBody
object
The trigger of an alert.
2 properties
1 required
VertexRequestBody
object
The vertex of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.
2 properties
2 required
TimeRangeObjectRequestBody
object
A daily time range. If start time of day is greater than end time of day, then the time range applies overnight from the specified day of week into the followi…
4 properties
4 required
RecipientObjectResponseBody
object
Recipient of an Action. One of userId contactId or roleId needs to be set.
5 properties
1 required
TinyAssetObjectRequestBody
object
Vehicle, trailer or other equipment to be tracked.
2 properties
2 required
DVIRSubmittedDeviceTriggerDetailsObjectResponseBody
object
Details specific to DVIR Submitted by Device
2 properties
SpeedTriggerDetailsObjectRequestBody
object
Details specific to Speed
3 properties
3 required
EngineOffDetailsObjectResponseBody
object
Details specific to Engine Off
1 property
1 required
AlertsGetConfigurationsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
UnassignedDrivingTriggerDetailsObjectResponseBody
object
Details specific to Unassigned Driving
1 property
1 required
AlertsGetConfigurationsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
AlertsPatchConfigurationsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
PushNotificationOptionsObjectResponseBody
object
Options for push notifications
1 property
1 required
OperationalSettingsObjectRequestBody
object
Settings on when the alert should be operational.
2 properties
2 required
DriverAppNotificationObjectRequestBody
object
Driver app notification settings
2 properties
ScopeObjectRequestBody
object
What the triggers are scoped to. These are the objects this alert applies to.
5 properties
1 required
TimeRangeObjectResponseBody
object
A daily time range. If start time of day is greater than end time of day, then the time range applies overnight from the specified day of week into the followi…
4 properties
4 required
GpsSignalLossDetailsObjectRequestBody
object
Details specific to GPS Signal Loss
1 property
1 required
LocationObjectResponseBody
object
A location. Polygon and Circle is deprecated, but may be set for old Alerts. At least one location must be selected.
5 properties
AlertsGetConfigurationsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
ScheduledMaintenanceOdometerTriggerDetailsObjectResponseBody
object
Details specific to Scheduled Maintenance by Odometer
2 properties
2 required
SpecificVehicleFaultCodeObjectResponseBody
object
A specific vehicle fault code.
2 properties
2 required
FuelLevelTriggerDetailsObjectRequestBody
object
Details specific to Fuel Level Percentage
3 properties
3 required
AlertsPostConfigurationsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AlertsGetConfigurationsResponseBody
object
2 properties
2 required
RouteStopEstimatedArrivalDetailsObjectRequestBody
object
Details specific to Route Stop Estimated Arrival
4 properties
2 required
GeofenceExitTriggerDetailsObjectResponseBody
object
Details specific to Geofence Exit
1 property
1 required
DeviceMovementTriggerDetailsObjectResponseBody
object
Details specific to Device Movement
1 property
1 required
AlertsPatchConfigurationsRequestBody
object
The configuration of a alert.
8 properties
1 required
WorkflowTriggerObjectRequestBody
object
The trigger of an alert.
2 properties
1 required
LocationObjectRequestBody
object
A location. Polygon and Circle is deprecated, but may be set for old Alerts. At least one location must be selected.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Samsara 12
Other APIs Samsara publishes across the network.
Samsara Activity API
Samsara Addresses API
Samsara Aemp API
Samsara Applications API
Samsara Assets API
Samsara Assignments API
Samsara Attributes API
Samsara Audit API
Samsara Beta A P Is API
Samsara Camera API
Samsara Cameras API
Samsara Cargo API
#Configurations
Where this information came from
This is an independent, third-party profile of Samsara Configurations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.