自定义域名 - API文档

笔记

专家级

应用API接口密钥应该作为承载令牌在请求的授权头中发送获取您的应用API接口密钥.

API 接口:

GET

https://yyds.lt/api/v1/domains

请求示例:

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

参数

类型

描述

search

可选择的 string

The search query.

search_by

可选择的 string

搜索依据. Possible values are: name for 名称. Defaults to: name.

sort_by

可选择的 string

Sort by. Possible values are: id for Date created, name for 名称. Defaults to: id.

sort

可选择的 string

分类. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.

per_page

可选择的 int

每页结果. Possible values are: 10, 25, 50, 100. Defaults to: 10.

显示

API 接口:

GET

https://yyds.lt/api/v1/domains/{id}

请求示例:

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

商店

API 接口:

POST

https://yyds.lt/api/v1/domains

请求示例:

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

参数

类型

描述

name

需要 string

The domain name.

index_page

可选择的 string

The index page to redirect to.

not_found_page

可选择的 string

The 404 page to redirect to.

更新

API 接口:

PUT PATCH

https://yyds.lt/api/v1/domains/{id}

请求示例:

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

参数

类型

描述

index_page

可选择的 string

The index page to redirect to.

not_found_page

可选择的 string

The 404 page to redirect to.

删除

API 接口:

DELETE

https://yyds.lt/api/v1/domains/{id}

请求示例:

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