自定义域名 - 开发者

笔记

高级

API key 应该在请求时在Authorization请求头发送获取你的 API key.

列表

API端点:

GET

https://u5k.cn/api/v1/domains

请求示例:

curl --location --request GET 'https://u5k.cn/api/v1/domains' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

参数

类型

描述

search

可选 string

搜索查询

search_by

可选 string

搜索. 可能的值: name 为名称. 默认为: name.

sort_by

可选 string

排序. 可能的值: id 为创建时间, name 为名称. 默认为: id.

sort

可选 string

排序. 可能的值: desc 为降序, asc 为升序. 默认为: desc.

per_page

可选 int

每页结果. 可能的值: 10, 25, 50, 100. 默认为: 10.

展示

API端点:

GET

https://u5k.cn/api/v1/domains/{id}

请求示例:

curl --location --request GET 'https://u5k.cn/api/v1/domains/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

保存

API端点:

POST

https://u5k.cn/api/v1/domains

请求示例:

curl --location --request POST 'https://u5k.cn/api/v1/domains' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'

参数

类型

描述

name

必须 string

域名名称

index_page

可选 string

打开首页将跳转到

not_found_page

可选 string

404页面将跳转到

更新

API端点:

PUT PATCH

https://u5k.cn/api/v1/domains/{id}

请求示例:

curl --location --request PUT 'https://u5k.cn/api/v1/domains/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

参数

类型

描述

index_page

可选 string

打开首页将跳转到

not_found_page

可选 string

404页面将跳转到

删除

API端点:

DELETE

https://u5k.cn/api/v1/domains/{id}

请求示例:

curl --location --request DELETE 'https://u5k.cn/api/v1/domains/{id}' \
--header 'Authorization: Bearer {api_key}'