nerves_hub_user_api v0.4.0 NervesHubUserAPI.Device

Manage NervesHub devices

Path: /orgs/:org_name/devices

Link to this section Summary

Functions

Check authentication status for device certificate

List certificates for a device

Sign a new certificate signing request for a device

List all devices

Link to this section Functions

Link to this function auth(org_name, cert_pem, auth)
auth(atom() | binary(), binary(), NervesHubUserAPI.Auth.t()) ::
  {:error, any()} | {:ok, any()}

Check authentication status for device certificate.

Verb: POST Path: /orgs/:org_name/devices/auth

Link to this function cert_list(org_name, device_identifier, auth)
cert_list(atom() | binary(), binary(), NervesHubUserAPI.Auth.t()) ::
  {:error, any()} | {:ok, any()}

List certificates for a device.

Verb: GET Path: /orgs/:org_name/devices/:device_identifier/certificates

Link to this function cert_sign(org_name, device_identifier, csr, auth)
cert_sign(atom() | binary(), binary(), binary(), NervesHubUserAPI.Auth.t()) ::
  {:error, any()} | {:ok, any()}

Sign a new certificate signing request for a device.

Verb: POST Path: /orgs/:org_name/devices/:device_identifier/certificates/sign

Link to this function create(org_name, identifier, description, tags, auth)
create(
  atom() | binary(),
  binary(),
  binary(),
  [binary()],
  NervesHubUserAPI.Auth.t()
) :: {:error, any()} | {:ok, any()}

Create a new device.

Verb: POST Path: /orgs/:org_name/devices

Link to this function list(org_name, auth)
list(atom() | binary(), NervesHubUserAPI.Auth.t()) ::
  {:error, any()} | {:ok, any()}

List all devices.

Verb: GET Path: /orgs/:org_name/devices

Link to this function update(org_name, device_identifier, params, auth)
update(atom() | binary(), binary(), map(), NervesHubUserAPI.Auth.t()) ::
  {:error, any()} | {:ok, any()}

Update an existing device.

Verb: PUT Path: /orgs/:org_name/devices/:device_identifier