Account Properties

For the base URL, authentication and errors, see the REST API overview.

`GET /v1/users/{user}/properties`

Request: GET /v1/users/{user}/properties
Operation: ListProperties
Operation ID: Property_ListProperties
Authentication: access token, Authorization: Bearer YOUR_TOKEN

Parameters

Name	In	Type	Required	Description
`user`	path	string	yes

Example request

bash

curl 'https://YOUR_SERVER/v1/users/YOUR_USER/properties' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Responses

Status	Description
200	ok
401	unauthorized
403	forbidden

Response example (200)

json

[
  {
    "created": 1792263090745,
    "description": "Sampling and alert thresholds",
    "modified": 1792263090745,
    "name": "Settings",
    "property": "settings",
    "type": "configuration",
    "value": {
      "alerts": true,
      "interval": 60,
      "max_temperature": 28.5
    }
  },
  {
    "created": 1792263090745,
    "modified": 1792263090745,
    "name": "Location",
    "property": "location",
    "value": {
      "lat": 40.4168,
      "lon": -3.7038
    }
  },
  {
    "created": 1792263090745,
    "modified": 1792263090745,
    "name": "Calibration",
    "perm": {
      "readOnly": [
        "member"
      ]
    },
    "property": "calibration",
    "value": {
      "gain": 1.02,
      "offset": -0.4
    }
  },
  {
    "created": 1792263090745,
    "modified": 1792263090745,
    "name": "Dashboard",
    "property": "dashboard",
    "value": {
      "source": "url",
      "url": "/v1/users/YOUR_USER/storages/fleet_app/files/"
    }
  }
]

`POST /v1/users/{user}/properties`

Request: POST /v1/users/{user}/properties
Operation: CreateProperty
Operation ID: Property_Create
Authentication: access token, Authorization: Bearer YOUR_TOKEN

Parameters

Name	In	Type	Required	Description
`user`	path	string	yes

Request body (application/json, required)

The body matches one of these 2 variants.

Variant 1

Field	Type	Required	Constraints	Description
`(body)`	array of object	no
`(body)[].description`	string	no	Maximum length: 255	A brief description of the resource, providing context or additional information, limited to 255 characters.
`(body)[].form`	object	no
`(body)[].form.fields`	any	yes
`(body)[].name`	string	no	Maximum length: 255	The name of the resource, limited to 255 characters. It can include any character.
`(body)[].perm`	object	no
`(body)[].perm.hidden`	array of string	no	Unique items
`(body)[].perm.readOnly`	array of string	no	Unique items
`(body)[].property`	string	yes	Pattern: `^[a-zA-Z0-9_-]{1,32}$`	A unique identifier for resources, consisting of alphanumeric characters, underscores, or hyphens, and limited to 32 characters.
`(body)[].type`	string	no	One of: ``, `configuration`
`(body)[].value`	any	yes

Variant 2: Property Create. Schema for creating a property

Schema for creating a property

Field	Type	Required	Constraints	Description
`description`	string	no	Maximum length: 255	A brief description of the resource, providing context or additional information, limited to 255 characters.
`form`	object	no
`form.fields`	any	yes
`name`	string	no	Maximum length: 255	The name of the resource, limited to 255 characters. It can include any character.
`perm`	object	no
`perm.hidden`	array of string	no	Unique items
`perm.readOnly`	array of string	no	Unique items
`property`	string	yes	Pattern: `^[a-zA-Z0-9_-]{1,32}$`	A unique identifier for resources, consisting of alphanumeric characters, underscores, or hyphens, and limited to 32 characters.
`type`	string	no	One of: ``, `configuration`
`value`	any	yes

Example request: Configuration value

bash

curl -X POST 'https://YOUR_SERVER/v1/users/YOUR_USER/properties' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Sampling and alert thresholds",
  "name": "Settings",
  "property": "settings",
  "type": "configuration",
  "value": {
    "alerts": true,
    "interval": 60,
    "max_temperature": 28.5
  }
}'

