Change the proxy password

Returns the new password. The previous password remains valid for a two-minute overlap. Update every client promptly. For an uncertain response, retry with the same Idempotency-Key within 23 hours; do not create a new key for that retry. A replay does not change the password again or restart the overlap. Without a retry key, retrieve the current password with proxy:read before deciding whether another password change is needed.

post/v1/services/{id}/rotate-password

Request

  • Base URL: https://api.trueproxies.com
  • URL: https://api.trueproxies.com/v1/services/{id}/rotate-password
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

customer_idstring uuid

Owned sub-customer UUID. Resellers only; reads require reseller:read and writes reseller:purchase in addition to the operation scope. X-Customer-Id header is an alternative. Not allowed for me, wallet, trial, API keys, or reseller-management routes.

Headers

Idempotency-Keystring

Optional retry key, formatted as creation time in Unix milliseconds followed by a dot and a UUID. Reuse for retries within 23 hours. Older keys are rejected.

Response

ok

passwordstring required
rotated_atstring date-time required
username_basestring required

Changes

No recorded changes to this operation across all 1 revision of this API.