/** * Samsara API * # Overview Something new! Welcome Samsara\'s new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what\'s changed and learn how to get started.

Want to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).

*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can\'t find an API that you\'re looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*

Submit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)! Samsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets. The Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you\'re familiar with what you can build with a REST API, then this will be your go-to API reference. Visit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview. If you have any questions, please visit https://samsara.com/help. ## Endpoints All our APIs can be accessed through HTTP requests to URLs like: ``` https://api.samsara.com/ ``` For EU customers, this URL will be: ``` https://api.eu.samsara.com/ ``` Note Legacy endpoints will have the URL: `https://api.samsara.com/v1/` or `https://api.eu.samsara.com/v1/` ## Authentication To authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings->Organization->API Tokens`. Your API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. Authentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password: ```curl Authorization: Bearer {access_token} ``` All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail. ### OAuth2 If building an application for our marketplace, our API is accessible via. OAuth2 as well. | Type | Value | | ------------- |:-------------:| | Security scheme | OAuth2 | | OAuth2 Flow | accessCode | | Authorization URL | https://api.samsara.com/oauth2/authorize | | Token URL | https://api.samsara.com/oauth2/token | ## Common Patterns You can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures). * * The version of the OpenAPI document: 2024-11-18 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { UpdateVehicleRequest } from '../samsara-models'; import { VehicleResponse } from '../samsara-models'; import { VehiclesListVehiclesResponseBody } from '../samsara-models'; /** * VehiclesApi - axios parameter creator * @export */ export declare const VehiclesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get information about a specific vehicle. **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. To use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. Learn More. * @summary Retrieve a vehicle * @param {string} id ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicle: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of all vehicles. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Vehicles** under the Vehicles 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. * @summary List all vehicles. * @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects. * @param {string} [after] 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. * @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678` * @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @param {string} [attributeValueIds] A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544` * @param {string} [updatedAfterTime] A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @param {string} [createdAfterTime] A filter on data to have a created at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVehicles: (limit?: number, after?: string, parentTagIds?: string, tagIds?: string, attributeValueIds?: string, updatedAfterTime?: string, createdAfterTime?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates the given Vehicle object. **Note:** Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API. You are able to *update* many of the fields of a Vehicle. **Note**: There are no required fields in the request body, and you only need to provide the fields you wish to update. **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. To use this endpoint, select **Write Vehicles** under the Vehicles category when creating or editing an API token. Learn More. * @summary Update a vehicle * @param {string} id ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`. * @param {UpdateVehicleRequest} vehicle Fields that can be patched on a vehicle. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVehicle: (id: string, vehicle: UpdateVehicleRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * VehiclesApi - functional programming interface * @export */ export declare const VehiclesApiFp: (configuration?: Configuration) => { /** * Get information about a specific vehicle. **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. To use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. Learn More. * @summary Retrieve a vehicle * @param {string} id ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicle(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of all vehicles. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Vehicles** under the Vehicles 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. * @summary List all vehicles. * @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects. * @param {string} [after] 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. * @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678` * @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @param {string} [attributeValueIds] A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544` * @param {string} [updatedAfterTime] A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @param {string} [createdAfterTime] A filter on data to have a created at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVehicles(limit?: number, after?: string, parentTagIds?: string, tagIds?: string, attributeValueIds?: string, updatedAfterTime?: string, createdAfterTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the given Vehicle object. **Note:** Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API. You are able to *update* many of the fields of a Vehicle. **Note**: There are no required fields in the request body, and you only need to provide the fields you wish to update. **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. To use this endpoint, select **Write Vehicles** under the Vehicles category when creating or editing an API token. Learn More. * @summary Update a vehicle * @param {string} id ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`. * @param {UpdateVehicleRequest} vehicle Fields that can be patched on a vehicle. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVehicle(id: string, vehicle: UpdateVehicleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VehiclesApi - factory interface * @export */ export declare const VehiclesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get information about a specific vehicle. **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. To use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. Learn More. * @summary Retrieve a vehicle * @param {VehiclesApiGetVehicleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicle(requestParameters: VehiclesApiGetVehicleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of all vehicles. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Vehicles** under the Vehicles 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. * @summary List all vehicles. * @param {VehiclesApiListVehiclesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVehicles(requestParameters?: VehiclesApiListVehiclesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the given Vehicle object. **Note:** Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API. You are able to *update* many of the fields of a Vehicle. **Note**: There are no required fields in the request body, and you only need to provide the fields you wish to update. **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. To use this endpoint, select **Write Vehicles** under the Vehicles category when creating or editing an API token. Learn More. * @summary Update a vehicle * @param {VehiclesApiUpdateVehicleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVehicle(requestParameters: VehiclesApiUpdateVehicleRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getVehicle operation in VehiclesApi. * @export * @interface VehiclesApiGetVehicleRequest */ export interface VehiclesApiGetVehicleRequest { /** * ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`. * @type {string} * @memberof VehiclesApiGetVehicle */ readonly id: string; } /** * Request parameters for listVehicles operation in VehiclesApi. * @export * @interface VehiclesApiListVehiclesRequest */ export interface VehiclesApiListVehiclesRequest { /** * The limit for how many objects will be in the response. Default and max for this value is 512 objects. * @type {number} * @memberof VehiclesApiListVehicles */ readonly limit?: number; /** * 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. * @type {string} * @memberof VehiclesApiListVehicles */ readonly after?: string; /** * A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678` * @type {string} * @memberof VehiclesApiListVehicles */ readonly parentTagIds?: string; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {string} * @memberof VehiclesApiListVehicles */ readonly tagIds?: string; /** * A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544` * @type {string} * @memberof VehiclesApiListVehicles */ readonly attributeValueIds?: string; /** * A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @type {string} * @memberof VehiclesApiListVehicles */ readonly updatedAfterTime?: string; /** * A filter on data to have a created at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @type {string} * @memberof VehiclesApiListVehicles */ readonly createdAfterTime?: string; } /** * Request parameters for updateVehicle operation in VehiclesApi. * @export * @interface VehiclesApiUpdateVehicleRequest */ export interface VehiclesApiUpdateVehicleRequest { /** * ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`. * @type {string} * @memberof VehiclesApiUpdateVehicle */ readonly id: string; /** * Fields that can be patched on a vehicle. * @type {UpdateVehicleRequest} * @memberof VehiclesApiUpdateVehicle */ readonly vehicle: UpdateVehicleRequest; } /** * VehiclesApi - object-oriented interface * @export * @class VehiclesApi * @extends {BaseAPI} */ export declare class VehiclesApi extends BaseAPI { /** * Get information about a specific vehicle. **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. To use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. Learn More. * @summary Retrieve a vehicle * @param {VehiclesApiGetVehicleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VehiclesApi */ getVehicle(requestParameters: VehiclesApiGetVehicleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a list of all vehicles. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Vehicles** under the Vehicles 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. * @summary List all vehicles. * @param {VehiclesApiListVehiclesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VehiclesApi */ listVehicles(requestParameters?: VehiclesApiListVehiclesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates the given Vehicle object. **Note:** Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API. You are able to *update* many of the fields of a Vehicle. **Note**: There are no required fields in the request body, and you only need to provide the fields you wish to update. **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. To use this endpoint, select **Write Vehicles** under the Vehicles category when creating or editing an API token. Learn More. * @summary Update a vehicle * @param {VehiclesApiUpdateVehicleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VehiclesApi */ updateVehicle(requestParameters: VehiclesApiUpdateVehicleRequest, options?: RawAxiosRequestConfig): Promise>; }