Skip to main content

Hologram REST API

Full API reference for the Hologram REST API.

​
What is a REST API?

The REST API is a set of HTTP endpoints that let you programmatically manage your fleet. Bulk actions and automation are where it shines.

​
Authentication

Include your API key using Basic auth. 
Authorization: Basic Base64Encode("apikey:YOUR_API_KEY")
Caution: Never transmit API keys in plaintext or commit them to source control.

​
Anatomy of an endpoint

  • Base URL: https://dashboard.hologram.io/api/1/
  • Categories: devices, links/cellular, plans, usage, sms, tunnelkeys, organizations, users
  • Query params: orgid, limit, etc.

​
Common endpoints

​
Get plan information

GET https://dashboard.hologram.io/api/1/plans?orgid={ORG_ID}

​
Activate SIMs in bulk

POST https://dashboard.hologram.io/api/1/links/cellular/bulkclaim?orgid={ORG_ID}
Body example: 
{
  "sims": ["{SIM_NUMBER_1}", "{SIM_NUMBER_2}"],
  "plan": {PLAN_ID},
  "zone": "{PLAN_ZONE}"
}

​
Get tags

GET https://dashboard.hologram.io/api/1/devices/tags?orgid={ORG_ID}

GET https://dashboard.hologram.io/api/1/devices?orgid={ORG_ID}

​
Tag SIMs

POST https://dashboard.hologram.io/api/1/devices/tags/{TAG_ID}/link?orgid={ORG_ID}
Body: 
{ "deviceids": [DEVICE_ID_1, DEVICE_ID_2] }

​
Change plans (bulk)

POST https://dashboard.hologram.io/api/1/links/cellular/changeplan
Body: 
{
  "linkids": [LINKID_1, LINKID_2],
  "plan": PLAN_ID,
  "tier": "{PLAN_ZONE}",
  "orgid": ORG_ID
}

​
Pause or resume a SIM

POST https://dashboard.hologram.io/api/1/links/cellular/{linkid}/state?orgid={ORG_ID}
Body: 
{ "state": "pause" }

REST API keys

Tag multiple SIMs via API