Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hologram Devices API

The Devices API from Hologram — 3 operation(s) for devices.

Hologram Devices API is one of 8 APIs that Hologram publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://dashboard.hologram.io/api/1.

4 operations 3 paths 5 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://dashboard.hologram.io/api/1
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Hologram Devices API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (apikeyAuth). By default, every request must be authenticated.

  • apikeyAuth — HTTP Basic authentication. Use the literal username apikey and your Hologram API key as the password. The API key may alternatively be supplied as an apikey qu…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Devices 4
GET
/devices
List devices
listDevices 6 params → 200
GET
/devices/{deviceid}
Retrieve a device
getDevice 1 param → 200
PUT
/devices/{deviceid}
Update a device
updateDevice 1 param body → 200
POST
/devices/{deviceid}/state
Pause or unpause device data
setDeviceState 1 param body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Device (9 properties), DeviceListResponse (5 properties), Tag (4 properties), SuccessResponse (2 properties). Each schema is shown below with its type and property counts.

DeviceResponse
object
2 properties
SuccessResponse
object
2 properties
Device
object
9 properties
Tag
object
4 properties
DeviceListResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hologram-devices-api-openapi.yml Raw ↑

Other APIs Hologram publishes across the network.

Hologram Cellular Links API
Hologram Messaging API
Hologram Plans API
Hologram SMS API
Hologram Tags API
Hologram Usage API
Hologram Webhooks API