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 Cellular Links API

The Cellular Links API from Hologram — 6 operation(s) for cellular links.

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

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

This API exposes 6 operations across 6 paths, and defines 4 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.

6 operations 6 paths 4 schemas 2 GET4 POST

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 Cellular Links 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 6

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

Cellular Links 6
GET
/links/cellular
List cellular links (SIMs)
listCellularLinks 5 params → 200
GET
/links/cellular/{linkid}
Retrieve a cellular link
getCellularLink 1 param → 200
POST
/links/cellular/sim_{iccid}/claim
Activate (claim) a SIM
claimSim 1 param body → 200
POST
/links/cellular/bulkclaim
Activate (claim) multiple SIMs in bulk
bulkClaimSims body → 200
POST
/links/cellular/{linkid}/state
Pause or unpause a SIM
setCellularLinkState 1 param body → 200
POST
/links/cellular/{linkid}/changeplan
Change a SIM data plan
changeCellularLinkPlan 1 param body → 200

Schemas 4

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

CellularLinkResponse
object
2 properties
SuccessResponse
object
2 properties
CellularLinkListResponse
object
5 properties
CellularLink
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hologram-cellular-links-api-openapi.yml Raw ↑

Other APIs Hologram publishes across the network.

Hologram Devices API
Hologram Messaging API
Hologram Plans API
Hologram SMS API
Hologram Tags API
Hologram Usage API
Hologram Webhooks API