Enterprise Recon v1 API

All Documentation > Enterprise Recon v1 API > Scan Schedules

Scan Schedules

Use this set of APIs to perform tasks related to Scan Schedules.

List Scan Schedules

Retrieve information about all scan schedules across all Groups, Targets and Locations, or retrieve information for a specific scan schedule. By default, only upcoming scheduled scans will be returned in this query.

Request

GET

https://er-master:8339/v1/schedules/{schedule_id}

Authorization

Basic Authentication

Path Parameters

Parameter	Data Type	Description
schedule_id	string	Specify ID of the scan schedule to retrieve information for. If no value is specified, response returns data for all scan schedule. schedule_id is the id response item from the /v1/schedules endpoint.

Query Parameters

Parameter	Data Type	Description
offset	integer default: 0	The first scan schedule to return data for. For offset=N, data will be fetched starting from the Nth scan schedule. If no value is specified or offset=0, query will return data from the very first scan schedule. Scan schedules are sorted by time, where the most recent schedule will be listed first. Not applicable if a scan schedule ID is specified in the path.
limit	integer default: 1000 max: 100000	Maximum number of scan schedules to return data for, starting from the first record determined by the offset parameter value. Not applicable if a scan schedule ID is specified in the path.
details	boolean default: false	Show (true) or hide (false) certain details for scheduled scans (e.g. CPU priority, memory limit allocated for the scan, and notification events after the scan or search is complete).
name	string	Filter results for scan schedules with Target and/or Group names that begin with the specified query value. Partial matching allowed for this filter. For example, if name=default, response will only return results for scan schedules that include Group Default Group and/or Target Default Workstation.
<scan_status>	boolean enum: true false example: stopped=true&failed=true	Select scan schedules to display by scan status. completed: Default value is false. Set true to show completed scan schedules. deactivated: Default value is false. Set true to show deactivated scan schedules. cancelled: Default value is false. Set true to show cancelled scans. stopped: Default value is false. Set true to show stopped scan schedules. failed: Default value is false. Set true to show failed scan schedules. pending / active: Default value is true. Set false to hide upcoming scheduled scans. The pending query parameter is replaced by the active query parameter and will be deprecated in a future release of Enterprise Recon. processing blocked: Default value is true. Set false to hide scans with unprocessed scan results.
start_date	string <YYYYMMDD>	Specify a start date for fetching the scan schedules, formatted as YYYYMMDD (e.g. 20180125). Can be used with end_date parameter to specify a date range to retrieve scan schedules data.
end_date	string <YYYYMMDD>	Specify an end date for fetching the scan schedules, formatted as YYYYMMDD (e.g. 20180125). Can be used with start_date parameter to specify a date range to retrieve scan schedules data.
start_time	number	Retrieve scan schedules with a certain start time in terms of number of seconds from midnight. Used with the end_time parameter.
end_time	number	Retrieve scan schedules with a certain end time in terms of number of seconds from midnight. Used with start_time parameter.

Header Parameters

Parameter	Data Type	Description
Accept-Encoding	string enum: gzip deflate	Specify the compression algorithm to use on the response object. Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Parameter

Data Type

Description

Accept-Encoding

string

enum: gzip deflate

Specify the compression algorithm to use on the response object.
Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Request Samples

HTTP

GET /v1/schedules?details=true&stopped=true
Accept: application/json

cURL

curl --request GET 'https://er-master:8339/v1/schedules?details=true&stopped=true' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

200 OK

