Gateways

Activate a new gateway

Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device's serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated

<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>).

To use this endpoint, select Write Gateways under the Setup & Administration 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/gateways

Request

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

Request body

serialstring required

Gateway serial number

Example request

{
  "serial": "GFRV-43N-VGX"
}

Response

OK response.

Example response

{
  "data": {
    "accessoryDevices": [
      {
        "model": "EM11",
        "serial": "ABCD-123-EFG"
      }
    ],
    "asset": {
      "id": "8393848111"
    },
    "connectionStatus": {
      "healthStatus": "Not Installed",
      "lastConnected": "2019-06-13T19:08:25Z"
    },
    "dataUsageLast30Days": {
      "cellularDataUsageBytes": 1881967158240695300,
      "hotspotUsageBytes": 6473124134001760000
    },
    "model": "VG34",
    "serial": "GFRV-43N-VGX"
  }
}

Changes

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