Security Controls REST API

Home 

Operations

The operations controller is responsible for managing long running operations such as scans, deployments and patch downloads. Several POST commands will return a URI reference to the operations controller. You can query the controller to poll for the status of a long running operation. If the operation is complete when the status query is performed, another URI is returned that can be used to ask for the result of the long running operation.

Base URL

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

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/operations/{id of long running operation}

 

Success or failure code

https://<consoleFQDN:port>/st/console/api/v1.0/operations/{id of long running operation}/{run as credential id}

 

Success or failure code

 

 

GET

https://<consoleFQDN:port>/st/console/api/v1.0/operations/{id of long running operation}

 

Operation status

Example

Monitor the status of a patch scan.

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/operations/3608e6f3-3f66-43b0-95db-ae1f50639cad

Sample Response

{

"created": "2018-07-23T15:01:04.527Z",

"lastAction": "2018-07-23T15:01:04.647Z",

"operation": "PatchScan",

"percentComplete": 100,

"resourceLocation": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/patch/scans/3608e6f3-3f66-43b0-95db-ae1f50639cad",

"status": "Succeeded"

}

Output Models

OperationStatus

Name Type Description

created

DateTime

Gets the time that the operation was created.

error

OperationError

Operation-specific error.

lastAction

DateTime

Gets the date and time that the operation was last updated.

operation

Operation

Specifies the type of operation.

percentComplete

Integer

Gets the operation completion percentage.

resourceLocation

Uri

Gets the resource location of a completed operation.

status

OperationState

Gets the operation status.

Operation

Name Description

PatchDownload

Patch download operation.

PatchDeployment

Patch deployment operation.

PatchScan

Patch scan operation.

Virtual

Virtual operation.

OperationState

Name Description

Running

The operation is running.

Succeeded

The operation has succeeded. This is a terminal state.

Failed

The operation has failed. This is a terminal state.

Canceled

The operation was canceled. This is a terminal state.

OperationError

Name Type Description

code

Integer

Error code.

message

Sring

Error message. For example: Cannot complete login due to an incorrect user name or password.

 


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other