Skip to content

Commit e591acb

Browse files
ichikawayichikaway
authored
Merge pull request #3 from vaddy/scan-type-auth-header
Scan type auth header
2 parents 3a066aa + a33031a commit e591acb

10 files changed

+59
-37
lines changed

‎V1/VAddy-WebApi-Crawl-ja.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Crawl Document
22
============================
33

4-
Document Version 1.0.2
4+
Document Version 1.0.4
55

66
VAddy WebAPI Crawl仕様書です。
77
本仕様では、VAddyのクロール情報の取得を定義します。
@@ -29,9 +29,10 @@ page, sort, search_labelはオプション項目です。検索結果は1回で
2929
- sortはasc(昇順)もしくはdesc(降順)を指定します。指定しない場合はデフォルトはdescです。
3030
- search_labelを付けない場合は全てのクロール情報を対象に一覧を取得します。search_labelを付けると、指定のキーワードで部分一致した検索結果を返します。
3131

32-
auth_keyは、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
33-
管理画面のUser Idをuserパラメータに、API Auth Keyをauth_keyパラメータにセットしてください。
3432

33+
`auth_key`は、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
34+
管理画面のログインIDを`user`パラメータに、API Auth Keyを`auth_key`パラメータにセットしてください。
35+
`auth_key` はHTTPヘッダーの `X-API-KEY` に指定することもできます。
3536

3637
#### リクエスト例 (最新の30件を取得)：
3738

‎V1/VAddy-WebApi-Crawl.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Crawl Document
22
======================
33

4-
Document Version 1.0.2
4+
Document Version 1.0.4
55

66
This specification defines to operate crawling information.
77

@@ -30,8 +30,11 @@ Parameters of page, sort, search_label are optional. Each request can fetch at m
3030
- sort parameter: asc or desc. Default is desc.
3131
- search_label parameter: Partial-word search. Default is null(search all records).
3232

