Skip to content
Open AIQ

Get a public device

GET
/public/devices/{id}
curl --request GET \
  --url https://localhost:8080/api/v1/public/devices/example

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Device id (UUID)

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
object
created_at
string
id
string
is_outdoor
boolean
is_public
boolean
name
string
updated_at
string
Examplegenerated
{
  "data": {
    "created_at": "example",
    "id": "example",
    "is_outdoor": true,
    "is_public": true,
    "name": "example",
    "updated_at": "example"
  }
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
detail
string
errors
Array<object>
object
code
string
detail
string
in
string
Allowed values: body query path
name
string
instance
string
status
integer
title
string
type
string
Example
{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
detail
string
errors
Array<object>
object
code
string
detail
string
in
string
Allowed values: body query path
name
string
instance
string
status
integer
title
string
type
string
Example
{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}