Manage port contract renewal
Schedule a port contract renewal or remove a scheduled port contract renewal.
Schedule port contract renewal
Schedule a port contract renewal.
Request
| Endpoint: | /api/ports/<port_id>/renew |
| Method: | POST |
| Headers: | Accept: application/vnd.cloudlx.v1+json |
| Authorization: Bearer <access_token> |
Example Request:
{
"renewal_date": "2024-05-16",
"period": 24
}
Request Values
| renewal_date | Description | The date on which you wish the contract to renew. |
| Type | Date | |
| Example | 2024-05-16 | |
| period | Description | The number of months to renew the contract for. Either; 12, 24 or 36. |
| Type | Integer | |
| Example | 24 |
Response
Example:
{
"success": true,
"message": "Port updated successfully"
}
Remove scheduled port contract renewal
Remove a scheduled a port contract renewal.
Request
| Endpoint: | /api/ports/<port_id>/renew |
| Method: | POST |
| Headers: | Accept: application/vnd.cloudlx.v1+json |
| Authorization: Bearer <access_token> |
Example Request:
{
"renewal_date": null,
"period": null
}
Request Values
| renewal_date | Description | The date on which you wish the contract to renew. |
| Type | Null | |
| Example | null | |
| period | Description | A null value |
| Type | Null | |
| Example | null |
Response
Example:
{
"success": true,
"message": "Port updated successfully"
}