Cloud Synchronization

The Security Controls Cloud synchronization feature enables your agents to check in and receive policy updates from the cloud. With this method, you can:

Get information about your consoles, your cloud-enabled agent policies and your agent activation keys

Create cloud agent activation keys

Delete cloud agent activation keys

Be sure to register your Security Controls console with the cloud service before issuing a request. For more information, see Security Controls Cloud Sync Options.

Base URL

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

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/cloudsync/activationkeys/{keyId}

 

Success code

GET

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

  AgentActivationKey[]

https://<consoleFQDN:port>/st/console/api/v1.0/cloudsync/activationkeys{keyId}

  AgentActivationKey

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

  ConsoleInformation[]

https://<consoleFQDN:port>/st/console/api/v1.0/cloudsync/consoles/{consoleId}

  ConsoleInformation

https://<consoleFQDN:port>/st/console/api/v1.0/cloudsync/consoles/{consoleId}/policies

  PolicyInformation[]

https://<consoleFQDN:port>/st/console/api/v1.0/cloudsync/consoles/{consoleId}/policies/{policyId}

  PolicyInformation

POST

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

Request Body Activation key ID

Input Models

Example with Sample Response

Find all Security Controls consoles that are registered with the Cloud

GET Request

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

Sample Response

{

"count": 1,

"value": [

{

"id": "ab021f5d-ab70-4292-80af-e9d4083971e8",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/cloudsync/consoles/ab021f5d-ab70-4292-80af-e9d4083971e8"

},

"policies": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/cloudsync/consoles/ab021f5d-ab70-4292-80af-e9d4083971e8/policies"

}

},

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

"version": "9.5.6969.0"

}

]

}

Other Request Examples

Output Models