Machines

With this method, you can:

Find and display information about your managed machines

Delete managed machines

Base URL

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

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/machines/{machineId}

 

Success code

GET

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

URL Parameters ManagedMachine

https://<consoleFQDN:port>/st/console/api/v1.0/machines/{machineId}

 

ManagedMachine

Input Model

URL Parameters

Name Type Description

count

Integer

Provide the count of items to return. The default is 10 and the maximum value is 1000.

domain

String

Returns the items whose domain matches the specified domain.

ipAddress

IPAddress

Returns the items whose IP matches the specified IP address.

name

String

Returns the items whose name matches the specified name.

start

Integer

Sets the starting point. The items are sorted by their unique identifier and the starting point is the index into that sorted list.

Example with Sample Response

Find the machine with IP address 192.168.1.1

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/machines/?ipAddress=192.168.1.1

Sample Response

{

"count": 1,

"links": {

"next": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/machines?count=10&start=2&IPAddress=192.168.1.1"

}

},

"value": [

{

"consoleName": "sample-console-name",

"dnsName": "device-name.fakedomain.com",

"domain": "fakedomain",

"id": 1,

"ipAddress": "192.168.1.1",

"links": {

"self": {

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

}

},

"name": "sample-machine-name",

"assignedGroup": "My Machine"

}

]

}

Other Request Examples

Output Models

ManagedMachine

Name Type Description

consoleName

String

The console name.

dnsName

String

The DNS name.

domain

String

The domain name.

id

Int32

The machine ID.

ipAddress

IPAddress

The IP address of the machine.

links

Links

Shows the related URLs for the machine.

name

String

The machine name.

virtualMachinePath

String

The virtual machine path.

virtualServer

String

The virtual server.

assignedGroup

String

The group that the machine is assigned to within Machine View and Scan View.