Rename an edge instance, or enable or disable it

put

Authorizations

cookieapi_token

defguard_sessionstringRequired

Path parameters

proxy_idinteger · int64Required

ID of the edge instance.

Body

application/json

enabledbooleanRequired

namestringRequired

Responses

200

Edge instance updated.

application/json

addressstringRequired

certificate_expirystring · nullableOptional

certificate_serialstring · nullableOptional

connected_atstring · nullableOptional

core_client_cert_expirystring · nullableOptional

disconnected_atstring · nullableOptional

enabledbooleanRequired

idinteger · int64Required

modified_atstring · date-timeRequired

modified_bystringRequired

namestringRequired

portinteger · int32Required

versionstring · nullableOptional

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

404

Edge instance not found.

500

Unable to update edge instance.

application/json

put/api/v1/proxy/{proxy_id}

HTTPcURLJavaScriptPython

PUT /api/v1/proxy/{proxy_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "enabled": true,
  "name": "text"
}

{
  "address": "text",
  "certificate_expiry": null,
  "certificate_serial": null,
  "connected_at": null,
  "core_client_cert_expiry": null,
  "disconnected_at": null,
  "enabled": true,
  "id": 1,
  "modified_at": "2026-08-11T05:09:10.951Z",
  "modified_by": "text",
  "name": "text",
  "port": 1,
  "version": null
}