LogoLogo
main
1.0.0main
main
1.0.0main
  • Introduction
  • High level architecture
  • Public key infrastructure
  • Terminology
  • Nerves Hub
    • Quickstart
    • Setup
      • Add NervesHub to your project
      • Connecting to your environment
      • Firmware signing keys
      • Products
      • Devices
      • Firmware
      • Deployments
    • Managing organizations and products
    • Device management
    • HTTP API
    • Device WebSocket
  • Nerves Key
    • Introduction
    • NervesKey for Raspberry Pi
    • Private keys and certificates
    • General NervesKey storage
    • Quickstart
    • Provisioning in Elixir
    • Nerves integration
    • NervesHubLink integration
    • MQTT integration
Powered by GitBook
On this page

Was this helpful?

  1. Nerves Hub

HTTP API

This document describes the NervesHub web API endpoints.

PreviousDevice managementNextDevice WebSocket

Last updated 1 year ago

Was this helpful?

You can also view the latest OpenAPI Spec on Github.

Fetch information about a device.

get

If the device is currently online, there will be firmware_metadata describing active firmware.

Authorizations
Path parameters
idstring ยท uuidRequired
Responses
get
GET /api/devices/{id} HTTP/1.1
Host: localhost:4000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "connection_status": "connected",
    "connection_established_at": "2025-04-28T10:56:07.528Z",
    "connection_disconnected_at": "2025-04-28T10:56:07.528Z",
    "connection_last_seen_at": "2025-04-28T10:56:07.528Z",
    "deployment": {
      "name": "production",
      "is_active": true,
      "firmware_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "firmware_version": "1.2.1"
    },
    "description": "A device",
    "firmware_metadata": {
      "architecture": "arm",
      "author": "The Nerves Team",
      "description": "Sensors platform",
      "fwup_version": "1.2.1",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "misc": "text",
      "platform": "rpi",
      "product": "sensors",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "vcs_identifier": "text",
      "version": "1.2.1"
    },
    "firmware_update_status": "latest",
    "identifier": "NH1234",
    "last_communication": "2025-04-28T10:56:07.528Z",
    "online": true,
    "org_name": "nerveshub",
    "product_name": "sensors",
    "tags": [
      "rpi",
      "production"
    ],
    "updates_blocked_until": "2025-04-28T10:56:07.528Z",
    "updates_enabled": true,
    "version": "1.2.1"
  }
}

List all firmware signing keys for the organization

get
Authorizations
Query parameters
orgstringOptionalExample: nerveshub
Responses
get
GET /api/orgs/{org}/keys HTTP/1.1
Host: localhost:4000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "data": [
    {
      "name": "test",
      "key": "h8L1FcfK8mUSnIvM0rffjoapItsI4fimIU9x9Jq2TdU="
    }
  ]
}

View information about the authenticated user

get
Authorizations
Responses
get
GET /api/users/me HTTP/1.1
Host: localhost:4000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "username": "nerveshub",
  "email": "nerveshub@example.org"
}
  • GETFetch information about a device.
  • GETList all firmware signing keys for the organization
  • POSTAdd a new firmware signing key
  • GETView information about the authenticated user

Add a new firmware signing key

post
Authorizations
Query parameters
orgstringOptionalExample: nerveshub
Body
namestringOptionalExample: test
keystringOptionalExample: h8L1FcfK8mUSnIvM0rffjoapItsI4fimIU9x9Jq2TdU=
Responses
post
POST /api/orgs/{org}/keys HTTP/1.1
Host: localhost:4000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "name": "test",
  "key": "h8L1FcfK8mUSnIvM0rffjoapItsI4fimIU9x9Jq2TdU="
}
200

OK

{
  "data": {
    "name": "test",
    "key": "h8L1FcfK8mUSnIvM0rffjoapItsI4fimIU9x9Jq2TdU="
  }
}