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

Name Required? Type Default Value Description

additionalProperties

No

Dictionary (strings)

None

Provide additional information for the agents that will be activated using the key.

  • assignedGroup: Specifies the group that the agent will be assigned to within Machine View and Scan View.

The default group is the machine group name and it will be applied if an operation has been performed on the machine from the Security Controls user interface. If the machine has already been assigned a group name, this parameter will be ignored. To change the assigned group, use the Machine Properties dialog within Security Controls.

consoleId

Yes

Guid

None

Specifies the console identifier for which the agent key is being created.

initialActivationCount

Yes

Int32

None

Specifies the number of times the key can be used.

notOnOrAfter

Yes

DateTime

None

Specifies that the key is not valid on or after this date.

policyId

Yes

Guid

None

Specifies the name of the agent policy that is associated with the key.

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

Copy 
{
    "count": 1,
    "value": [
        {
            "id": "ab021f5d-ab70-4292-80af-e9d4083971e8",
            "links": {
                "self": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/cloudsync/consoles/ab021f5d-ab70-4292-80af-e9d4083971e8"
                },
                "policies": {
                    "href": "https://device-name.example.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

DELETE Request

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

GET Request

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

GET Request

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

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/cloudsync/consoles/4997c76c-3e47-4b97-bae5-265d586431e9

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/cloudsync/consoles/4997c76c-3e47-4b97-bae5-265d586431e9/policies

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/cloudsync/consoles/4997c76c-3e47-4b97-bae5-265d586431e9/policies/227b75d2-8dab-4580-a64a-a5ed381776db

POST Request

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

{

    "consoleId": "4997c76c-3e47-4b97-bae5-265d586431e9",
    "policyId": "227b75d2-8dab-4580-a64a-a5ed381776db",
    "notOnOrAfter": "5/9/2021",
    "initialActivationCount": "10",
    "additionalProperties": {
        "assignedGroup": "SampleGroup"
    }
}

Output Models

Name Type Description

activationCountRemaining

Int32

The number of times the key can be reused.

activationKey

String The agent installation key.

additionalProperties

Dictionary (strings)

Additional properties that are associated with the agent key.

•assignedGroup: The group that the agent will be assigned to within Machine View and Scan View.

consoleId

Guid The ID of the console that is associated with the activation key.

consoleName

String The name of the console.

consoleVersion

String The software version of the console.

createdBy

String The name of the user who created the key.

initialActivationCount

Int32 The number of times the key can be used.

links

Links

Shows the related URLs for the key.

notBefore

DateTime

The key is not valid prior to this date.

notOnOrAfter

DateTime

The key is not valid on or after this date.

policyId

Guid

The ID of the policy that is associated with the key.

policyName

String

The name of the agent policy that is associated with the key.
Name Type Description

id

String

The console identifier.

links

Links

Shows the related URLs for the console.

name

String

The console name.

version

String

The software version of the console.
Name Type Description

id

String

The agent policy identifier.

links

Links

Shows the related URLs for the agent policy.

name

String

The agent policy name.