POST | Activate Network Connector agent

Prev Next

Description

Activate a deactivated Network Connector agent. The agent returns on the same port and keeps its fingerprint.

After activation, devices can be linked to the agent again through the network_connector_id field.


Prerequisites


Request

POST /api/v2/platform/network-connector/agents/{agent_id}/activate

Path parameters

Field Type Required Description
agent_id integer Yes Unique identification code of the agent. Accepts digits only. To find deactivated agents, access GET | List all Network Connector agents with active=false.

This action takes no request body and does not require the If-Match header.


Example request

POST {{url}}/api/v2/platform/network-connector/agents/12/activate


Response

HTTP/1.1 204 No Content

The response has no body. The ETag header carries the agent's new state.


Errors

HTTP code Message Possible cause Solution
403 api.auth.insufficient_permission The application's PAM resource permission is Read-only. Ask the administrator to set the PAM resource permission to Read and write in A2A.
404 api.resource.not_found The agent does not exist. Check the identification code sent in the path.
404 api.route.not_found The agent_id value is not made up of digits only. Send the agent's identification code using digits only.
409 api.resource.conflict.already_active The agent is already active. No action is needed. The agent is already in the requested state.

For authentication errors, rate limits, and the error response format, access API v2 - Conventions and shared behaviors.

Example error response

409 the agent is already active:

{
    "code": "api.resource.conflict.already_active",
    "message": "Network connector agent is already active.",
    "details": null
}

Related documents