Whitelists

The link provided below directs to a detailed page that elaborates on the concept of a whitelist within our system.

IP Whitelisting

---

It's important to note that almost every endpoint related to whitelists, with the notable exceptions of the index and delete endpoints, will return a whitelist entry resource upon a successful call.

WhitelistEntryResource

{
    "hash": "01HQ5K3P97DY8EX9Y90YT1K6XA",
    "ip": "192.0.2.1",
    "port": "23234",
    "type": "http|https",
    "configuration": "_country-br_streaming-1_skipispstatic-1"
}

---

Create Whitelist Entry

POST /residential-users/{ residential_user_hash }/whitelist-entries

Query Parameters

Name	Type	Description
residential_user_hash	String	Hash of the user

Body Parameters

Name	Type	Description
ip	String	Ip of the entry
port	Integer	Port that will be used
configuration	String	Proxy configuration

Get Whitelist Entry

GET /residential-users/{ residential_user_hash }/whitelist-entries/{ whitelist_entry_hash }

Query Parameters

Name	Type	Description
residential_user_hash	String	Hash of the user
whitelist_entry_hash	String	Hash of the entry

Get Whitelist Entries

GET /residential-users/{ residential_user_hash }/whitelist-entries/

Query Parameters

Name	Type	Description
residential_user_hash	String	Hash of the user
page	Integer	Number of the page
per_page	Integer	Number of whitelist entries per page

Update Whitelist Entry

UPDATE /residential-users/{ residential_user_hash }/whitelist-entries/{ whitelist_entry_hash }

Query Parameters

Name	Type	Description
residential_user_hash	String	Hash of the user
whitelist_entry_hash	String	Hash of the entry

Body Parameters

Name	Type	Description
configuration	String	Proxy configuration

Delete Whitelist Entry

DELETE /residential-users/{ residential_user_hash }/whitelist-entries/{ whitelist_entry_hash }

Query Parameters

Name	Type	Description
residential_user_hash	String	Hash of the user
whitelist_entry_hash	String	Hash of the entry