Phishing Hunter API (1.0)

Download OpenAPI specification:Download

scanner

スキャン対象のドメイン一覧の取得

Authorizations:

custom_authorizer

Responses

Response samples

200
500

Content type

application/json

{"domains": ["www.google.com"
]
}

スキャン対象のドメインの追加

Authorizations:

custom_authorizer

Request Body schema: application/json

domain

string

Responses

Request samples

Payload

Content type

application/json

{"domain": "www.google.com"
}

Response samples

200
500

Content type

application/json

{"result": true
}

スキャン対象のドメイン一覧の削除

Authorizations:

custom_authorizer

Request Body schema: application/json

domain

string

Responses

Request samples

Payload

Content type

application/json

{"keywords": ["paypal",
"icloud",
"gmail"
],
"target_score": 100,
"webhook_url": "https://xxxx"
}

Response samples

200
500

Content type

application/json

{"result": true
}

hunting

ハンティング設定の取得

Authorizations:

custom_authorizer

Responses

Response samples

200
500

Content type

application/json

{"keywords": {"domain": ["paypal",
"icloud",
"gmail"
],
"dom": ["pay"
]
},
"target_score": 100
}

ハンティング設定の更新

Authorizations:

custom_authorizer

Request Body schema: application/json

	object
target_score	integer

Responses

Request samples

Payload

Content type

application/json

{"keywords": {"domain": ["paypal",
"icloud",
"gmail"
],
"dom": ["pay"
]
},
"target_score": 100
}

Response samples

200
500

Content type

application/json

{"result": true
}

observation

監視対象ドメイン一覧の取得

Authorizations:

custom_authorizer

Responses

Response samples

200
500

Content type

application/json

{"observation_urls": {"http://example-hoge.com": {"period": 1,
"rule_name": "obs_job_555906eaebef4f7fa2db61530b5bd9b7",
"expire": 1671580800,
"api_config": {"urlscan": {"visibility": "unlisted"
}
},
"created_at": 1671010527,
"comment": "test comment",
"interval": "hour"
}
}
}

監視対象ドメインの追加

Authorizations:

custom_authorizer

Request Body schema: application/json

url	string
interval	string
period	integer
comment	string
expire	integer
	object

Responses

Request samples

Payload

Content type

application/json

{"url": "http://example-hoge.com",
"interval": "hour",
"period": 1,
"comment": "",
"expire": 1671580800,
"api_config": {"urlscan": {"visibility": "unlisted"
}
}
}

Response samples

200
500

Content type

application/json

{"message": "string"
}

監視対象ドメインの削除

Authorizations:

custom_authorizer

Request Body schema: application/json

url

string

Responses

Request samples

Payload

Content type

application/json

{"url": "http://example-hoge.com"
}

Response samples

200
500

Content type

application/json

{"message": "string"
}

settings

通知設定の一覧を取得

Authorizations:

custom_authorizer

Responses

Response samples

200
500

Content type

application/json

{"hunting": {"type": "email",
"webhook_url": ""
},
"observation": {"type": "email",
"webhook_url": ""
}
}

通知設定の更新

Authorizations:

custom_authorizer

Request Body schema: application/json

type	string
webhook_url	string
service	string

Responses

Request samples

Payload

Content type

application/json

Example

example-email

{"type": "email",
"webhook_url": "",
"service": "hunting"
}

Response samples

200
500

Content type

application/json

{"result": true
}

外部サービス設定の取得

Authorizations:

custom_authorizer

Responses

Response samples

200
500

Content type

application/json

{"api_keys": {"urlscan": "",
"shodan": "",
"vt": ""
}
}

外部サービス設定の更新

Authorizations:

custom_authorizer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"api_keys": {"urlscan": "",
"shodan": "",
"vt": ""
}
}

Response samples

200
500

Content type

application/json

{"result": true
}

user

ユーザ情報の取得

ユーザを識別するための情報とAPI利用状況を返す

Authorizations:

custom_authorizer

Responses

Response samples

200
500

Content type

application/json

{"quota": {"domain_keywords": 10,
"observations": 5,
"scanner": 3
},
"user_plan": "free"
}

APIキーの一覧を取得

Authorizations:

custom_authorizer

Responses

Response samples

200
500

Content type

application/json

{"api_keys": { }
}

APIキーの作成

Authorizations:

custom_authorizer

Request Body schema: application/json

description	string
ip	Array of strings
scope	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"description": "test api key",
"ip": ["127.0.0.1",
"192.168.0.1/24"
],
"scope": ["get:hunting",
"get:users_info"
]
}

Response samples

200
500

Content type

application/json

{"api_key": "pk_xxxxxxxxxxxxxxxxxxxxxxx"
}

APIキーの削除

Authorizations:

custom_authorizer

Request Body schema: application/json

api_key

string

Responses

Request samples

Payload

Content type

application/json

{"api_key": "string"
}

Response samples

200
500

Content type

application/json

{"message": "api key deleted"
}