Rate this page

★
★
★
★
★
★
★
★
★
★

Environment Variable API

The Notehub environment variable API provides RESTful methods that can be used to GET, PUT, and DELETE data related to environment variables.

note

All environment variable APIs are available in the context of both Notehub projects and ProductUIDs. While this document shows the product context only, you can substitute in projects for products and projectUID for productUID for each API listed.

Get Environment Variables

Get all project-level environment variables by ProductUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`authToken`

string

A Notehub API authentication token.


curl -X GET
     -L '[baseURL]/products/{productUID}/environment_variables'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "project_humidity": "33.4",
    "project_temp": "24.1"
  }
}

Set Environment Variables

Set project-level environment variables by ProductUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`authToken`

string

A Notehub API authentication token.

`jsonObject`

object

A JSON object containing the key/value pair(s) of environment variable(s) to add. For example: {"key1":"value1","key2":"value2"}.


curl -X PUT
     -L '[baseURL]/products/{productUID}/environment_variables'
     -H 'X-SESSION-TOKEN: [authToken]'
     -d '{"environment_variables":[jsonObject]}'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "project_humidity": "33.4",
    "project_temp": "24.1"
  }
}

Delete Environment Variable

Delete a project-level environment variable by ProductUID and environment variable key.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`authToken`

string

A Notehub API authentication token.

`key`

string

The key from the key/value pair of the environment variable to be deleted.


curl -X DELETE
     -L '[baseURL]/products/{productUID}/environment_variables/{key}'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "project_humidity": "33.4",
    "project_temp": "24.1"
  }
}

Get Environment Variables by Fleet

Get all fleet-level environment variables by ProductUID and FleetUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`fleetUID`

string

The FleetUID of a Notehub device fleet.

`authToken`

string

A Notehub API authentication token.


curl -X GET
     -L '[baseURL]/products/{productUID}/fleets/{fleetUID}/environment_variables'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "fleet_humidity": "33.4",
    "fleet_temp": "24.1"
  }
}

Set Environment Variables by Fleet

Set fleet-level environment variables by ProductUID and FleetUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`fleetUID`

string

The FleetUID of a Notehub device fleet.

`authToken`

string

A Notehub API authentication token.

`jsonObject`

object

A JSON object containing the key/value pair(s) of environment variable(s) to be added. For example: {"key1":"value1","key2":"value2"}.


curl -X PUT
     -L '[baseURL]/products/{productUID}/fleets/{fleetUID}/environment_variables'
     -H 'X-SESSION-TOKEN: [authToken]'
     -d '{"environment_variables":[jsonObject]}'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "fleet_humidity": "33.4",
    "fleet_temp": "24.1"
  }
}

Delete Environment Variable by Fleet

Delete a fleet-level environment variable on a Notehub project by ProductUID, FleetUID, and environment variable key.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`fleetUID`

string

The FleetUID of a Notehub device fleet.

`authToken`

string

A Notehub API authentication token.

`key`

string

The key from the key/value pair of the environment variable to be deleted.


curl -X DELETE
     -L '[baseURL]/products/{productUID}/fleets/{fleetUID}/environment_variables/{key}'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "fleet_humidity": "33.4",
    "fleet_temp": "24.1"
  }
}

Get Environment Variables by Device

Get all device-level environment variables by ProductUID and DeviceUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`deviceUID`

string

The DeviceUID of a Notehub device.

`authToken`

string

A Notehub API authentication token.


curl -X GET
     -L '[baseURL]/products/{productUID}/devices/{deviceUID}/environment_variables'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

`environment_variables_env_default`

object

JSON object containing any default environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "_tags": "",
    "device_humidity": "55.9",
    "device_temp": "79.0"
  },
  "environment_variables_env_default": {}
}

Set Environment Variables by Device

Set device-level environment variables by ProductUID and DeviceUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`deviceUID`

string

The DeviceUID of a Notehub device.

`authToken`

string

A Notehub API authentication token.

`jsonObject`

object

A JSON object containing the key/value pair(s) of environment variable(s) to be added. For example: {"key1":"value1","key2":"value2"}.


curl -X PUT
     -L '[baseURL]/products/{productUID}/devices/{deviceUID}/environment_variables'
     -H 'X-SESSION-TOKEN: [authToken]'
     -d '{"environment_variables":[jsonObject]}'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "_tags": "",
    "device_humidity": "55.9",
    "device_temp": "79.0"
  }
}

Delete Environment Variable by Device

Delete an environment variable by ProductUID, DeviceUID, and environment variable key.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`deviceUID`

string

The DeviceUID of a Notehub device.

`authToken`

string

A Notehub API authentication token.

`key`

string

The key from the key/value pair of the environment variable to be deleted.


curl -X DELETE
     -L '[baseURL]/products/{productUID}/devices/{deviceUID}/environment_variables/{key}'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`environment_variables`

object

JSON object containing environment variables in "key":"value" format.

Example Response


{
  "environment_variables": {
    "_tags": "",
    "device_humidity": "55.9",
    "device_temp": "79.0"
  }
}

Device API Event API