Mencantumkan pasangan Perangkat PolarClaw.
Coba sekarang
Test
RAM authorization
Sintaks permintaan
POST HTTP/1.1
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ApplicationId |
string |
Yes |
ID aplikasi. |
pa-************** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Response schema |
||
| RequestId |
string |
The ID of the request. |
A7E6A8FD-C50B-46B2-BA85-D8B8D3****** |
| Message |
string |
The response message. |
successful |
| Code |
integer |
The status code of the response. |
200 |
| ApplicationId |
string |
The application ID. |
pa-************** |
| Pending |
array<object> |
A list of pending pairing requests. |
|
|
object |
Details of a pending pairing request. |
||
| PairRequestId |
string |
The pairing request ID. |
test-1778647932986 |
| DeviceId |
string |
The unique device ID. |
device-784x37k0vko734fk |
| PublicKey |
string |
The Ed25519 public key. |
test-pubkey-base64url |
| DisplayName |
string |
The display name of the device. |
test |
| Platform |
string |
The operating system. |
linux |
| DeviceFamily |
string |
The device family. |
server |
| ClientId |
string |
The client ID. |
cli |
| ClientMode |
string |
The client mode. |
cli |
| Role |
string |
The device role. |
operator |
| Roles |
array |
The list of roles. |
|
|
string |
The device role. |
operator |
|
| Scopes |
array |
The list of permission scopes. |
|
|
string |
A permission scope. |
operator.read |
|
| RemoteIp |
string |
The requester's remote IP address. |
127.0.0.1 |
| Silent |
boolean |
Whether this is a silent pairing. |
false |
| IsRepair |
boolean |
Whether the request is to repair an existing pairing. |
false |
| Ts |
integer |
The timestamp of the pairing request, in Unix milliseconds. |
1778660347550 |
| Paired |
array<object> |
A list of paired devices. |
|
|
object |
Details of a paired device. |
||
| DeviceId |
string |
The unique device ID. |
f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c |
| DisplayName |
string |
The display name of the device. |
empty |
| Platform |
string |
The operating system. |
linux |
| DeviceFamily |
string |
The device family. |
empty |
| ClientId |
string |
The client ID. |
cli |
| ClientMode |
string |
The client mode. |
cli |
| Role |
string |
The device role. |
operator |
| Scopes |
array |
The list of permission scopes. |
|
|
string |
A permission scope. |
operator.admin |
|
| CreatedAtMs |
integer |
The time when the device pairing was created, in Unix milliseconds. |
1778659807727 |
| LastSeenAtMs |
integer |
The time when the device was last active, in Unix milliseconds. |
1778659807727 |
Contoh
Respons sukses
JSONformat
{
"RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Pending": [
{
"PairRequestId": "test-1778647932986",
"DeviceId": "device-784x37k0vko734fk",
"PublicKey": "test-pubkey-base64url",
"DisplayName": "test",
"Platform": "linux",
"DeviceFamily": "server",
"ClientId": "cli",
"ClientMode": "cli",
"Role": "operator",
"Roles": [
"operator"
],
"Scopes": [
"operator.read"
],
"RemoteIp": "127.0.0.1",
"Silent": false,
"IsRepair": false,
"Ts": 1778660347550
}
],
"Paired": [
{
"DeviceId": "f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c",
"DisplayName": "empty",
"Platform": "linux",
"DeviceFamily": " empty",
"ClientId": "cli",
"ClientMode": "cli",
"Role": "operator",
"Scopes": [
"operator.admin"
],
"CreatedAtMs": 1778659807727,
"LastSeenAtMs": 1778659807727
}
]
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.