{
  "opencollection": "1.0.0",
  "info": {
    "name": "Samsara Configurations API",
    "version": "2024-11-18"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Configurations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Alert Configurations.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.samsara.com/alerts/configurations",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Filter by the IDs. Returns all if no ids are provided."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "The status of the alert configuration.  Valid values: `all`, `enabled`, `disabled`"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "includeExternalIds",
                "value": "",
                "type": "query",
                "description": "Optional boolean indicating whether to return external IDs on supported entities"
              }
            ]
          },
          "docs": "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 Odomete"
        },
        {
          "info": {
            "name": "Create Alert Configurations.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.samsara.com/alerts/configurations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 fe"
        },
        {
          "info": {
            "name": "Update Alert Configurations.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.samsara.com/alerts/configurations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 fe"
        },
        {
          "info": {
            "name": "Delete Alert Configurations.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.samsara.com/alerts/configurations",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The unqiue Samsara id of the alert configuration."
              }
            ]
          },
          "docs": "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 fee"
        },
        {
          "info": {
            "name": "[preview] Get Custom Report Configs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.samsara.com/preview/custom-reports/configs",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The limit for how many reports will be in the response. Default and max for this value is 100 objects."
              }
            ]
          },
          "docs": "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. Th"
        }
      ]
    }
  ],
  "bundled": true
}