View Source NervesHubUserAPI.Deployment (nerves_hub_user_api v0.9.0)

Manage NervesHub deployments

Path: /orgs/:org_name/products/:product_name/deployments

Link to this section Summary

Link to this section Functions

Link to this function

create(org_name, product_name, name, firmware_uuid, version, tags, auth)

View Source
@spec create(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  [String.t()],
  NervesHubUserAPI.Auth.t()
) :: {:error, any()} | {:ok, any()}

Create a new deployment.

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

Link to this function

list(org_name, product_name, auth)

View Source
@spec list(String.t(), String.t(), NervesHubUserAPI.Auth.t()) ::
  {:error, any()} | {:ok, any()}

List all deployments for a product.

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

Link to this function

update(org_name, product_name, deployment_name, params, auth)

View Source
@spec update(String.t(), String.t(), String.t(), map(), NervesHubUserAPI.Auth.t()) ::
  {:error, any()} | {:ok, any()}

Update an existing deployment.

Verb: PUT Path: /orgs/:org_name/products/:product_name/deployments/:depolyment_name