search cancel

What are the state and substate values in the SEPM REST API: Get Command Status Details

book

Article ID: 229117

calendar_today

Updated On:

Products

Endpoint Protection Endpoint Security

Issue/Introduction

The Symantec Endpoint Protection Manager's (SEPM) "Get Command Status Details" REST API is documented in https://apidocs.securitycloud.symantec.com/#/doc?id=commands.

Specifically: /api/v1/command-queue/{command_id}

The information in "Response object details" does not explain the "content" portion of the data returned, and the "Produces" section in the documentation is blank. You want to know what the possible stateId, subStateId, and subStateDesc values are and what they mean.

Environment

Release : 14.3.x

Component : SEPM REST API

Resolution

Values for these fields are as follows:

stateId is the command status: a numeric value corresponding to one of the following:

0 = INITIAL
1 = RECEIVED
2 = IN_PROGRESS
3 = COMPLETED
4 = REJECTED
5 = CANCELLED
6 = ERROR

When a command is first created, the command status = INITIAL. This indicates that the endpoint has not received the command yet.

subStateId is the command-specific status:

-1 = Unknown
0 = Success
1 = Client did not execute the command
2 = Client did not report any status
3 = Command was a duplicate and was not executed
4 = Spooled command could not restart
5 = Restart command not allowed from the console
6 = Unexpected error
100 = Success
101 = Security risk found
102 = Scan was suspended
103 = Scan was aborted
105 = Scan did not return status
106 = Scan failed to start
110 = Auto-Protect could not be turned on
120 = LiveUpdate download is in progress
121 = LiveUpdate download failed
131 = Quarantine delete failed
132 = Quarantine delete partial success

subStateDesc is command-specific extra information, such as number of files scanned, file handled, or error messages.

Note: binaryFileId is returned when the Get File Command (/api/v1/command-queue/files) completes and is used with the Get Binary File Content, and Get Binary File Details commands.

Additional Information

Symantec | API Console | SEP | Commands