Set auto-renew preference
/api/v1/servers/:id/autorenew
Save the site's auto-renew preference.
Before you call
This does not renew or cancel a supplier contract. The current supplier renewal integration is unavailable.
Request example
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/autorenew" -X POST \
-H "Authorization: Bearer $TOVAHUB_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"enabled": true,
"requestKey": "docs_example_001"
}'Examples only. No requests are sent from this page.
Illustrative response
{
"ok": true,
"enabled": true,
"supplierRenewalReady": false
}Parameters
idPath · Requiredstring
Resource ID: 24 hexadecimal characters. Use the platform ID returned by the matching list endpoint, not a supplier instance ID.
enabledJSON body · Requiredboolean
The new enabled state.
requestKeyJSON body · Requiredstring
8–100 characters: A–Z, a–z, 0–9, underscore or hyphen. Keep the same key and identical input when retrying the same operation.
Response
HTTP status 200
Save the site's auto-renew preference without renewing a supplier contract.
okboolean (true)The preference was saved or replayed.
enabledbooleanSaved original preference value.
replayboolean (true, optional)Present only when the same request is replayed.
supplierRenewalReadyboolean (false)The current supplier renewal integration is unavailable.