九游平台/ 漏洞管理服务 codearts inspector/ api参考/ / / 更新网站配置
更新时间：2024-10-14 gmt 08:00

更新网站配置-九游平台

功能介绍

更新网站登录配置

调试

您可以在中调试该接口，支持自动认证鉴权。api explorer可以自动生成sdk代码示例，并提供sdk代码示例调试功能。

uri

post /v3/{project_id}/webscan/domains/settings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

string

用户的project_id，获取方法请参见获取项目id。

最小长度：32

最大长度：32

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

用户token，通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。

最小长度：1

最大长度：102400
表3 请求body参数

参数

是否必选

参数类型

描述

domain_id

是

string

网站域名id

最小长度：32

最大长度：32

login_url

否

string

网站需要登录时，设置登录页面

最小长度：0

最大长度：2048

login_username

否

string

网站需要登录时，设置登录用户名

最小长度：0

最大长度：256

login_password

否

string

当网站需要登录时，设置登录密码；当获取网站配置时，若返回值为“***”，表示用户已设置登录密码，若返回值为null表示用户未设置登录密码

最小长度：0

最大长度：50

login_cookies

否

string

当网站需要登录时，设置登录cookie；获取网站配置时，如果返回值是“***”，表示用户已设置登录cookie，若返回值为null表示用户未设置登录cookie

最小长度：0

最大长度：21845

verify_url

否

string

设置用于验证登录是否成功的网址

最小长度：0

最大长度：2048

http_headers

否

map

设置自定义http请求头；获取网站配置时，如果key对应value值是“***”，表示用户已设置此key对应的内容，如果key对应的value值为null表示用户未设置value值

响应参数

状态码： 200

表4 响应body参数

参数

参数类型

描述

info_code

string

状态码:

  • success - 成功

  • failure - 失败

枚举值：

  • success

  • failure

info_description

string

返回的提示信息

最小长度：0

最大长度：64

状态码： 400

表5 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

状态码： 401

表6 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

状态码： 418

表7 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

请求示例

post https://{endpoint}/v3/{project_id}/webscan/domains/settings
{
  "domain_id" : "2ec0993b8572455aacf14b6f9288b167",
  "login_url" : "https://127.0.0.1:8080/login"
}

响应示例

状态码： 200

ok

{
  "info_code" : "success",
  "info_description" : "operation succeeded"
}

状态码

状态码

描述

200

ok

400

bad request

401

unauthorized

418

i'm a teapot

错误码

请参见错误码。

父主题：

相关文档

网站地图