Scan Engine Group Operations

❌

Credential Warning

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

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

Parameters No paramaters

Response Messages

Response status code	Reason
200	OK

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
}

get /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 code	Reason
200	OK

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
}

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

Parameters

Name	Type	Required	Description
id	string	N	If id not provided a new engine group will be created. If an id is provided then an engine group update is performed.
name	string	Y	Scan engine group name. Name should be unique
description	string	N	Scan engine group description
monitoring	bool	N	Scan engine group is monitoring

Response Messages

Response status code	Reason	Description
200		Scan engine group created
400	InvalidJsonSchema	Required parameters not provided
400	EngineGroupNameIsNotUnique	Engine group name is not unique
400	EngineGroupNotFound	Engine 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
}

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

Parameters

Name	Type	Required	Description
ids	guid[]	Y	Scan engine group IDs

Response Messages

Response status code	Reason	Description
200		Scan engine group removed
400	InvalidJsonSchema	Required parameters not provided

Response example:


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

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

Parameters

Name	Type	Required	Description
groupId	guid	Y	Scan engine group ID
engineId	guid	Y	Scan engine ID

Response Messages

Response status code	Reason	Description
200		Scan engine added to scan engine group
400	InvalidJsonSchema	Required parameters not provided
400	EngineNotFound	Scan engine with engineId not found
400	EngineGroupNotFound	Scan 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
}

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

Parameters

Name	Type	Required	Description
groupId	guid	Y	Scan engine group ID
engineId	guid	Y	Scan engine ID

Response Messages

Response status code	Reason	Description
200		Scan engine deleted from scan engine group
400	InvalidJsonSchema	Required parameters not provided
400	EngineNotFound	Scan engine with engineId not found
400	EngineGroupNotFound	Scan 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
}