Device Attribute Actions

https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Below are the various requests that can be performed against the Device Attribute resource, as well as the expected parameters and the potential responses.

Delete

Removes an attribute from a device

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, deviceAttribute.*, or deviceAttribute.delete.

Request Path Components

Request Headers

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Successful Responses

Error Responses

Get

Retrieves information on a device attribute

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceAttribute.*, or deviceAttribute.get.

Request Path Components

Request Headers

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Successful Responses

Error Responses

Patch

Updates an attribute on a device

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, deviceAttribute.*, or deviceAttribute.patch.

Request Path Components

Request Headers

Request Body

The body of the request should be serialized JSON that validates against the Device Attribute Patch schema. For example, the following would be a valid body for this request:

{
  "description": "my new attribute description"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"description":"my new attribute description"}' \
    https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Successful Responses

Error Responses