scans API: scan бүртгэлийн мэдээлэл авах

Энэ API нь Scan бүртгэлүүдийн (scan account) мэдээллийг буцаана. Scan бүртгэл нь үүлэн (cloud) бүртгэлтэй холбоотой бүх мэдээлэл, тохиргоог агуулна.

Хүсэлт

Формат

GET /setting/scans/{id}

Параметрүүд

• id — String; заавал биш: Тийм; мэдээллийг нь харуулах scan бүртгэлийн ID. Хүсэлтэд энэ параметрийг заагаагүй бол хариунд таны компанийн бүх scan бүртгэлийн мэдээлэл орно.

Жишээнүүд

Компанийн бүх scan бүртгэлийн мэдээллийг хүсэх:

GET /setting/scans/

2eee770a-e63d-47b2-a9ff-676f3a****** scan бүртгэлийн мэдээллийг хүсэх:

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

Хариу

Формат

{
  "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
  }
}

Атрибутууд

Энэ endpoint нь үүлэн бүртгэлүүдийн мэдээллийг тус тусад нь агуулсан олон атрибуттай обьект буцаана.

• data — Object; scan бүртгэлтэй холбоотой мэдээллийг агуулсан атрибутуудын жагсаалт.
• id — String; scan бүртгэлийн ID.
• type — String; обьектын тодорхойлж буй зүйлийн төрөл. Боломжит утга: scan.
• attributes — Object; scan бүртгэлийн мэдээллийг өгнө.
• name — String; scan бүртгэлийн нэр.
• target — String; scan бүртгэл хамаарах үүлэн үйлчилгээ үзүүлэгч дээрх бүртгэлийн нэр.
• is_enabled — Boolean; энэ scan бүртгэлд шалгалт (scan) идэвхтэй эсэхийг заана.
• is_archived — Boolean; scan бүртгэлийг идэвхгүй болгосон эсэхийг заана.
• created_at — String; үүлэн бүртгэлийг холбосон цаг, огноо.
• relationships — Object; холбогдох обьектуудын жагсаалт.
• scan_group — Object; scan бүртгэл хамаарах scan бүлгүүдийн жагсаалт.
• data — Array of Strings; холбогдох scan бүлгийн мэдээллийг агуулсан жагсаалт.
• id — String; холбогдох scan бүлгийн ID.
• type — String; холбогдох обьектын төрөл. Боломжит утга: scan_group.
• links — Array of Strings; энэ scan бүртгэлд хамаарах холбоосуудыг өгнө.
• self — String; энэ тодорхой scan бүртгэлийн мэдээлэл рүү шууд очих холбоос.
• Доорх атрибутууд нь компанийн бүх үүлэн бүртгэлийн мэдээллийг хүссэн үед (хүсэлтэд id заагаагүй үед) л буцаагдана.
• links — Array of Strings; хуудсуудын хооронд шилжих холбоосуудыг өгнө.
• self — String; энэ тодорхой scan бүртгэлийн мэдээлэл рүү шууд очих холбоос.
• next — String; хүсэлтийн буцаасан дараагийн scan бүртгэлийн мэдээлэл рүү шууд очих холбоос.
• meta — Array of Integers; хүсэлтийн буцаасан мэдээллийн ерөнхий мэдээллийг өгнө.
• total — Integer; хүсэлтийн буцаасан үр дүнгийн нийт тоо.
• elapsed — Integer; одоо харуулж буйг оруулаад таны үзсэн үр дүнгийн тоо.

Жишээнүүд

Компанид холбосон бүх үүлэн бүртгэлийн мэдээллийг хүссэн тохиолдол:

{
    "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
    }
}

2eee770a-e63d-47b2-a9ff-676f3a****** ID-тай тодорхой үүлэн scan бүртгэлийн мэдээллийг хүссэн тохиолдол:

{
    "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******"
        }
    }
}