33-
The auth_key is WebAPI authentication key. You can get/create this key on VAddy management page(https://console.vaddy.net/user/webapi).
34-
Set Your UserID(LoginID) of VAddy management page on the user parameter.
33+
The `auth_key` is WebAPI authentication key. You can create this key on VAddy management page(https://console.vaddy.net/user/webapi).
34+
The `auth_key` can also be specified by `X-API-KEY` in http header.
35+
36+
Set Your UserID(LoginID) of VAddy management page on `user` parameter.
37+
3538

3639

3740

‎V1/VAddy-WebApi-ja.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Scan Document
22
======================
33

4-
Document Version 1.0.3
4+
Document Version 1.0.4
55

66
VAddy WebAPI仕様書です。
77
本仕様では、VAddyのスキャン開始、スキャンキャンセル、スキャン結果の取得の3つを定義します。
@@ -22,9 +22,10 @@ Method : POST
2222

2323
crawl_idはオプション項目です。指定がない場合は最新のクロールデータを利用して検査します。クロールIDの値は、管理画面にログインし、Proxy Crawling画面からご確認ください。
2424

25-
auth_keyは、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
26-
管理画面のUser Idをuserパラメータに、API Auth Keyをauth_keyパラメータにセットしてください。
2725

26+
`auth_key`は、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
27+
管理画面のログインIDを`user`パラメータに、API Auth Keyを`auth_key`パラメータにセットしてください。
28+
`auth_key` はHTTPヘッダーの `X-API-KEY` に指定することもできます。
2829

2930
### Scan開始レスポンス
3031
#### 成功

‎V1/VAddy-WebApi.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Scan Document
22
======================
33

4-
Document Version 1.0.3
4+
Document Version 1.0.4
55

66
This specification defines "start scan", "cancel scan" and "get scan results".
77

@@ -23,8 +23,11 @@ Method : POST
2323

2424
"crawl_id" is optional. If you don't specify it, VAddy uses the latest crawl data for scan. You can see the crawl ID number in the Proxy Crawling page of console page.
2525

26-
The auth_key is WebAPI authentication key. You can create this key on VAddy management page(https://console.vaddy.net/user/webapi).
27-
Set Your UserID(LoginID) of VAddy management page on user parameter.
26+
The `auth_key` is WebAPI authentication key. You can create this key on VAddy management page(https://console.vaddy.net/user/webapi).
27+
The `auth_key` can also be specified by `X-API-KEY` in http header.
28+
29+
Set Your UserID(LoginID) of VAddy management page on `user` parameter.
30+
2831

2932

3033

‎VAddy-WebApi-Crawl-ja.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Crawl Document
22
============================
33

4-
Document Version 2.0.0
4+
Document Version 2.0.1
55

66
VAddy WebAPI Crawl仕様書です。
77
本仕様では、VAddyのクロール情報の取得を定義します。
@@ -28,10 +28,11 @@ page, sort, search_labelはオプション項目です。検索結果は1回で
2828
- sortはasc(昇順)もしくはdesc(降順)を指定します。指定しない場合はデフォルトはdescです。
2929
- search_labelを付けない場合は全てのクロール情報を対象に一覧を取得します。search_labelを付けると、指定のキーワードで部分一致した検索結果を返します。
3030

31-
auth_keyは、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
32-
管理画面のUser Idをuserパラメータに、API Auth Keyをauth_keyパラメータにセットしてください。
31+
`auth_key`は、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
32+
管理画面のログインIDを`user`パラメータに、API Auth Keyを`auth_key`パラメータにセットしてください。
33+
`auth_key` はHTTPヘッダーの `X-API-KEY` に指定することもできます。
3334

34-
project_idは、検査対象サーバを管理するID。 Server画面にProjectIDとして表示されます。
35+
`project_id`は、検査対象サーバを管理するID。 Server画面にProjectIDとして表示されます。
3536

3637
#### リクエスト例 (最新の30件を取得)：
3738

‎VAddy-WebApi-Crawl.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Crawl Document
22
======================
33

4-
Document Version 2.0.0
4+
Document Version 2.0.1
55

66
This specification defines to operate crawling information.
77

@@ -29,10 +29,11 @@ Parameters of page, sort, search_label are optional. Each request can fetch at m
2929
- sort parameter: asc or desc. Default is desc.
3030
- search_label parameter: Partial-word search. Default is null(search all records).
3131

32-
The auth_key is WebAPI authentication key. You can get/create this key on VAddy management page(https://console.vaddy.net/user/webapi).
33-
Set Your UserID(LoginID) of VAddy management page on the user parameter.
3432

33+
The `auth_key` is WebAPI authentication key. You can create this key on VAddy management page(https://console.vaddy.net/user/webapi).
34+
The `auth_key` can also be specified by `X-API-KEY` in http header.
3535

36+
Set Your UserID(LoginID) of VAddy management page on `user` parameter.
3637

3738
#### Request example
3839

‎VAddy-WebApi-CrawlDelete-ja.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Crawl Delete Document
22
============================
33

4-
Document Version 2.0.0
4+
Document Version 2.0.1
55

66
VAddy WebAPI クロールデータ削除の仕様書です。
77

@@ -22,10 +22,11 @@ Method : POST
2222
crawl_id=2
2323

2424

25-
auth_keyは、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
26-
管理画面のUser Idをuserパラメータに、API Auth Keyをauth_keyパラメータにセットしてください。
25+
`auth_key`は、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
26+
管理画面のログインIDを`user`パラメータに、API Auth Keyを`auth_key`パラメータにセットしてください。
27+
`auth_key` はHTTPヘッダーの `X-API-KEY` に指定することもできます。
2728

28-
project_numberは、プロジェクト単位で自動付与される数字の番号です。
29+
`project_number`は、プロジェクト単位で自動付与される数字の番号です。
2930
https://console.vaddy.net/project/123
3031
のように各プロジェクト画面のURLの末尾にある数字がproject_numberです。
3132
project_idとは異なりますのでご注意ください。

‎VAddy-WebApi-ScanResultList-ja.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Scan Result List Document
22
============================
33

4-
Document Version 2.0.0
4+
Document Version 2.0.1
55

66
VAddy WebAPI 検査結果一覧取得の仕様書です。
77

@@ -20,10 +20,12 @@ Method : GET
2020

2121
検索結果は1回で最大20件取得できます。結果は最新順（降順）になります。
2222

23-
auth_keyは、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
24-
管理画面のUser Idをuserパラメータに、API Auth Keyをauth_keyパラメータにセットしてください。
23+
`auth_key`は、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
24+
管理画面のログインIDを`user`パラメータに、API Auth Keyを`auth_key`パラメータにセットしてください。
25+
`auth_key` はHTTPヘッダーの `X-API-KEY` に指定することもできます。
2526

26-
project_numberは、プロジェクト単位で自動付与される数字の番号です。
27+
28+
`project_number`は、プロジェクト単位で自動付与される数字の番号です。
2729
https://console.vaddy.net/project/123
2830
のように各プロジェクト画面のURLの末尾にある数字がproject_numberです。
2931
project_idとは異なりますのでご注意ください。

‎VAddy-WebApi-ja.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Scan Document
22
======================
33

4-
Document Version 2.0.1
4+
Document Version 2.0.2
55

66
VAddy WebAPI仕様書です。
77
本仕様では、VAddyのスキャン開始、スキャンキャンセル、スキャン結果の取得の3つを定義します。
@@ -18,13 +18,17 @@ Method : POST
1818
auth_key=123456
1919
project_id=6eb1f9fcbdb6a5a
2020
crawl_id=30
21+
scan_type="SQLI,XSS,RFI,..."
2122

22-
crawl_idはオプション項目です。指定がない場合は最新のクロールデータを利用して検査します。クロールIDの値は、管理画面にログインし、Proxy Crawling画面からご確認ください。
23+
`crawl_id`はオプション項目です。指定がない場合は最新のクロールデータを利用して検査します。クロールIDの値は、管理画面にログインし、Proxy Crawling画面からご確認ください。
2324

24-
auth_keyは、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
25-
管理画面のUser Idをuserパラメータに、API Auth Keyをauth_keyパラメータにセットしてください。
25+
`scan_type` はオプション項目です。指定が無い場合は全ての検査が実行されます。カンマ区切りで指定します。設定できる検査項目の一覧はこちらをご覧ください。 [検査項目指定オプションの一覧](https://github.com/vaddy/WebAPI-document/blob/master/VAddy-WebApi-ScanType.md)
2626

27-
project_idは、検査対象サーバを管理するID。 Server画面にProjectIDとして表示されます。
27+
`auth_key`は、ユーザ毎に発行する認証キーです。VAddyログイン後のWebAPI管理画面にて取得してください。
28+
管理画面のログインIDを`user`パラメータに、API Auth Keyを`auth_key`パラメータにセットしてください。
29+
`auth_key` はHTTPヘッダーの `X-API-KEY` に指定することもできます。
30+
31+
`project_id`は、検査対象サーバを管理するID。 Server画面にProjectIDとして表示されます。
2832

2933
### Scan開始レスポンス
3034
#### 成功

‎VAddy-WebApi.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
VAddy Web API Scan Document
22
======================
33

4-
Document Version 2.0.1
4+
Document Version 2.0.2
55

66
This specification defines "start scan", "cancel scan" and "get scan results".
77

@@ -19,13 +19,18 @@ Method : POST
1919
auth_key=123456
2020
project_id=6eb1f9fcbdb6a5a
2121
crawl_id=30
22+
scan_type="SQLI,XSS,RFI,..."
2223

23-
"crawl_id" is optional. If you don't specify it, VAddy uses the latest crawl data for scan. You can see the crawl ID number in the Proxy Crawling page of console page.
24+
`crawl_id` is optional. If you don't specify it, VAddy uses the latest crawl data for scan. You can see the crawl ID number in the Proxy Crawling page of console page.
2425

25-
The auth_key is WebAPI authentication key. You can create this key on VAddy management page(https://console.vaddy.net/user/webapi).
26-
Set Your UserID(LoginID) of VAddy management page on user parameter.
26+
`scan_type` is optional. [Scan type list document](https://github.com/vaddy/WebAPI-document/blob/master/VAddy-WebApi-ScanType.md)
2727

28-
The project_id is grouping ID for scan target servers. It shows on the server menu of VAddy console screen.
28+
The `auth_key` is WebAPI authentication key. You can create this key on VAddy management page(https://console.vaddy.net/user/webapi).
29+
The `auth_key` can also be specified by `X-API-KEY` in http header.
30+
31+
Set Your UserID(LoginID) of VAddy management page on `user` parameter.
32+
33+
The `project_id` is grouping ID for scan target servers. It shows on the server menu of VAddy console screen.
2934

3035

3136
### Scan Start Response

0 commit comments

Comments
 (0)