Skip to main content

Update Connection

PATCH 

/api/v1/connections/:connection_id

Update a connection.

For the config field, submitted values are MERGED with the existing decrypted config rather than overwriting it. Empty/None values in the submission mean "no change for this field" — this is what lets the edit form leave the password blank when the user only wants to change the host. Without merging, every edit would force the user to re-type every credential.

Summary​

PATCH /api/v1/connections/{connection_id} is an operation in the connections group of the Nexatron REST API, served from https://api.nexatron.io. Send an API key as a bearer token in the Authorization header. It takes the path parameter connection_id and a JSON body with no required fields. A successful call returns 200; the other documented responses are 400, 401, 403, 404 and 422.

Example request​

curl -X PATCH "https://api.nexatron.io/api/v1/connections/<connection_id>" \
-H "Authorization: Bearer $NEXATRON_API_KEY" \
-H "Content-Type: application/json" \
-d '{"clear_config_fields":[]}'

Placeholders in angle brackets stand for your own values. NEXATRON_API_KEY holds an API key from Settings → API tokens. See the API overview for authentication, errors and rate limits.

Request​

Responses​

Successful Response