Example body: Location

json

{
  "name": "Location",
  "property": "location",
  "value": {
    "lat": 40.4168,
    "lon": -3.7038
  }
}

Example body: Read-only for project members

json

{
  "name": "Calibration",
  "perm": {
    "readOnly": [
      "member"
    ]
  },
  "property": "calibration",
  "value": {
    "gain": 1.02,
    "offset": -0.4
  }
}

Example body: Url dashboard of the resource

json

{
  "name": "Dashboard",
  "property": "dashboard",
  "value": {
    "source": "url",
    "url": "/v1/users/YOUR_USER/storages/fleet_app/files/"
  }
}

Responses

Status	Description
200	ok
401	unauthorized
403	forbidden

`GET /v1/users/{user}/properties/{property}`

Request: GET /v1/users/{user}/properties/
Operation: ReadProperty
Operation ID: Property_Read
Authentication: access token, Authorization: Bearer YOUR_TOKEN

Parameters

Name	In	Type	Required	Description
`user`	path	string	yes
`property`	path	string	yes

Example request

bash

curl 'https://YOUR_SERVER/v1/users/YOUR_USER/properties/YOUR_PROPERTY' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Responses

Status	Description
200	ok
401	unauthorized
403	forbidden

`PUT /v1/users/{user}/properties/{property}`

Request: PUT /v1/users/{user}/properties/
Operation: UpdateProperty
Operation ID: Property_Update
Authentication: access token, Authorization: Bearer YOUR_TOKEN

Parameters

Name	In	Type	Required	Description
`user`	path	string	yes
`property`	path	string	yes

Request body (application/json, required)

Schema for updating a property

Field	Type	Required	Constraints	Description
`description`	string	no	Maximum length: 255	A brief description of the resource, providing context or additional information, limited to 255 characters.
`form`	object	no
`form.fields`	any	yes
`name`	string	no	Maximum length: 255	The name of the resource, limited to 255 characters. It can include any character.
`perm`	object	no
`perm.hidden`	array of string	no	Unique items
`perm.readOnly`	array of string	no	Unique items
`property`	string	no	Pattern: `^[a-zA-Z0-9_-]{1,32}$`	A unique identifier for resources, consisting of alphanumeric characters, underscores, or hyphens, and limited to 32 characters.
`type`	string	no	One of: ``, `configuration`
`value`	any	yes

Example request: Hide from project members

bash

curl -X PUT 'https://YOUR_SERVER/v1/users/YOUR_USER/properties/YOUR_PROPERTY' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "perm": {
    "hidden": [
      "member"
    ]
  },
  "value": "internal note"
}'

Example body: Replace the value

json

{
  "value": {
    "alerts": true,
    "interval": 30,
    "max_temperature": 27
  }
}

Example body: Value, name and description

json

{
  "description": "Faster sampling during commissioning",
  "name": "Settings",
  "value": {
    "alerts": false,
    "interval": 10,
    "max_temperature": 28.5
  }
}

Responses

Status	Description
200	ok
401	unauthorized
403	forbidden

`PATCH /v1/users/{user}/properties/{property}`

Request: PATCH /v1/users/{user}/properties/
Operation: UpdateProperty
Operation ID: Property_Patch
Authentication: access token, Authorization: Bearer YOUR_TOKEN

Parameters

Name	In	Type	Required	Description
`user`	path	string	yes
`property`	path	string	yes

Request body (application/json, required)

The body matches one of these 2 variants.

Variant 1

Field	Type	Required	Constraints	Description
`value`	any	yes

Variant 2

Field	Type	Required	Constraints	Description
`*`	any	no

Example request: Change some fields of the value

bash

curl -X PATCH 'https://YOUR_SERVER/v1/users/YOUR_USER/properties/YOUR_PROPERTY' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": {
    "interval": 30
  }
}'

Example body: Flattened fields

json

{
  "value.alerts": false,
  "value.max_temperature": 27
}

Responses

Status	Description
200	ok
401	unauthorized
403	forbidden

