GET /setting/scans

This API returns information on Scan accounts. Scan accounts contain all the information and settings related to a cloud accounts.

Request

Format

GET /setting/scans/{id}

Parameters

Parameter	Type	Optional	Description
`id`	String	Yes	The ID of the scan account you want to display the information for. If this parameter is not specified in the request, the response will include information for all the scan accounts in your company.

Parameter

Type

Optional

Description

id

String

Yes

The ID of the scan account you want to display the information for.

If this parameter is not specified in the request, the response will include information for all the scan accounts in your company.

Examples

Request information for all scan accounts in your company:

GET /setting/scans/

Request information for scan account 2eee770a-e63d-47b2-a9ff-676f3a******:

GET /setting/scans/2eee770a-e63d-47b2-a9ff-676f3a******

Response

Format

{
  "data": [
    {
      "id": "string",
      "type": "scan",
      "attributes": {
        "name": "string",
        "target": "string",
        "is_enabled": true,
        "is_archived": true,
        "created_at": "2024-01-03T07:25:51.746Z"
      },
      "relationships": {
        "scan_group": {
          "data": {
            "id": "string",
            "type": "scan_group"
          }
        }
      },
      "links": {
        "self": "string"
      }
    }
  ],
  "links": {
    "self": "string",
    "next": "string"
  },
  "meta": {
    "total": 0,
    "elapsed": 0
  }
}

Attributes

This endpoint returns an object containing multiple attributes, each containing information regarding cloud accounts.

Attribute	Type	Description
`data`	Object	A list of attributes containing information related to scan accounts.
`id`	String	The ID of the scan account.
`type`	String	The type of entity described by the object. Possible values: `scan`.
`attributes`	Object	Provides scan account information.
`name`	String	The name of the scan account.
`target`	String	The account name on the cloud service provider the scan account belongs to.
`is_enabled`	Boolean	Indicates if scans are enabled for this scan account.
`is_archived`	Boolean	Indicates if the scan account has been disabled.
`created_at`	String	The time and date when the cloud account was onboarded.
`relationships`	Object	A list of related entities.
`scan_group`	Object	A list of scan groups the scan account belongs to.
`data`	Array of Strings	A list providing information regarding the related scan group.
`id`	String	The ID of the related scan group.
`type`	String	The type of the related entity. Possible values: `scan_group`.
`links`	Array of Strings	Provides links relevant to this scan account.
`self`	String	A direct link to the information for this specific scan account.
The below attributes are returned only when requesting information for all cloud accounts in the company (no `id` is specified in the request.
`links`	Array of Strings	Provides links that allow you navigate between pages.
`self`	String	A direct link to the information for this specific scan account.
`next`	String	A direct link the information for the next scan account returned by the request.
`meta`	Array of Integers	Provides overall information regarding the information returned by the request.
`total`	Integer	The total number of results returned by the request.
`elapsed`	Integer	The number of results you have viewed, including the one being displayed.

Examples

Information was requested for all cloud accounts onboarded to a company:

{
    "data": [
        {
            "id": "2eee770a-e63d-47b2-a9ff-676f3a******",
            "type": "scan",
            "attributes": {
                "name": "cy-test-project-no-billing",
                "target": "cy-test-project-no-billing",
                "is_enabled": false,
                "is_archived": true,
                "created_at": "2023-10-04T04:57:10+00:00"
            },
            "relationships": {
                "scan_group": {
                    "data": {
                        "id": "8d7d5bac-9cab-405f-9ec7-ed89c6******",
                        "type": "scan_group"
                    }
                }
            },
            "links": {
                "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scans/2eee770a-e63d-47b2-a9ff-676f3a******"
            }
        },
        {
            "id": "3c807067-4097-43ac-82d7-4ee2ef******",
            "type": "scan",
            "attributes": {
                "name": "[Staging] ****** AWS Account",
                "target": "arn:aws:iam::829960215233:role/*******-******-scanner-test-0-IAMRole*************-1IEYW8O750PXW",
                "is_enabled": true,
                "is_archived": false,
                "created_at": "2023-09-26T09:22:18+00:00"
            },
            "relationships": {
                "scan_group": {
                    "data": {
                        "id": "16beea3e-d011-4c0c-932c-8d8e532a794c",
                        "type": "scan_group"
                    }
                }
            },
            "links": {
                "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scans/3c807067-4097-43ac-82d7-4ee2ef******"
            }
        },
        {
            "...": "..."
        }
    ],
    "links": {
        "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scans?page_limit=500",
        "next": null
    },
    "meta": {
        "total": 14,
        "elapsed": 14
    }
}

Information was requested for a the cloud specific scan account with the 2eee770a-e63d-47b2-a9ff-676f3a****** ID:

{
    "data": {
        "id": "2eee770a-e63d-47b2-a9ff-676f3a******",
        "type": "scan",
        "attributes": {
            "name": "cy-test-project-no-billing",
            "target": "cy-test-project-no-billing",
            "is_enabled": false,
            "is_archived": true,
            "created_at": "2023-10-04T04:57:10+00:00"
        },
        "relationships": {
            "scan_group": {
                "data": {
                    "id": "8d7d5bac-9cab-405f-9ec7-ed89c6******",
                    "type": "scan_group"
                }
            }
        },
        "links": {
            "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scans/2eee770a-e63d-47b2-a9ff-676f3a******"
        }
    }
}

In this section:

GET /setting/scans

Request

Format

Parameters

Examples

Response

Format

Attributes

Examples

Search results