Skip to main content

Disable and restore interfaces once

POST
/tasks/interface/flap/{id}

Accepts a one-time interface outage for background execution. The controller responds immediately after validating the task and selected agents; the agent restores the port and verifies recovery itself. Fields: agent selects one agent, interface selects one PCI device, down_ms is the outage duration, and up_timeout_ms is the maximum wait for the Up state (30,000 ms by default).

Contract

Parameter
Value
Sectiontasks
AuthenticationCookieAuth
Consumesapplication/json
Producesapplication/json

Parameters

2 parameters

Name
Location
Required
Type
Description
idpathyesintegerTask ID
requestbodynoobjectOne-time outage parameters: agent, interface, down_ms, up_timeout_ms; empty agent/interface values mean all agents and configured task ports
  • {}

Responses

4 responses

Status
Description
Type
202
Command accepted: {status: accepted}; interface restoration continues in the backgroundobject
400
Invalid task IDobject
401
Unauthorizedobject
500
Task is not running, has no agents, or the selected agent is not assigned to itobject
  • {}
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {}