Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET channels/scan/status
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns channels scan status.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/status
Example Request
GET
https://192.168.10.53/api/5.0/channels/scan/status
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "e74365f3-d042-4fa5-9df5-9f70a0380089",
"device": "92081df8-f78d-418e-92b7-87fdab283cd8",
"timestamp": "2022-02-08T05:37:39.285Z",
"scan": "e74365f3-d042-4fa5-9df5-9f70a0380089",
"mode": "Finished",
"progress": 100,
"status": "Found 0, Updated 0, Added 0",
"found": [],
"added": [],
"updated": [],
"processed": "2022-02-08T05:37:39.285Z"
},
{
"uuid": "13d02fd8-773a-426a-b664-87cd5c6bfb7e",
"device": "92081df8-f78d-418e-92b7-87fdab283cd8",
"timestamp": "2022-02-08T05:38:33.948Z",
"scan": "13d02fd8-773a-426a-b664-87cd5c6bfb7e",
"mode": "Running",
"time_remained": 4,
"progress": 90,
"status": "Scanning (9 services)",
"sources": [],
"processed": "2022-02-08T05:38:33.948Z"
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"total_pages": 1,
"current_page": 1
}
} |
PUT channels/scan/command/start
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Starts scanning a channel on MCS.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/channels/scan/command/start
Example Request
PUT
Body
| Code Block | ||
|---|---|---|
| ||
{
"scan": "1da03be8-83ca-4167-a1eb-5d20c716cf78",
"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
"missing_channels_action": "Add",
"existing_channels_action": "Merge to Active Profile or Add New"
} |
Response
| Code Block | ||
|---|---|---|
| ||
{ "data": { "uuid": "1b546c80-1a52-45ce-b855-b78af1dc7fa8", "created": 1686553652980, "modified": 1686553652980, "type": "Start Scan", "state": "Running", "progress": 0, "attributes": { "scan": "1da03be8-83ca-4167-a1eb-5d20c716cf78", "device": "05011df5-87b1-4141-a3c0-c547657bf9b1", "existing_channels_action": "Merge to Active Profile or Add New", "missing_channels_action": "Add", "entries": [] }, "result": null }, "metadata": {} } |