Parameter	Data Type	Description
id	string	Unique scan schedule ID.
label	string	Descriptive label for scan schedule.
status	string enum: completed deactivated pending active stopped cancelled failed	Describes the status of the scan schedule. The pending query parameter is replaced by the active query parameter and will be deprecated in a future release of Enterprise Recon.
repeat_days	integer <days>	Scan is repeated every Nth day.
repeat_months	integer <months>	Scan is repeated every N months.
profiles	string <array>	List of profile IDs describing the data type profiles that have been enabled for the scan. profile_id is the id response item from the /v1/datatypes/profiles endpoint.
next_scan	number	Time stamp for the next scheduled scan in Unix time format.
targets	object	Information on the Targets that are included for a scan schedule.
targets/id	string	Unique Target ID for the Target included in the scan schedule. target_id is the targets->id response item from the /v1/groups/all endpoint.
targets/name	string	Name identifying the Target included in the scan schedule.
targets/locations	object	Information on the Target Locations included for the scan schedule.
targets/locations/id	string	Unique location ID for the Target Location included in the scan schedule. location_id is the targets->locations->id response item from the /v1/groups/all endpoint.
targets/locations/name	string	Description of the Target type.
targets/locations/started	number	Timestamp for the scan start time in Unix time format.
targets/locations/updated	number	Timestamp for when the scan was last updated in Unix time format.
targets/locations/status	string enum: null searched error stalled processing indexing searching paused autopaused	Most recent search status for the Target location.
targets/locations/credential_id	string	Unique credential ID. Only returned if a specific login credential has been setup for the Target.
targets/locations/proxy_id	string	Unique proxy Agent ID. Only returned if a specific Agent has been set to act as a proxy host for the Target.
cpu	string default: low enum: low normal	CPU priority set for the Node Agent used for the scan. If a Proxy Agent is used, CPU priority will be set for the Proxy Agent on the Proxy Agent host. The default priority is low to keep Enterprise Recon's resource footprint low. Returned if details=true.
throughput	number <MBps>	Setting for the maximum disk I/O rate at which the scanning engine will read data from the Target host. Field will not be returned if not set (default throughput limit is unlimited). Unit is in MBps. Returned if details=true.
memory	integer <MB>	Setting for the maximum memory usage that the scanning engine can use on the Target host. Field will not be returned if not set (default memory limit is 1024 MB). Unit is in MB. Returned if details=true.
capture	boolean default: false enum: true false	Indicates if the scan has been setup to capture contextual data when matches are found. Contextual data can be viewed when displaying matches in the Enterprise Recon Web Console. When true, contextual data is captured during scans. Returned if details=true.
trace	boolean default: false enum: true false	Indicates if scan trace logs (a log of scan activities) are enabled for the scanned Targets. When true, scan trace logs are captured during the scan. Returned if details=true.
match_detail	string default: balanced enum: minimum balanced maximum	Setting for the amount of match details to be captured for the scan schedule. If not set, default match detail value is balanced. minimum captures the least amount of match details, while maximum captures the most match details for a scan and is recommended if required to perform masking remediation on match locations. Returned if details=true. See the Match Detail documentation for more information.
pause	object	Settings to pause and restart a scheduled scan. Requires the timezone parameter to be defined.
pause/days	number <NNNNNNN>	7-bit mask that describes the days of the week when a scan is scheduled to pause. The right-to-left masking bits represent Sunday to Saturday respectively. If days=33 (equivalent to 0100001), scan is paused for Sunday and Friday. If days=75 (equivalent to 1001011), scan is paused for Sunday, Monday, Wednesday and Saturday.
pause/start	integer <seconds>	The number of seconds before midnight to start pausing a scan in seconds. Returned if details=true.
pause/end	integer <seconds>	The number of seconds before midnight to stop pausing a scan in seconds. Returned if details=true.
notifications	object	Notifications policy for the scan. Returned if details=true.
notifications/emails	string <array>	Returns a list of email addresses that notifications will be sent to when certain events are triggered. The events that can trigger email or alert notifications have to be enabled in the Web Console. Returned if details=true.
notifications/users	string <array>	Returns a list of User IDs for users that will be notified when certain events are triggered. user_id is the id response item from the /v1/users endpoint. The events that can trigger email or alert notifications have to be enabled in the Web Console. Returned if details=true.
notifications/groups	string <array>	Returns a list of user groups / roles that will be notified when certain events are triggered. The events that can trigger email or alert notifications have to be enabled in the Web Console. Returned if details=true.
notifications/events	object	Events that will trigger notifications or alerts. Returned if details=true.
notifications/events/id	string enum: no_matches_found matches_found search_failed search_stalled detail summary	Event that will trigger a notification.
notifications/events/methods	string <array> enum: alert email	Notification method when event is triggered.
enable_bulk_download	boolean default: false enum: true false	Indicates if bulk download is enabled for supported cloud Targets. Returned if details=true.
max_salesforce_records	integer min: 1 max: 2147483647	The maximum number of records (sorted by last modified date in descending order) to scan per Salesforce object. Returned if details=true. Field will not be returned if not set.

Response Samples

200 OK

