Skip to content

Reset an order's proxy password

POST
/reset-password
curl --request POST \
--url https://api.proxyrequest.com/api/v1/reset-password \
--header 'Content-Type: application/json' \
--data '{ "order_id": "550e8400-e29b-41d4-a716-446655440003" }'

Rotates the proxy password for the order identified by order_id. Existing proxy connection strings stop working after the rotation; use the updated proxy password for all new connections.

  • None
object
order_id
required
string format: uuid
Examples
ExampleResetOrderPassword

Reset order password

{
"order_id": "550e8400-e29b-41d4-a716-446655440003"
}

The operation completed successfully.

Media typeapplication/json
object
message
required
string
success
required
boolean
Examples
ExamplePasswordReset

Password reset

{
"message": "Password reset successfully.",
"success": true
}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleValidationError

Validation error

{
"non_field_errors": [
"The request could not be processed."
],
"translation": "errors.request.invalid"
}

The requested resource does not exist in the current account scope.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleResourceNotFound

Resource not found

{
"detail": "Not found."
}