`DELETE /v1/users/{user}/properties/{property}`

Request: DELETE /v1/users/{user}/properties/
Operation: DeleteProperty
Operation ID: Property_Delete
Authentication: access token, Authorization: Bearer YOUR_TOKEN

Parameters

Name	In	Type	Required	Description
`user`	path	string	yes
`property`	path	string	yes

Example request

bash

curl -X DELETE 'https://YOUR_SERVER/v1/users/YOUR_USER/properties/YOUR_PROPERTY' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Responses

Status	Description
200	ok
401	unauthorized
403	forbidden

`GET /v1/users/{user}/properties/{property}/clone`

Request: GET /v1/users/{user}/properties/{property}/clone
Operation: ClonePropertyConfig
Operation ID: Property_CloneConfig
Authentication: access token, Authorization: Bearer YOUR_TOKEN

Parameters

Name	In	Type	Required	Description
`user`	path	string	yes
`property`	path	string	yes

Example request

bash

curl 'https://YOUR_SERVER/v1/users/YOUR_USER/properties/YOUR_PROPERTY/clone' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Responses

Status	Description
200	ok
401	unauthorized
403	forbidden

`POST /v1/users/{user}/properties/{property}/clone`

Request: POST /v1/users/{user}/properties/{property}/clone
Operation: CloneProperty
Operation ID: Property_Clone
Authentication: access token, Authorization: Bearer YOUR_TOKEN

Parameters

Name	In	Type	Required	Description
`user`	path	string	yes
`property`	path	string	yes

Request body (application/json, required)

Field	Type	Required	Constraints	Description
`description`	string	no	Maximum length: 255	A brief description of the resource, providing context or additional information, limited to 255 characters.
`enabled`	boolean	no
`name`	string	no	Maximum length: 255	The name of the resource, limited to 255 characters. It can include any character.
`property`	string	yes	Pattern: `^[a-zA-Z0-9_-]{1,32}$`	A unique identifier for resources, consisting of alphanumeric characters, underscores, or hyphens, and limited to 32 characters.

Example request: Copy with a new id

bash

curl -X POST 'https://YOUR_SERVER/v1/users/YOUR_USER/properties/YOUR_PROPERTY/clone' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "property": "copy_of_property"
}'

Example body: Copy with name and description

json

{
  "description": "Same configuration as the original, for production line 2",
  "name": "Line 2 copy",
  "property": "line_2_property"
}

Responses

Status	Description
200	ok
401	unauthorized
403	forbidden

REST API

Arduino library

CLI

Dashboard SDK

VS Code extension

Account Properties

`GET /v1/users/{user}/properties`

`POST /v1/users/{user}/properties`

`GET /v1/users/{user}/properties/{property}`

`PUT /v1/users/{user}/properties/{property}`

`PATCH /v1/users/{user}/properties/{property}`

`DELETE /v1/users/{user}/properties/{property}`

`GET /v1/users/{user}/properties/{property}/clone`

`POST /v1/users/{user}/properties/{property}/clone`

REST API

Arduino library

CLI

Dashboard SDK

VS Code extension

GET /v1/users/{user}/properties ​

POST /v1/users/{user}/properties ​

GET /v1/users/{user}/properties/{property} ​

PUT /v1/users/{user}/properties/{property} ​

PATCH /v1/users/{user}/properties/{property} ​

DELETE /v1/users/{user}/properties/{property} ​

GET /v1/users/{user}/properties/{property}/clone ​

POST /v1/users/{user}/properties/{property}/clone ​

`GET /v1/users/{user}/properties`

`POST /v1/users/{user}/properties`

`GET /v1/users/{user}/properties/{property}`

`PUT /v1/users/{user}/properties/{property}`

`PATCH /v1/users/{user}/properties/{property}`

`DELETE /v1/users/{user}/properties/{property}`

`GET /v1/users/{user}/properties/{property}/clone`

`POST /v1/users/{user}/properties/{property}/clone`