Machines

With this method, you can:

• Find and display information about your managed machines

•Delete managed machines

•Assign a credential to a machine

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

PUT

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

Credential URL Parameters

Success code

Input Models

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.
Name Required? Type Default Value Description

credentialId

No

Guid

None

The unique identifier of the credential that will be assigned to the machine. If this parameter is excluded, any existing credential will be removed.

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

DELETE Request

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

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/machines?count=10&start=1

GET Request

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

GET Request

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

GET Request

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

PUT Request

https://<consoleFQDN:port>/st/console/api/v1.0/machines/8/credentials?credentialId=e985c825-c871-4b0f-a4b3-1689b3f3cf7a

PUT Request

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

Output Models

ManagedMachine

Name Type Description

assignedGroup

String

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

connectionMethod

Enum

Specifies the method used to connect to the machine. Valid values are:

•Inherit: Honor the global setting specified on the Tools > Options > Scan dialog.

•IPAddress: A connection is made by IP address after name/machine resolution is performed.

•Fqdn: A connection is made using the Fully Qualified Domain Name (FQDN). This supports SPN name validation, which may be required in networks using Kerberos authentication.

consoleName

String

The console name.

credentialId

Guid

The ID of the credential that is assigned to the machine.

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.