Example response for scan schedules with Server Targets.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
  {
    "id": "1",
    "label": "FREEBSD-ER2 All local files APR13-1407",
    "status": "pending",
    "repeat_days": 0,
    "repeat_months": 0,
    "profiles": [
      "1",
      "2",
      "4",
      "5",
      "7"
    ],
    "next_scan": "1523599658",
    "targets": {
      "id": "4759598330602895744",
      "name": "FREEBSD-ER2",
      "locations": {
        "id": "8987302884414283716",
        "name": "All local files",
        "started": 1523599658,
        "updated": 1523600150,
        "status": "completed"
      }
    },
    "cpu": "low",
    "capture": true,
    "trace": true,
    "match_detail": "balanced",
    "notifications": {
      "emails": [
        "username@example.com",
        "admin@example.com"
      ],
      "events": [
        {
          "id": "matched_found",
          "methods": [
            "email"
          ]
        },
        {
          "id": "search_failed",
          "methods": [
            "email"
          ]
        },
        {
          "id": "search_stalled",
          "methods": [
            "email"
          ]
        }
      ]
    }
  },
  {
    "id": "2",
    "label": "OPENSUSE-AGENT File path /usr MAY30-1629",
    "status": "stopped",
    "repeat_days": 0,
    "repeat_months": 0,
    "profiles": [
      "1",
      "2",
      "10",
      "3776821050312518925"
    ],
    "next_scan": "1523599658",
    "targets": {
      "id": "4759598330602895744",
      "name": "OPENSUSE-AGENT",
      "locations": {
        "id": "8987302884414283716",
        "name": "File path /usr",
        "status": "stopped"
      }
    },
    "cpu": "low",
    "capture": true,
    "trace": true,
    "match_detail": "balanced"
  }
]

200 OK

Example response for scan schedules with Salesforce Targets where the max_salesforce_records / Partial Salesforce object scanning parameter is configured.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
  {
    "id":"998",
    "label":"SALESFORCE:GROUNDLABS Salesforce NOV23-1021",
    "status":"interrupted",
    "repeat_days":0,
    "repeat_months":0,
    "profiles":[
      "6476795302954778528"
    ],
    "next_scan":1637634112,
    "targets":[
      {
        "id":"5723246742881584245",
        "name":"SALESFORCE:GROUNDLABS",
        "locations":[
          {
            "id":"7938504860757547431",
            "status":"stopped",
            "name":"Salesforce",
            "started":1637634112,
            "updated":1637742652,
            "credential_id":"1541672379481372406",
            "proxy_id":"12133444092996850711"
          }
        ]
      }
    ],
  "cpu":"low",
  "capture":true,
  "trace":true,
  "match_detail":"balanced",
  "max_salesforce_records":1000
  }
]   

400 Bad Request

Returned if both the active and pending query parameters are specified in the query string.

HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: xxx
{
  "message": "Duplicate query parameter 'active' specified."
}  

The pending query parameter is replaced by the active query parameter and will be deprecated in a future release of Enterprise Recon.

Update a Scan Schedule

Modify or update an existing scan schedule.

Request

PUT

https://er-master:8339/v1/schedules/<schedule_id>

Authorization

Basic Authentication

Path Parameters

Parameter	Data Type	Description
schedule_id	string	Specify ID of the scan schedule to modify. schedule_id is the id response item from the /v1/schedules endpoint.

Request Schema

If a field is omitted in the request body, it will be cleared.

