startSiteLocateSwitch

POST https://{{host}}/api/v1/sites/:site_id/devices/:device_id/locate

Locate a Switch by blinking all port LEDs. By default, request is sent to ‘master’ switch and LEDs will keep flashing for 5 minutes. In case of virtual chassis (VC) the desired member mac has to be passed in the request payload. At anypoint, only one VC member can be requested to flash the LED.

To stop LED flashing before the duration ends /unlocate API request can be made.

If /unlocate API is not called LED will continue to flash on device for the given duration. Default duration is 5 minutes and 120 minutes is the maximum.

Body Parameters

Name	Type	Description
`mac`	`string`	optional: member mac address, default is master mac address
`duration`	`int`	optional: minutes the leds should keep flashing, default - 5 minutes, maximum 120 minutes

Request Body

{"mac"=>"f01c2d4ff760", "duration"=>5}

HEADERS

Key	Datatype	Required	Description
`Accept`	string
`X-CSRFToken`	string
`Content-Type`	string

RESPONSES

status: OK