audit_plan

获取扫描任务信息列表

get audit plan info list

get/v1/projects/{project_name}/audit_plans

Request

  • Base URL
    /sqle (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /sqle/v1/projects/{project_name}/audit_plans
  • Auth
    API key in header Authorization

Path parameters

project_namestring required

project name

Query parameters

filter_audit_plan_db_typestring

filter audit plan db type

fuzzy_search_audit_plan_namestring

fuzzy search audit plan name

filter_audit_plan_typestring

filter audit plan type

filter_audit_plan_instance_namestring

filter audit plan instance name

page_indexinteger required

page index

page_sizeinteger required

size of per page

Response

OK

codeinteger
messagestring
total_numsinteger

Example response

{
  "data": [
    {
      "audit_plan_cron": "0 */2 * * *",
      "audit_plan_db_type": "mysql",
      "audit_plan_instance_database": "app1",
      "audit_plan_instance_name": "test_mysql",
      "audit_plan_name": "audit_for_java_app1",
      "audit_plan_token": "it's a JWT Token for scanner",
      "rule_template_name": "default_MySQL"
    }
  ],
  "message": "ok"
}

Changes

No recorded changes to this operation across all 75 revisions of this API.