Parameter	Data Type	Description
label	string	Descriptive label for scan schedule.
targets	object	Information on the Targets that are included for a scan schedule.
targets/id	string	Unique Target ID for the Target to be included in the scan schedule. target_id is the targets->id response item from the /v1/groups/all endpoint.
targets/locations	object	Information on the Target Locations to be included for the scan schedule.
targets/locations/id	string	Unique location ID for the Target Location to be included in the scan schedule. location_id is the targets->locations->id response item from the /v1/groups/all endpoint.
targets/locations/subpath	string	Subpath of the location to be included in the scan schedule.
profiles	string <array>	List of profile IDs describing the data type profiles that have been enabled for the scan. profile_id is the id response item from the /v1/datatypes/profiles endpoint.
start	string <YYYY-MM-DD hh:mm>	Date and time (in 24-hour time notation) to start the scan. If this parameter is not set, the scan will start now.
timezone	string default: Default	Set the timezone for the scan schedule. If this parameter is not set, the value will be set to Default. See Timezones for the full list of supported values.
repeat_days	integer <days>	Set the scan to repeat every Nth day. For example, if repeat_days=14, the scan will repeat every 2 weeks.
repeat_months	integer <months>	Set the scan to repeat every N months.
cpu	string default: low enum: low normal	CPU priority set for the Node Agent used for the scan. If a Proxy Agent is used, CPU priority will be set for the Proxy Agent on the Proxy Agent host. The default priority is low to keep Enterprise Recon's resource footprint low.
throughput	number <MBps>	Setting for the maximum disk I/O rate at which the scanning engine will read data from the Target host. If not set, default throughput limit is unlimited. Unit is in MBps.
memory	integer <MB>	Setting for the maximum memory usage that the scanning engine can use on the Target host. If not set, default memory limit is 1024 MB. Unit is in MB.
capture	boolean default: false enum: true false	Contextual data can be viewed when displaying matches in the Enterprise Recon Web Console. When true, contextual data is captured during scans.
trace	boolean default: false enum: true false	When true, scan trace logs are captured during the scan.
match_detail	string default: balanced enum: minimum balanced maximum	Set the amount of match details to be captured for the scan schedule. If not set, default match detail value is balanced. minimum captures the least amount of match details, while maximum captures the most match details for a scan and is recommended if required to perform masking remediation on match locations. See the Match Detail documentation for more information.
pause	object	Settings to pause and restart a scheduled scan. Requires the timezone parameter to be defined.
pause/days	number <NNNNNNN>	7-bit mask that describes the days of the week when a scan is scheduled to pause. The right-to-left masking bits represent Sunday to Saturday respectively. If days=33 (equivalent to 0100001), scan is paused for Sunday and Friday. If days=75 (equivalent to 1001011), scan is paused for Sunday, Monday, Wednesday and Saturday.
pause/start	integer <seconds>	The number of seconds before midnight to start pausing a scan in seconds.
pause/end	integer <seconds>	The number of seconds before midnight to stop pausing a scan in seconds.
notifications	object	Notifications policy for the scan.
notifications/emails	string <array>	List of email addresses that notifications will be sent to when certain events are triggered.
notifications/users	string <array>	List of User IDs for users that will be notified when certain events are triggered. user_id is the id response item from the /v1/users endpoint.
notifications/events	object	Events that will trigger notifications or alerts.
notifications/events/id	string enum: no_matches_found matches_found search_failed search_stalled detail summary	Event that will trigger a notification.
notifications/events/methods	string <array> enum: alert email	Notification method when event is triggered.
enable_bulk_download	boolean default: false enum: true false	Set enable_bulk_download=true to enable bulk download of files for supported cloud Targets.
max_salesforce_records	integer min: 1 max: 2147483647	Set the maximum number of records (sorted by last modified date in descending order) to scan per Salesforce object. Accepted only if there are Salesforce Targets included in the scan schedule.

Request Samples

HTTP

PUT /v1/schedules/9
Content-Type: application/json
{
  "label": "My-Solaris-10 Once 2018.01.01",
  "targets": {
    "id": "2774778098918773172",
    "locations": {
      "id": "17480251172185334479",
      "subpath": "string"
    }
  },
  "profiles": [
    "1",
    "10",
    "13"
  ],
  "start": "string",
  "timezone": "string",
  "repeat_days": 0,
  "repeat_months": 0,
  "cpu": "low",
  "throughput": 0,
  "memory": 0,
  "capture": false,
  "trace": false,
  "match_detail": "balanced",
  "pause": {
    "days": 33,
    "start": 0,
    "end": 0
  },
  "notifications": {
    "users": [
      "string"
    ],
    "emails": [
      null
    ],
    "events": {
      "id": "no_matches_found",
      "methods": [
        "alert"
      ]
    }
  }
}

cURL

curl --request PUT 'https://er-master:8339/v1/schedules/9' \
--user apiuser:password123 \
--header "Content-Type: application/json" \
--data-raw '{
  "label": "My-Solaris-10 Once 2018.01.01",
  "targets": {
    "id": "2774778098918773172",
    "locations": {
      "id": "17480251172185334479",
      "subpath": "string"
    }
  },
  "profiles": [
    "1",
    "10",
    "13"
  ],
  "start": "string",
  "timezone": "string",
  "repeat_days": 0,
  "repeat_months": 0,
  "cpu": "low",
  "throughput": 0,
  "memory": 0,
  "capture": false,
  "trace": false,
  "match_detail": "balanced",
  "pause": {
    "days": 33,
    "start": 0,
    "end": 0
  },
  "notifications": {
    "users": [
      "string"
    ],
    "emails": [
      null
    ],
    "events": {
      "id": "no_matches_found",
      "methods": [
        "alert"
      ]
    }
  }
}'

