Versions Compared

Version Old Version 1 New Version Current
Changes made by

Ramya Raman (Unlicensed)

Ramya Raman (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PUT channels/scan/command/start

Resource Information

Requires Authentication?

Yes

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

  1. https://192.168.10.53/api/5.0/channels/scan/command/start

Expand
title
Body
BODY
Code Block
languagejson
{
    "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"
}
Expand
Response
titleRESPONSE
Code Block
languagejson
{
    "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": {}
}