白名单

下面提供的链接指向一个详细的页面,详细说明了我们系统中的“白名单”的概念。

IP白名单


值得注意的是,几乎所有端点都与白名单相关,除了indexdelete 等值得注意的例外情况外,将在成功调用时返回白名单条目资源。

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

创建白名单条目

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

查询参数

名称
类型
描述

residential_user_hash

字符串

用户的哈希值

正文参数

名称
类型
描述

ip

字符串

条目的IP

port

整型

将要使用的端口

configuration

字符串

代理配置

note

字符串

备注

請求範例

响应示例:

获取白名单条目

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

查询参数

名称
类型
描述

residential_user_hash

字符串

用户的哈希值

whitelist_entry_hash

字符串

条目的哈希值

請求範例

响应示例:

获取多个白名单条目

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

查询参数

名称
类型
描述

residential_user_hash

字符串

用户的哈希值

page

整型

页码

per_page

整型

每页的白名单条目数

請求範例

响应示例:

更新白名单条目

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

查询参数

名称
类型
描述

residential_user_hash

字符串

用户的哈希值

whitelist_entry_hash

字符串

条目的哈希值

正文参数

名称
类型
描述

configuration

字符串

代理配置

note

字符串

备注

請求範例

响应示例:

删除白名单条目

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

查询参数

名称
Type
描述

residential_user_hash

字符串

用户的哈希值

whitelist_entry_hash

字符串

条目的哈希值

請求範例

Last updated