Register Service Account
Click to view navigation pane

Register Service Account

POST/conn/snapshot/v1.0/register-service-account

Configure your AWS account as a service account to be used for the Snapshot-based scan.

Input ParameterInput Parameter

Parameters

 Mandatory
/Optional		 Data Type

Description

accountId

 Mandatory Integer

Amazon Account Id to register the service account with.

schedule

 Mandatory String

The interval where the snapshot scan runs periodically. Format is a cron expression.

tagkey

 Optional String

Provide the tag key to filter instances for scans.

tagvalue

 Optional String

Provide the tag value to filter instances for scans

tagkey1

 Optional String

Provide an additional tag key to filter instances for scans.

tagvalue1

 Optional String

Provide an additional tag value to filter instances for scans

Sample 1 - Register a Service AccountSample 1 - Register a Service Account

API request

curl -X 'POST' 'https://gateway.xxx.xxx.xxxxx.qualys.com/conn/snapshot/v1.0/register-service-account' \ -H 'accept: application/json' \ -H 'Content-Type: application/json'


Request POST data

{
"accountId": "95xxxxxxxx75",
  "schedule": "0 0 2 ? * * *",
  "tags": [
    {
      "tagKey": "Owner",
      "tagValue": "test"
     }
    }
  ]
}

Response

Successfully registered the service account
 

Error Codes:Error Codes:

Code

Message

200

OK

201

Created

304

Already Registered

400

Incorrect Params or connector is not cloudview

401

Invalid customer or back office entry not exists.

404

Connector not found