Skip to main content

Start periodic interface outage

POST
/tasks/interface/flap/schedule/start/{id}

Starts successive interface disable-and-restore cycles. The first cycle starts immediately; each subsequent cycle starts only after the current one completes, the Up state is confirmed, and the interval_sec delay elapses.

Contract

Parameter
Value
Sectiontasks
AuthenticationCookieAuth
Consumesapplication/json
Producesapplication/json

Parameters

2 parameters

Name
Location
Required
Type
Description
idpathyesintegerTask ID
requestbodynoobjectSchedule parameters: interval_sec (>0), agent, interface, down_ms, up_timeout_ms; empty agent/interface values mean all agents and configured task ports
  • {}

Responses

4 responses

Status
Description
Type
200
Response: {status: ok, results: {host: ...}}object
400
Invalid task IDobject
401
Unauthorizedobject
500
Task is not running, has no agents, or the command could not be sent (includes per-agent results)object
  • {}
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {}