Skip to main content

GET /setting/scan_groups

This API returns information on scan groups.

Request

Format

GET /setting/scan_groups/{id}

Parameters

Parameter

Type

Optional

Description

id

String

Yes

The ID of the scan group 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 groups created in your company.

Examples

Request information on all the scan groups in your company:

GET /setting/scan_groups

Request information for scan group 16beea3e-d011-4c0c-932c-8d8e53******:

GET /setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******

Response

Format

{
  "data": [
    {
      "id": "string",
      "type": "scan_group",
      "attributes": {
        "name": "string",
        "description": "string",
        "schedule": "string",
        "created_at": "2024-01-04T15:07:59.329Z"
      },
      "relationships": {
        "scans": {
          "data": [
            {
              "id": "string",
              "type": "scan"
            }
          ]
        }
      },
      "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 scan group settings.

Attribute

Type

Description

data

Object

A list of attributes containing information related to scan groups.

    id

String

The ID of the scan group.

    type

String

The type entity described by the object.

Possible values: scan_group.

    attributes

Array of Strings

Provides scan group information.

        name

String

The name of the scan group.

        description

String

The description of the scan group.

        schedule

String

The scan schedule assigned to the scan group.

        created_at

String

The time and date when the scan group was created.

    relationships

Object

A list of related entities.

        scans

Object

A list of scan accounts that belong to this scan group.

            data

Array of Strings

A list providing information regarding the related scan account.

                id

String

The ID of the related scan account.

                type

String

The type of the related entity.

Possible value: scan.

    links

Array of Strings

Provides links relevant to this scan group.

        self

String

A direct link to the information for this specific scan group

The below attributes are returned only when requesting information for all scan groups 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 group

    next

String

A direct link the information for the next scan group returned by the request.

meta

Array of Integers

Provides overall information regarding to 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 scan groups in your company:

{
    "data": [
        {
            "id": "11e1623b-6d41-42e1-9c62-f8c682******",
            "type": "scan_group",
            "attributes": {
                "name": "Test Scan",
                "description": "For demo day",
                "schedule": "0 1 * * 1",
                "created_at": "2023-09-27T09:12:56+00:00"
            },
            "relationships": {
                "scans": {
                    "data": []
                }
            },
            "links": {
                "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/11e1623b-6d41-42e1-9c62-f8c682******"
            }
        },
        {
            "id": "16beea3e-d011-4c0c-932c-8d8e53******",
            "type": "scan_group",
            "attributes": {
                "name": "demo-group",
                "description": "",
                "schedule": "0 17 * * 0",
                "created_at": "2023-09-26T08:09:44+00:00"
            },
            "relationships": {
                "scans": {
                    "data": [
                        {
                            "id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
                            "type": "scan"
                        },
                        {
                            "id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
                            "type": "scan"
                        },
                        {
                            "id": "3c807067-4097-43ac-82d7-4ee2ef******",
                            "type": "scan"
                        },
                        {
                            "id": "6d1422ac-9eea-45e2-992e-27a243******",
                            "type": "scan"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******"
            }
        },
        {
            "...": "..."
        }
    ],
    "links": {
        "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups?page_limit=500",
        "next": null
    },
    "meta": {
        "total": 7,
        "elapsed": 7
    }
}

Information was requested for scan group 16beea3e-d011-4c0c-932c-8d8e53******:

{
    "data": {
        "id": "16beea3e-d011-4c0c-932c-8d8e53******",
        "type": "scan_group",
        "attributes": {
            "name": "demo-group",
            "description": "",
            "schedule": "0 17 * * 0",
            "created_at": "2023-09-26T08:09:44+00:00"
        },
        "relationships": {
            "scans": {
                "data": [
                    {
                        "id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
                        "type": "scan"
                    },
                    {
                        "id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
                        "type": "scan"
                    },
                    {
                        "id": "3c807067-4097-43ac-82d7-4ee2ef******",
                        "type": "scan"
                    },
                    {
                        "id": "6d1422ac-9eea-45e2-992e-27a243******",
                        "type": "scan"
                    }
                ]
            }
        },
        "links": {
            "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******"
        }
    }
}