Skip to main content
POST
/
orders
/
{order_id}
/
sync
Sync proxy state
curl --request POST \
  --url https://api.proxyjam.com/public/v1/orders/{order_id}/sync \
  --header 'X-API-Key: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.proxyjam.com/llms.txt

Use this file to discover all available pages before exploring further.

Fetches the current state of a proxy directly from the provider and updates the local record. Use this when you suspect the locally stored data (status, expiry, credentials, bandwidth) is stale.

Path parameters

order_id
string
required
UUID of the order.

Response

Fresh proxy object after the provider sync. Same shape as the managed_proxy object in Get order.
This endpoint makes a live call to the upstream provider. Response times may be higher than other endpoints.

Example

curl -X POST "https://api.proxyjam.com/public/v1/orders/997b4450-e7ae-4ad9-8a25-996e582049c9/sync" \
  -H "X-API-Key: pj_AbCdEf..."