Docs / iglooworks / API Reference / Devices
Devices API Reference
Enterprise API endpoints for managing devices.
Get Devices
GET
/devices
Responses
200 Success
Request Example
Get Device
GET
/devices/{id}
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
200 Success
Request Example
Get Access List
GET
/devices/{id}/access
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
200 Success
Request Example
Delete Access
DELETE
/devices/{id}/access/{accessId}
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
| accessId | string | Yes |
Responses
204 Deleted
Request Example
Create EKey
POST
/devices/{id}/ekey
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
201 Created
Request Example
Create Permanent Algo Pin
POST
/devices/{id}/algopin/permanent
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Body Parameters
Content-Type:
application/json
| Parameter | Type | Required |
|---|---|---|
| schema | string | Optional |
| accessName | string | Optional |
| startDate | string | Optional |
| variance | integer | Optional |
Responses
201 Created
Request Example
Create One-Time Algo Pin
POST
/devices/{id}/algopin/onetime
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
201 Created
Request Example
Create Daily Algo Pin
POST
/devices/{id}/algopin/daily
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
201 Created
Request Example
Create Hourly Algo Pin
POST
/devices/{id}/algopin/hourly
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
201 Created
Request Example
Get Device Activity
GET
/devices/{id}/activity
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
200 Success
Request Example
Push Device Activity
POST
/devices/{id}/activity
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Body Parameters
Content-Type:
application/json
| Parameter | Type | Required |
|---|---|---|
| schema | string | Optional |
| logsPayload | array | Optional |
Responses
200 Success
Request Example
Get Device Jobs
GET
/devices/{id}/jobs
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
200 Success
Request Example
Create Device Job (Custom Pin)
POST
/devices/{id}/jobs
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
Responses
201 Created
Request Example
Get Job Details
GET
/devices/{id}/jobs/{jobId}
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| id | string | Yes |
| jobId | string | Yes |
Responses
200 Success
200 Success
Request Example
Create Bridge Proxied Job
POST
/devices/{deviceId}/jobs/bridges/{bridgeId}
Path Parameters
| Parameter | Type | Required |
|---|---|---|
| deviceId | string | Yes |
| bridgeId | string | Yes |
Responses
201 Created