Response Samples

204 No Content

422 Unprocessable Entity

Returned if the request body contains invalid values or formats in the input fields.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid input for '{fieldname}'."
}  

422 Unprocessable Entity

Returned if the scan schedule ID specified does not contain at least one Salesforce Target, but the max_salesforce_records parameter is included in the request body.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid node identifier. 'max_salesforce_records' is only applicable to Salesforce targets."
}  

422 Unprocessable Entity

Returned if the value specified in the request body for the max_salesforce_records parameter is invalid or is outside the acceptable integer range.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid input for 'max_salesforce_records'. Maximum number of records must be an integer between 1 and 2147483647."
}  

Add a Scan Schedule

Create or add a new scan schedule.

Request

POST

https://er-master:8339/v1/schedules

Authorization

Basic Authentication

Request Schema

Parameter	Data Type	Description
label	string	Descriptive label for scan schedule.
targets	object	Information on the Targets that are included for a scan schedule.
targets/id	string	Unique Target ID for the Target to be included in the scan schedule. target_id is the targets->id response item from the /v1/groups/all endpoint.
targets/locations	object	Information on the Target Locations to be included for the scan schedule.
targets/locations/id	string	Unique location ID for the Target Location to be included in the scan schedule. location_id is the targets->locations->id response item from the /v1/groups/all endpoint.
targets/locations/subpath	string	Subpath of the location to be included in the scan schedule.
profiles	string <array>	List of profile IDs describing the data type profiles that have been enabled for the scan. profile_id is the id response item from the /v1/datatypes/profiles endpoint.
start	string <YYYY-MM-DD hh:mm>	Date and time (in 24-hour time notation) to start the scan. If this parameter is not set, the scan will start now.
timezone	string default: Default	Set the timezone for the scan schedule. If this parameter is not set, the value will be set to Default. See Timezones for the full list of supported values.
repeat_days	integer <days>	Set the scan to repeat every Nth day. For example, if repeat_days=14, the scan will repeat every 2 weeks.
repeat_months	integer <months>	Set the scan to repeat every N months.
cpu	string default: low enum: low normal	CPU priority set for the Node Agent used for the scan. If a Proxy Agent is used, CPU priority will be set for the Proxy Agent on the Proxy Agent host. The default priority is low to keep Enterprise Recon's resource footprint low.
throughput	number <MBps>	Setting for the maximum disk I/O rate at which the scanning engine will read data from the Target host. If not set, default throughput limit is unlimited. Unit is in MBps.
memory	integer <MB>	Setting for the maximum memory usage that the scanning engine can use on the Target host. If not set, default memory limit is 1024 MB. Unit is in MB.
capture	boolean default: false enum: true false	Contextual data can be viewed when displaying matches in the Enterprise Recon Web Console. When true, contextual data is captured during scans.
trace	boolean default: false enum: true false	When true, scan trace logs are captured during the scan.
match_detail	string default: balanced enum: minimum balanced maximum	Set the amount of match details to be captured for the scan schedule. If not set, default match detail value is balanced. minimum captures the least amount of match details, while maximum captures the most match details for a scan and is recommended if required to perform masking remediation on match locations. See the Match Detail documentation for more information.
pause	object	Settings to pause and restart a scheduled scan. Requires the timezone parameter to be defined.
pause/days	number <NNNNNNN>	7-bit mask that describes the days of the week when a scan is scheduled to pause. The right-to-left masking bits represent Sunday to Saturday respectively. If days=33 (equivalent to 0100001), scan is paused for Sunday and Friday. If days=75 (equivalent to 1001011), scan is paused for Sunday, Monday, Wednesday and Saturday.
pause/start	integer <seconds>	The number of seconds before midnight to start pausing a scan in seconds.
pause/end	integer <seconds>	The number of seconds before midnight to stop pausing a scan in seconds.
notifications	object	Notifications policy for the scan.
notifications/emails	string <array>	List of email addresses that notifications will be sent to when certain events are triggered.
notifications/users	string <array>	List of User IDs for users that will be notified when certain events are triggered. user_id is the id response item from the /v1/users endpoint.
notifications/events	object	Events that will trigger notifications or alerts.
notifications/events/id	string enum: no_matches_found matches_found search_failed search_stalled detail summary	Event that will trigger a notification.
notifications/events/methods	string <array> enum: alert email	Notification method when event is triggered.
enable_bulk_download	boolean default: false enum: true false	Set enable_bulk_download=true to enable bulk download of files for supported cloud Targets.
max_salesforce_records	integer min: 1 max: 2147483647	Set the maximum number of records (sorted by last modified date in descending order) to scan per Salesforce object. Accepted only if there are Salesforce Targets included in the scan schedule.

