Machine Groups

Machine groups are used to organize and track the machines that are included in a scan. You can manage machine groups and the contents of each machine group. All machine types are supported by the REST API except for offline workstation virtual machines.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}

 

None

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/discoveryFilters

 

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/discoveryFilters/{filter Id}

 

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/virtualMachineDiscoveryFilters

 

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/virtualMachineDiscoveryFilters/{filter Id}

 

Success code

GET

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups

URL Parameters

MachineGroup[]

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}

 

MachineGroup

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/UsedBy

 

UsedBy

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/discoveryFilters

URL Parameters

Discovery Filters

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/discoveryFilters/{filterId}

 

Discovery Filters

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/virtualMachineDiscoveryFilters

URL Parameters

VirtualMachineDiscoveryFilter

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/virtualMachineDiscoveryFilters/{filterId}

 

VirtualMachineDiscoveryFilter

POST

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups

Request Body

MachineGroup

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/discoveryFilters

DiscoveryFilters Request Body

MachineGroup

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/virtualMachineDiscoveryFilters

VMDiscoveryFilters Request Body

MachineGroup

PUT

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}

Request Body

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{Id}/credentials

Credential URL Parameters

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/discoveryFilters/{filter Id}

DiscoveryFilter Request Body

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/discoveryFilters/{filter Id}/credentials

DiscoveryFilter Credential URL Parameters

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/virtualMachineDiscoveryFilters/{filter Id}

VMDiscoveryFilter Request Body

Success code

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups/{group Id}/virtualMachineDiscoveryFilters/{filter Id}/credentials

DiscoveryFilter Credential URL Parameters

Success code

Input Models

Example with Sample Response

Create an empty machine group named "Sample Group"

POST Request

https://<consoleFQDN:port>/st/console/api/v1.0/machinegroups

{

"name": "Sample Group",

"description":"A sample group created using the REST API",

"path": "TestPath",

"credentialId": "684a5bb0-fabb-43f7-9bef-db02eb25a83b",

"serverFilterTypes": "All"

}

Sample Response

{

"creator": "DOMAIN\\joe.coder",

"credentialId": "684a5bb0-fabb-43f7-9bef-db02eb25a83b",

"description": "A sample group created using the REST API",

"id": 7,

"isBuiltIn": false,

"isReadOnly": false,

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/machinegroups/7"

},

"discoveryfilters": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/machinegroups/7/discoveryfilters"

},

"virtualmachinediscoveryfilters": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/machinegroups/7/virtualmachinediscoveryfilters"

},

"usedby": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/machinegroups/7/usedby"

}

},

"name": "Sample Group",

"path": "TestPath",

"serverFilterTypes": "All",

"virtualMachineDiscoveryFilters": []

}

Other Request Examples

Output Models