Create file scan
POST https://daas.digicert.com/apicontroller/v1/scan/createFileScan
Use this endpoint to use agents to scan TrustStores, KeyStores, SSH keys, and binary cryptographic data stored on your host server.
Example requests and responses
Request parameters
Name | Req/Opt | Type | Description |
---|---|---|---|
surveyName | required | string | Friendly name provided for the scan. Max length: 80 characters |
frequencyType | required | string | How often the scan will run. Allowed values: |
surveyConfig | required | object | Object container for scan configuration details. |
.. tags | optional | string | Add tags to the scan.Tags can be a combination of letters (a-z or A-Z), numbers (0-9), number signs (#), or spaces. Entries must be comma-separated. (Maximum 512 characters). Note: Alphanumeric characters like #, @ and _ are allowed. |
.. startTime | required | integer | Start time for the scheduled scan. Format: epoch in millisecond. Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system. Example: Note: |
.. timezone | optional | string | Time zone for the scan. Format: GMT + your timezone offset. Example: |
.. speed | optional | string | How fast the scan completes. Default: Allowed values: |
.. isCapiScan | optional | boolean | If Default: |
.. isSystemScan | optional | boolean | If Default: |
.. systemScanTypes | required | array | List of items to be scanned from the system. |
accountId | required | string | Account ID. |
divisionId | required | integer | Division ID. |
emailAddresses | optional | string | Email address for the contact associated with the file scan. |
Response parameters
Name | Type | Description |
---|---|---|
error | object | Includes the error code, if any. |
data | object | Object container for response. |
.. accountId | string | Account ID. |
.. divisionId | integer | Division ID. |
.. surveyDefId | integer | Survey definition ID of the file scan. |
.. surveyName | string | Friendly name provided for the scan. Max length: 80 characters |
.. message | string | Updated message for scan creation. |