API and webhooks

Connect dedicated IPs to your own systems. Through the API you can list IPs, check usage, place orders, change IPs and buy data packs, and webhooks notify you of changes such as activation, data usage and expiry. API access is included with every dedicated IP. See the API documentation for each endpoint's parameters and examples.

Create a key

1. 1
   On the website, open Dedicated IP in your dashboard, go to API and webhooks, and create a key.
2. 2
   Choose its access level: Read-only keys can list IPs and view details, usage and orders; Can order keys can also place orders, change IPs and buy data packs, which are charged to your balance.
3. 3
   Add an IP allowlist. Requests from addresses not on the list can't use the key.

• You can create up to 3 keys.
• If you suspect a key has been exposed, disable it and create a new one. The old key stops working immediately.

Making requests

• Send the key in the request header: Authorization: Bearer YOUR_KEY.
• Each account can make up to 60 requests per minute. Requests over the limit return 429.
• If you place an order with a Can order key and your balance is insufficient, the API returns 402. The order is kept and completes automatically once your top-up arrives.

Webhooks

1. 1
   Under API and webhooks, add a callback URL and select the events you want to receive: activated, data threshold reached, data used up (paused), expiring soon, expired (grace period), reclaimed after the grace period, auto-renew not charged, and monthly statement ready.
2. 2
   Each callback URL has its own signing secret. Every delivery includes an X-PDVPN-Signature header. Verify the signature as described in the API documentation, and process the event only if it matches.
3. 3
   If your endpoint doesn't return a 2xx response, the delivery is treated as undelivered and retried up to 5 times. You may receive the same event more than once, so use the event id to discard duplicates.