Scan Engine Group Operations | AppSpider Documentation

Credential Warning

Note that System Administrator credentials are required to work with scan engines

/AppSpiderEnterprise/rest/v1/GetAllEngineGroups Description Retrieves the list of scan engine groups

Parameters No paramaters

Response Messages

Response status codeReason
200OK

Response example:

{ "type": "object", "properties": { "EngineGroups": { "type": "array", "properties": { "Id": { "type": "string", "required": true }, "Name": { "type": "string", "required": true, "maxLength": 128 }, "Description": { "type": ["string", "null"] "required": true, "maxLength": 256 }, "Monitoring": { "type": "boolean", "required": true, } } }, "additionalProperties": false }, "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": ["string", "null"], "required": true "Reason": { "type": ["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/EngineGroup/GetEngineGroupsForClient Description Retrieves the list of scan engine groups for a client.

Credential Warning

Note: user permissions required to retrieve the list of scan engine groups. List will be restricted to the client that the user has access to.

Parameters No Parameters

Response Messages

Response status codeReason
200OK

Response example:

{ "Type": "object", "properties": { "EngineGroups": { "type": "array", "properties": { "Id": { "type": "string", "required": true }, "Name": { "type": "string", "required": true, "maxLength": 128 }, "Description": { "type": ["string", "null"], "required": true, "maxLength": 256 }, "Monitoring": { "type": "boolean", "required": true } } }, "additionalProperties": false }, "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": ["string", "null"], "required": true }, "Reason": { "type": ["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/EngineGroup/SaveEngineGroup Description Creates or updates a scan engine group

Parameters

NameTypeRequiredDescription
idstringNIf id not provided a new engine group will be created. If an id is provided then an engine group update is performed.
namestringYScan engine group name. Name should be unique
descriptionstringNScan engine group description
monitoringboolNScan engine group is monitoring

Response Messages

Response status codeReasonDescription
200Scan engine group created
400InvalidJsonSchemaRequired parameters not provided
400EngineGroupNameIsNotUniqueEngine group name is not unique
400EngineGroupNotFoundEngine group with provided id not found

Response example:

{ "type": "object", "properties": { "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": ["string", "null"], "required": true }, "Reason": { "type": ["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/EngineGroup/DeletEngineGroup Description Deletes a scan engine group

Parameters

NameTypeRequiredDescription
idsguid[]YScan engine group IDs

Response Messages

Response status codeReasonDescription
200Scan engine group removed
400InvalidJsonSchemaRequired parameters not provided

Response example:

{ "type": "object", "properties": { "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": true }, "Reason": { "type": ["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1/EngineGroup/AddEngineToGroup Description Adds a scan engine to a scan engine group

Parameters

NameTypeRequiredDescription
groupIdguidYScan engine group ID
engineIdguidYScan engine ID

Response Messages

Response status codeReasonDescription
200Scan engine added to scan engine group
400InvalidJsonSchemaRequired parameters not provided
400EngineNotFoundScan engine with engineId not found
400EngineGroupNotFoundScan engine group with groupId not found

Response example:

{ "type": "object", "properties": { "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": ["string", "null"], "required": true' }, "Reason": { "type": ["string", "null"], "required": true } }, "additionalProperties": false }

/AppSpiderEnterprise/rest/v1//EngineGroup/DeleteEngineFromGroup Description Deletes scan engine from scan engine group

Parameters

NameTypeRequiredDescription
groupIdguidYScan engine group ID
engineIdguidYScan engine ID

Response Messages

Response status codeReasonDescription
200Scan engine deleted from scan engine group
400InvalidJsonSchemaRequired parameters not provided
400EngineNotFoundScan engine with engineId not found
400EngineGroupNotFoundScan engine group with grouId not found

Response example:

{ "type": "object", "properties": { "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": ["string", "null"], "required": true }, "Reason": { "type": ["string", "null"], "required": true } }, "additionalProperties": false }