Update details of a port
Update details of a port using the CloudLX port ID.
Request
Endpoint: | /api/ports/<port_id>/port |
Method: | POST |
Headers: | Accept: application/vnd.cloudlx.v1+json |
Authorization: Bearer <access_token> |
Example Request:
{
"name": "My new port name",
"term": {
"name": "Year",
"amount": 1
},
"deallocate": false
}
Request Values
name | Description | The new name for the port |
Type | String | |
Example | My new port name | |
term | Description |
The new terms for the port upon renewal. Changing the terms is only possible 30 days before renewal. Attempts to change the terms prior to this will result in an error. |
Type | Object | |
Example | See example above | |
deallocate | Description |
Whether to deallocate the port at the end of the current term Deallocating is only possible 30 days before renewal. Attempts to deallocate prior to this will result in an error. |
Type | Boolean | |
Example | true |
Response
Example:
{
"success": true,
"message": "Port updated successfully"
}