Operation - Renew DHCP Lease.adoc

Operation - Renew DHCP Lease

The DHCP lease can be renewed by sending a HTTP POST to /api/edge/operation/renew-dhcp.json.

It does not support a HTTP GET.

This method is CSRF protected so also requires a X-CSRF-TOKEN (see Sensitive Requests (CSRF Protection)).

Table of Contents

• Request
  • Request Content
• Response
  • Root
  • OPERATION Object
• Examples
  • Unsuccessful DHCP Lease Renewal

Request

Request Content

Name	Type	Values	Description
interface	String	Interface	The specific interface to request to renew the DHCP lease (e.g. eth0).

Response

Root

Name	Type	Values	Description
OPERATION	Object	OPERATION object	The operation result information.
success	Boolean	true or false	Whether the API request was successful.

OPERATION Object

Name	Type	Values	Description
success	String	A boolean encapsulated in a string (e.g. "0" or "1")	Whether the request to renew the DHCP lease was successful.
error (Optional)	String	String	Why the API request was unsuccessful.

Examples

Unsuccessful DHCP Lease Renewal

GET /api/edge/operation/renew-dhcp.json Request

interface=eth0

GET /api/edge/operation/renew-dhcp.json Response

{"OPERATION": {"success": "0", "error": "OPERATION request failed"}, "success": true}