Device
デバイスの一覧を取得します。
GET https://api.legs.iij.jp/api/devices?token=api-token
Parameters
| type |
parameter |
require |
example |
description |
| query |
token |
yes |
api-token |
API Token |
Response Body 200
show example
[
{
"id": "02fcd662-5113-53d8-a118-747e81b99d03",
"account_id": 1,
"device_name": "a4:5e:60:e3:fc:1f",
"auth_status": true,
"conn_status": true,
"last_conn": "2018-07-30T19:53:47.724220229+09:00"
}
]
複数のデバイスを手動で作成します。このAPIで作成されたデバイスはアカウントの設定に関わらず、`auth_status`が`true`（認証済みデバイス）として作成されます。
POST https://api.legs.iij.jp/api/devices?token=api-token
Parameters
| type |
parameter |
require |
example |
description |
| query |
token |
yes |
api-token |
API Token |
Request Body
show example
{
"devices": [
{ "device_name": "sample-device1", "label": "device-label1" },
{ "device_name": "sample-device2", "label": "device-label2" }
]
}
Response Body 201
show example
[
{
"id": "02fcd662-5113-53d8-a118-747e81b99d03",
"account_id": 1,
"device_name": "sample-device1",
"label": "device-label1",
"auth_status": true,
"conn_status": false
},
{
"id": "02fcd662-5113-53d8-a118-747e81b31faa",
"account_id": 1,
"device_name": "sample-device2",
"label": "device-label2",
"auth_status": true,
"conn_status": false
}
]
IDを指定して特定のデバイスの情報を取得します。
GET https://api.legs.iij.jp/api/devices/{device_id}?token=api-token
Parameters
| type |
parameter |
require |
example |
description |
| path |
device_id |
yes |
02fcd662-5113-53d8-a118-747e81b99d03 |
デバイスID |
| query |
token |
yes |
api-token |
API Token |
Response Body 200
show example
{
"id": "02fcd662-5113-53d8-a118-747e81b99d03",
"account_id": 1,
"device_name": "a4:5e:60:e3:fc:1f",
"label": "my deivce",
"auth_status": true,
"conn_status": true,
"last_conn": "2018-07-30T19:53:47.724220229+09:00"
}
IDを指定して特定のデバイスの情報を更新します。
PATCH https://api.legs.iij.jp/api/devices/{device_id}?token=api-token
Parameters
| type |
parameter |
require |
example |
description |
| path |
device_id |
yes |
02fcd662-5113-53d8-a118-747e81b99d03 |
デバイスID |
| query |
token |
yes |
api-token |
API Token |
Request Body
show example
{
"label": "my deivce2",
}
Response Body 200
show example
{
"id": "02fcd662-5113-53d8-a118-747e81b99d03",
"account_id": 1,
"device_name": "a4:5e:60:e3:fc:1f",
"label": "my deivce2",
"auth_status": true,
"conn_status": true,
"last_conn": "2018-07-30T19:53:47.724220229+09:00"
}
IDを指定して特定のデバイスを削除します。
DELETE https://api.legs.iij.jp/api/devices/{device_id}?token=api-token
Parameters
| type |
parameter |
require |
example |
description |
| path |
device_id |
yes |
02fcd662-5113-53d8-a118-747e81b99d03 |
デバイスID |
| query |
token |
yes |
api-token |
API Token |
Response Body 204