HandleRunningVMKeyRequests() Parent topic

Description

Perform actions on key requests from virtual machines.

Interface

https://[SecureCloudService]/broker/API.svc/v3.5/runningVM/keyRequest/{requestID}/{act}/
Method: POST

Parameters

Parameter
Data Type
Description
Required?
requestID
String
The GUID of the key request.
Yes
act
String
Action of the key request.
Valid values:
  • approve: Approves a pending key request.
  • deny: Denies a pending key request.
  • revoke: If a machine that does not pass an integrity check, revokes key requests for that machine.
  • ignore: If a machine that does not pass an integrity check, ignores the integrity check failure.
  • runicm: Runs an integrity check on the machine.
Yes

Request

N/A

Response

Expected HTTP response code: 200 (OK)
Refer to the following data types: RunningVMKeyRequest, RuleEvaluation, and RuleEvaluationList.

Example Request

[POST]
https://ms.sample.securecloud.com/broker/API.svc/v3.5/runningVM/keyRequest/
      12345678-a145-4bde-998c-3c5d36b73243/approve

Example Response

<?xml version="1.0" encoding="utf-8"?>
<runningVMKeyRequest version="3.5"
      requestID="12345678-a145-4bde-998c-3c5d36b73243"
      requested="2012-11-01T02:31:40.95" deviceKeyRequestState="approved"
      href="https://ms.lab.securecloud/Broker/API.svc/v3.5/runningVM/keyRequest/
            12345678-a145-4bde-998c-3c5d36b73243/">
      <ruleEvaluationList failedCount="0" passedCount="0" infoCount="0">
            <ruleEvaluation id="" name="" href="" description="">
                  <ruleEvaluationCatagory name="" type=""/>
                  <ruleEvaluationData success="Passed" evaluator"lessThan" dataType="Text">
                        <expected>xxx</expected>
                        <actual>xxx</actual>
                  </ruleEvaluationData>
            </ruleEvaluation>
      </ruleEvaluationList>
</runningVMKeyRequest >