View Source NervesHubCLI.API.Device (nerves_hub_cli v2.0.1)

Manage NervesHub devices

Path: /orgs/:org_name/products/:product_name/devices

Summary

Check authentication status for device certificate.

Create a new device.

Delete an existing device.

List all devices.

Update an existing device.

@spec auth(String.t(), String.t(), String.t(), NervesHubCLI.API.Auth.t()) ::
  {:error, any()} | {:ok, any()}

Check authentication status for device certificate.

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

This function is deprecated. use NervesHubCLI.API.DeviceCertificate.list/4 instead.

@spec create(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  [String.t()],
  NervesHubCLI.API.Auth.t()
) :: {:error, any()} | {:ok, any()}

Create a new device.

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

@spec delete(String.t(), String.t(), String.t(), NervesHubCLI.API.Auth.t()) ::
  {:error, any()} | {:ok, any()}

Delete an existing device.

Verb: DELETE Path: /orgs/:org_name/products/:product_name/devices/:device_identifer

@spec list(String.t(), String.t(), NervesHubCLI.API.Auth.t()) ::
  {:error, any()} | {:ok, any()}

List all devices.

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

@spec update(String.t(), String.t(), String.t(), map(), NervesHubCLI.API.Auth.t()) ::
  {:error, any()} | {:ok, any()}

Update an existing device.

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