Home

API List

Here is a complete list of all the APIs

Connector APIs

Control Evaluation APIs

Report APIs

Response Actions (Beta)

Response Notifications (Beta)

Response Rules (Beta)

Connector Groups Management APIs

User Management APIs

Connector Related APIs

Cloud Provider

API

Description

AWS

Get list of connectors

List all AWS connectors in the user's account.

Get the details of a connector

View details for a connector which is in the user’s scope.

Get the AWS base accountId

Fetches the AWS base account ID for you.

Get the AWS Cloud Formation template

Specify the External Id to be used for generating the AWS cloud formation template and download the template.

Get the list of errors

Get the list of errors encountered when executing connector.

Create a new connector

Specify the connector details such as qualysAccountId, arn, externalId, and so on and create a new connector.

Run the provided connector

Specify the IDs of the connectors that you want to run.

Update the existing connector

Specify the connector ID and you can then update details of the specified connector.

Delete the provided connectors

Delete the specified connector which is in the user’s scope.

Azure

Get list of connectors

List all Azure connectors in the user's account.

Get the details of a connector

View details for a specific Azure connector which is in the user’s scope.

Create a new connector

Specify the connector details such as application Id, authenticationKey, description, directoryId, name, and subscription Id of your Azure account and create a new connector.

Run the provided connector

Specify the IDs of the connectors that you want to run.

Update the existing connector

Specify the connector ID and the details of the connector that you would want to update in the connectorBody parameter. Your connector details get updated.

Delete the provided connectors

Delete the specified connector which is in the user’s scope.

GCP

Get list of connectors

List all GCP connectors in the user's account.

Get the details of a connector

View details for a specific GCP connector which is in the user’s scope.

Create a new connector

Specify the connector details such as name, description and upload the configuration (JSON) file and create a new connector.

Run the provided connector

Specify the connector details and run the specified GCP connector.

Update the existing connector

Specify the connector ID and the details to be updated to update details of the specified connector.

Delete the provided connectors

Delete the specified connector which is in the user’s scope.

 

Control Evaluation APIs

Cloud Provider

API

Description

AWS

Get the stats for specified control id and resource id

Specify the details such as control ID, resource ID, and connector ID to get the statistics for specified control and resource ID.

Get the list of evaluations as per the account for AWS Controls

Specify the details such as account ID and use filters to fetch evaluation details for the account.

Get the resources evaluated for the specified aws account and control id

Specify the details such as account ID, control ID, and fetch the resource evaluation details.

Azure

Get the stats for specified control id and resource id

Specify the details such as control ID, resource ID, and connector ID to get the statistics for specified control and resource ID.

Get the list of evaluations as per the account for AWS Controls

Specify the details such as subscription ID and use filters to fetch evaluation details for the subscription.

Get the resources evaluated for the specified aws account and control id

Specify the details such as subscription ID, control ID, and fetch the resource evaluation details.

GCP

Get the stats for specified control id and resource id

Specify the details such as control ID, resource ID, and connector ID to get the statistics for specified control and resource ID.

Get the list of evaluations as per the account for AWS Controls

Specify the details such as project ID and use filters to fetch evaluation details for the project.

Get the resources evaluated for the specified aws account and control id

Specify the details such as project ID, control ID, and fetch the resource evaluation details.

Reports APIs

API

Description

Get Data for Specific Report

Specify the report ID and you can then get the complete report.

Get List of All Supported Mandates

You can fetch the list of all the supported mandates.

Get List of All Supported Policies

You can fetch the list of all the supported policies in your account.

Get Report Configurations

You can fetch all the list of report configurations.

Get Report Details

Specify the report ID and then you can get the details of the specified report.

Create a Report

To generate a new report you need to provide information such as account ID, the cloud provider for which you would want to generate the report and few other details such as name, description, format, mandate ID and so on.

Update a Report

You can update a report template to generate a new report.

Delete Reports

Specify the ID of the report you want to delete and the report gets deleted.

Response Actions APIs (Beta)

API

Description

Get actions

Fetch the list of actions. You can search actions using filters based on criteria you want.

Get action Id

Specify the action ID and fetch action details.

Delete existing action

Specify the ID of the action you want to delete and the action gets deleted.

Create a new email action

Specify the necessary details and create a new email action.

Update email action

Update an existing email action.

Create new PagerDuty action

Specify the necessary details and create a new PagerDuty action.

Update PagerDuty action

Update an existing PagerDuty action.

Test PagerDuty action

Test the action in PagerDuty.

Create new Slack action

Specify the necessary details and create a new Slack action.

Update Slack action

Update an existing Slack action.

Test Slack action

Test the action in Slack.

Get all possible action types

Fetch the list of actions types from all applications: email, Slack, and PagerDuty.

Response Notifications APIs (Beta)

API

Description

Get activities

Fetch the activities.

Get acitivity Id

Fetch the activity using activity Id.

Response Rules APIs (Beta)

API

Description

Get rules

Fetch all the rules. You can use filters to fetch specific rules.

Create a new rule

Specify the rule details such as actionId, actionType, emailRecipients, and so on and create a new rule.

Get rule by Id

Specify the rule ID and fetch rule details.

Update an existing rule

Specify the rule ID of a rule in the user’s scope and specify the rule details that you want to modify.

Delete existing rules

Specify the ID of the rule you want to delete and the rule gets deleted.

Disable enabled rules

Specify rule Id to be disabled. You can provide multiple Ids separated by comma.

Enable disabled rules

Specify rule Id to be enabled. You can provide multiple Ids separated by comma.

Connector Groups Management APIs

API

Description

Get Groups

Fetch the list of groups associated with the user.

Create Group

 

The groups help you to organize your connectors and to manage user access to them. You can create groups and associate it with connectors and form connector groups or segregate connectors using a specific group for a connector as well. Use groups to provide access or restrict access to users you create.

Update Group

The groups help you to organize your connectors and to manage user access to them. You can update groups and associate it with connectors and form connector groups or segregate connectors using a specific group for a connector as well. Use groups to provide access or restrict access to users you create.

Get Group Details

You can get details of a group by specifying the unique Id associated with a group.

User Management APIs

API

Description

Get the User Scope

You can fetch the group details by specifying the unique Id assigned to a group.

Update Groups Scope for User

You can now update the groups associated with a specific user. You could add new groups and remove groups that are associated with the user using update operation.

Update Connector Scope for user

You can now update the connectors associated with a specific connector. You could add new groups and remove groups that are associated with the connector using update operation.