Job API

Create Job

POST /discovery-jobs

Create job.

Parameter Name	Required	Type	Description
name	Yes	string	-
template_id	No	integer	Default: 1
schedule	No	string	Default: OnDemand
description	No	string	-
range	No	integer	Default:1
depth_structured	No	integer	Default:100
depth_unstructured	No	integer	Default:10
detection_threshold	No	number	Default:0.2
all_s3	No	integer	-
all_rds	No	integer	-
all_ddb	No	integer	-
all_emr	No	integer	-
all_glue	No	integer	-
all_jdbc	No	integer	-
overwrite	No	integer	-
exclude_keywords	No	string	-
include_keywords	No	string	-
exclude_file_extensions	No	string	-
include_file_extensions	No	string	-
provider_id	No	integer	-
database_type	No	string	-
databases	Yes	array	The structure of each element is as follows { "account_id": "string", "region": "string", "database_type": "string", "database_name": "string", "table_name": "string" }

Response Examples

Success

{
  "status": "success",
  "code": 1001,
  "message": "Operation succeeded"
}

HTTP Status Code	Meaning	Description	Data schema
1001	OK	Success	Inline

HTTP Status Code 1001

Name	Type	Required	Restrictions	Title	description
» message	string	true	none		none
» code	integer	true	none		none

POST /discovery-jobs/{job_id}/start

start job.

Parameter Name	Required	Type	Description
job_id	Yes	integer	-

Response Examples

Success

{
  "status": "success",
  "code": 1001,
  "message": "Operation succeeded"
}

HTTP Status Code	Meaning	Description	Data schema
1001	OK	Success	Inline

HTTP Status Code 1001

Name	Type	Required	Restrictions	Title	description
» message	string	true	none		none
» code	integer	true	none		none