Request Samples

HTTP

POST /v1/schedules
Content-Type: application/json
{
  "label": "My-Solaris-10 Once 2018.01.01",
  "targets": {
    "id": "2774778098918773172",
    "locations": {
      "id": "17480251172185334479",
      "subpath": "string"
    }
  },
  "profiles": [
    "1",
    "10",
    "13"
  ],
  "start": "string",
  "timezone": "string",
  "repeat_days": 0,
  "repeat_months": 0,
  "cpu": "low",
  "throughput": 0,
  "memory": 0,
  "capture": false,
  "trace": false,
  "match_detail": "balanced",
  "pause": {
    "days": 33,
    "start": 0,
    "end": 0
  },
  "notifications": {
    "users": [
      "string"
    ],
    "emails": [
      null
    ],
    "events": {
      "id": "no_matches_found",
      "methods": [
        "alert"
      ]
    }
  }
}

cURL

curl --request POST 'https://er-master:8339/v1/schedules' \
--user apiuser:password123 \
--header "Content-Type: application/json" \
--data-raw '{
  "label": "My-Solaris-10 Once 2018.01.01",
  "targets": {
    "id": "2774778098918773172",
    "locations": {
      "id": "17480251172185334479",
      "subpath": "string"
    }
  },
  "profiles": [
    "1",
    "10",
    "13"
  ],
  "start": "string",
  "timezone": "string",
  "repeat_days": 0,
  "repeat_months": 0,
  "cpu": "low",
  "throughput": 0,
  "memory": 0,
  "capture": false,
  "trace": false,
  "match_detail": "balanced",
  "pause": {
    "days": 33,
    "start": 0,
    "end": 0
  },
  "notifications": {
    "users": [
      "string"
    ],
    "emails": [
      null
    ],
    "events": {
      "id": "no_matches_found",
      "methods": [
        "alert"
      ]
    }
  }
}'

Response Schema

201 Created

Response Item	Data Type	Description
id	string	Schedule ID assigned to the newly created scan schedule.

Response Samples

201 Created

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: xxx
{
  "id": "7"
}  

400 Bad Request

Returned if attempting to create a new scan schedule that contains a deprecated protocol.

HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: xxx
{
  "message": "Unable to create scan schedule. Request contains deprecated protocol."
}

422 Unprocessable Entity

Returned if the request body contains invalid values or formats in the input fields.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid input for '{fieldname}'."
}  

422 Unprocessable Entity

Returned if the scan schedule ID specified does not contain at least one Salesforce Target, but the max_salesforce_records parameter is included in the request body.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid node identifier. 'max_salesforce_records' is only applicable to Salesforce targets."
}  

422 Unprocessable Entity

Returned if the value specified in the request body for the max_salesforce_records parameter is invalid or is outside the acceptable integer range.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid input for 'max_salesforce_records'. Maximum number of records must be an integer between 1 and 2147483647."
}  

Change the Scan Schedule State

Change the state of a scan schedule.

Request

POST

https://er-master:8339/v1/schedules/<schedule_id>/<action>

Authorization

Basic Authentication

Path Parameters

Parameter

Data Type

Description

schedule_id

string

Specify ID of the scan schedule to modify. schedule_id is the id response item from the /v1/schedules endpoint.

action

string

enum: deactivate activate cancel skip pause resume stop restart

Set the scan schedule to a specific state.

Request Samples

HTTP

POST /v1/schedules/9/deactivate'
Content-Type: application/json

cURL

curl --request POST 'https://er-master:8339/v1/schedules/9/deactivate' \
--user apiuser:password123 \
--header "Content-Type: application/json"

Response Samples

204 No Content