checks API: scan бүртгэлүүд дээр хийсэн шалгалтын мэдээллийг хэрхэн авах вэ?
Энэ хуудсыг AI-аар орчуулж, автоматаар шалгасан. Нарийн тохиргоо хийхээсээ өмнө англи эхтэй тулгаж болно.
Энэ API нь таны компанийн scan бүртгэлүүд дээр хийсэн шалгалтуудын (checks) мэдээллийг буцаана.
Хүсэлт
Формат
GET /cspm/checks?results=<string>&severities=<string>&statuses=<string>&scans=<string>&scan_groups=<string>&rules=<string>&resources=<string>&resource_types=<string>&system_compliance=<string>Параметрүүд
- `id` — Array of Strings; заавал биш: Тийм; Мэдээллийг нь харах шалгалтын (check) ID.
Хэрэв хүсэлтэд энэ параметрийг заагаагүй бол хариунд таны scan бүртгэлүүд дээр хийсэн бүх шалгалтын мэдээлэл орно.
- `results` — Array of Strings; заавал биш: Тийм; Эдгээр үр дүнтэй шалгалтуудыг буцаана.
Боломжит утга: pass, fail.
- `severities` — Array of Strings; заавал биш: Тийм; Эдгээр хүндийн зэрэгтэй (severity) илрүүлэлт (finding) үүсгэсэн шалгалтуудыг буцаана.
Боломжит утга: informational, low, medium, high, critical.
- `statuses` — Array of Strings; заавал биш: Тийм; Эдгээр төлөвтэй илрүүлэлт үүсгэсэн шалгалтуудыг буцаана.
Боломжит утга: open, remediated, risk_accepted, false_positive, needs_review.
- `scans` — Array of Strings; заавал биш: Тийм; Эдгээр scan бүртгэлүүд дээр хийсэн шалгалтуудыг буцаана.
- `scan_groups` — Array of Strings; заавал биш: Тийм; Эдгээр scan бүлгүүд дээр хийсэн шалгалтуудыг буцаана.
- `rules` — Array of Strings; заавал биш: Тийм; Эдгээр дүрэмд суурилсан шалгалтуудыг буцаана.
- `resources` — Array of Strings; заавал биш: Тийм; Эдгээр нөөцийг хамарсан шалгалтуудыг буцаана.
- `resource_types` — Array of Strings; заавал биш: Тийм; Эдгээр төрлийн нөөцийг хамарсан шалгалтуудыг буцаана.
- `system_compliance` — Array of Strings; заавал биш: Тийм; Эдгээр нийцлийн стандартуудтай холбоотой шалгалтуудыг буцаана.
Жишээ
Cloud scan-уудад саяхан хийсэн бүх шалгалтын мэдээллийг хүсэх:
GET /cspm/checks0015c4a9-82b9-4a40-9bf4-55130c****** ID-тай шалгалтын мэдээллийг хүсэх:
GET /cspm/checks/0015c4a9-82b9-4a40-9bf4-55130c******high хүндийн зэрэгтэй илрүүлэлт үүсгэсэн, мөн Configuration Recorder төрлийн нөөцийг хамарсан бүх шалгалтыг хүсэх:
GET /cspm/checks?severities=high&resource_types=Configuration RecorderХариу
Формат
{
"data": [
{
"id": "string",
"type": "check",
"attributes": {
"resource_region": "string",
"resource_id": "string",
"resource_name": "string",
"resource_type": "string",
"result": "pass",
"severity": "informational",
"status": "open",
"created_at": "2024-01-04T16:23:10.219Z",
"scan_name": "string",
"scan_group_name": "string",
"title": "string",
"description": "string",
"original_severity": "informational"
},
"relationships": {
"scan": {
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f******",
"type": "scan"
}
},
"scan_group": {
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f******",
"type": "scan_group"
}
},
"rule": {
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f******",
"type": "rule",
"meta": {
"name": "string",
"version": 0
}
}
},
"controls": {
"data": [
{
"id": "string",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "string",
"section_id": "string"
}
}
]
}
},
"links": {
"self": "string"
}
}
],
"links": {
"self": "string",
"next": "string"
},
"meta": {
"total": 0,
"elapsed": 0
}
}Шинж чанарууд
Энэ endpoint нь олон шинж чанар агуулсан объект буцаана:
- `data` — Array; Тодорхой нэг шалгалтын мэдээллийг агуулсан шинж чанаруудын жагсаалт.
- `id` — String; Шалгалтын ID.
- `type` — String; Объектын дүрсэлж буй entity-ийн төрөл.
Боломжит утга: check.
- `attributes` — Array; Шалгалтын мэдээллийг өгнө.
- `resource_region` — String; Scan-д хамрагдсан нөөц байрлах бүс (region).
- `resource_id` — String; Scan-д хамрагдсан нөөцийн ID.
- `resource_name` — String; Scan-д хамрагдсан нөөцийн нэр.
- `resource_type` — String; Scan-д хамрагдсан нөөцийн төрөл.
- `result` — String; Scan-ий үр дүн.
Боломжит утга: pass, fail.
fail утга нь scan-ий үр дүнд илрүүлэлт (finding) үүссэнийг илтгэнэ.
- `severity` — String; Scan-ий үр дүнд үүссэн илрүүлэлтэд оноосон хүндийн зэрэг.
Боломжит утга: informational, low, medium, high, critical.
- `status` — String; Scan-ий үр дүнд үүссэн илрүүлэлтийн одоогийн төлөв.
Боломжит утга: open, remediated, risk_accepted, false_positive, needs_review.
- `created_at` — String; Илрүүлэлт үүссэн цаг, огноо.
- `scan_name` — String; Scan хийгдсэн scan бүртгэлийн нэр.
- `scan_group_name` — String; Scan хийгдсэн scan бүртгэл харьяалагдах scan бүлгийн нэр.
- `title` — String; Scan-ий үр дүнд үүссэн илрүүлэлтийн гарчиг.
- `description` — String; Scan-ий үр дүнд үүссэн илрүүлэлтийн тайлбар.
- `original_severity` — String; Илрүүлэлтэд анх оноосон хүндийн зэрэг.
Боломжит утга: informational, low, medium, high, critical.
- `relationships` — Object; Холбоотой entity-үүдийн жагсаалт.
- `scans` — Object; Шалгалт хийгдсэн scan бүртгэлийн мэдээллийг агуулна.
- `data` — Array of Strings; Холбоотой scan бүртгэлийн мэдээллийг өгөх жагсаалт.
- `id` — String; Холбоотой scan бүртгэлийн ID.
- `type` — String; Холбоотой entity-ийн төрөл.
Боломжит утга: scan.
- `scans` — Object; Шалгалт хийгдсэн scan бүлгийн мэдээллийг агуулна.
- `data` — Array of Strings; Холбоотой scan бүлгийн мэдээллийг өгөх жагсаалт.
- `id` — String; Холбоотой scan бүлгийн ID.
- `type` — String; Холбоотой entity-ийн төрөл.
Боломжит утга: scan_group.
- `rule` — Object; Scan-ий үндэс болсон дүрмийн мэдээллийг агуулна.
- `data` — Object; Холбоотой дүрмийн мэдээллийг өгөх жагсаалт.
- `id` — String; Холбоотой дүрмийн ID.
- `type` — String; Холбоотой entity-ийн төрөл.
Боломжит утга: rule
- `meta` — Object; Холбоотой дүрмийн ерөнхий мэдээллийг өгнө.
- `name` — String; Холбоотой дүрмийн нэр.
- `version` — Integer; Хүсэлт хийх үеийн холбоотой дүрмийн хувилбар.
- `controls` — Object; Scan-ий үндэс болсон controls-ийн жагсаалт.
- `data` — Object; Холбоотой entity-ийн мэдээллийг өгөх жагсаалт.
- `id` — String; Холбоотой control-ийн ID.
- `type` — String; Холбоотой entity-ийн төрөл.
Боломжит утга: control.
- `meta` — Array of Strings; Холбоотой control-ийн ерөнхий мэдээллийг өгнө.
- `compliance_type` — String; Холбоотой entity-ийн төрөл.
Боломжит утга: system_compliance.
- `compliance_id` — String; Control харьяалагдах стандартын ID.
- `section_id` — String; Control харьяалагдах хэсгийн ID.
- `links` — Array; Энэ хэсэгт хамаарах холбоосуудыг өгнө.
- `self` — String; Энэ хэсэг рүү шууд заасан холбоос.
- Доорх шинж чанарууд зөвхөн таны scan бүртгэлүүд дээр хийсэн бүх шалгалтын мэдээллийг авах үед (хүсэлтэд
idзаагаагүй үед) буцна. - `links` — Array; Хуудсууд хооронд шилжих холбоосуудыг өгнө.
- `self` — String; Энэ шалгалтын мэдээлэл рүү шууд заасан холбоос.
- `next` — String; Хүсэлтээр буцсан дараагийн шалгалтын мэдээлэл рүү шууд заасан холбоос.
- `meta` — Array of Integers; Хүсэлтээр буцсан мэдээллийн ерөнхий мэдээллийг өгнө.
- `total` — Integer; Таны хүсэлтээр буцсан үр дүнгийн нийт тоо.
- `elapsed` — Integer; Таны үзсэн, одоо харагдаж буйг оруулсан үр дүнгийн тоо.
Жишээ
Таны scan бүртгэлүүд дээр хийсэн бүх шалгалтын мэдээллийг хүссэн:
{
"data": [
{
"id": "0015c4a9-82b9-4a40-9bf4-55130c******",
"type": "check",
"attributes": {
"resource_region": "ap-southeast-1",
"resource_id": "arn:aws:ec2:ap-southeast-1:829960215***:security-group/sg-06c75b15c86d92***",
"resource_name": "sg-06c75b15c86d92***",
"resource_type": "EC2 Security Group",
"result": "pass",
"severity": "medium",
"status": null,
"created_at": "2023-12-31T17:08:45+00:00",
"scan_name": "[Staging] ****** AWS Account",
"scan_group_name": "demo-group",
"title": "Unrestricted EC2 Security Group Ingress Rule - MSSQL Access",
"description": "It was discovered that one or more AWS EC2 security groups declare unrestricted ingress access to MSSQL. MSSQL runs on TCP port 1433 by default.\n\nA security group acts as a virtual firewall for an instance to control inbound and outbound traffic. When launching an instance in a VPC, it is possible to assign up to five security groups to the instance. Security groups act at the instance level, not the subnet level.",
"original_severity": "medium"
},
"relationships": {
"scan": {
"data": {
"id": "3c807067-4097-43ac-82d7-4ee2ef******",
"type": "scan"
}
},
"scan_group": {
"data": {
"id": "16beea3e-d011-4c0c-932c-8d8e53******",
"type": "scan_group"
}
},
"rule": {
"data": {
"id": "407928a2-6539-4eb2-abe5-959613******",
"type": "rule",
"meta": {
"name": "cloud_scan/aws/ec2/security_group_unrestricted_ingress_access_mssql",
"version": 1
}
}
},
"controls": {
"data": [
{
"id": "CM-7",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "nist-sp-800-53-r5",
"section_id": "CM"
}
},
{
"id": "I.c.2.h",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "seojk-29-2022",
"section_id": "I"
}
},
{
"...": "..."
}
]
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/checks/0015c4a9-82b9-4a40-9bf4-55130c******"
}
},
{
"id": "001c7b5e-26c3-41e3-94f3-f88360******",
"type": "check",
"attributes": {
"resource_region": "eu-north-1",
"resource_id": null,
"resource_name": null,
"resource_type": "Configuration Recorder",
"result": "pass",
"severity": "medium",
"status": null,
"created_at": "2023-12-31T17:08:45+00:00",
"scan_name": "[Staging] ****** AWS Account",
"scan_group_name": "demo-group",
"title": "Config Log File Delivery Failing",
"description": "It was discovered that one or more Config Configuration Recorder failed to delivery log files to their assigned S3 bucket.\n\nAWS Config is a service that enables you to assess, audit, and evaluate the configurations of your AWS resources. Config continuously monitors and records your AWS resource configurations and allows you to automate the evaluation of recorded configurations against desired configurations.\n\nAWS Config delivers configuration items of the AWS resources that AWS Config is recording to the Amazon S3 bucket that you specified when you configured your delivery channel.\n\nUsually AWS Config fails to delivery its log files to the specified S3 Bucket for a variety of reasons\n- S3 Bucket is missing\n- IAM Role which it is using is missing or not authorized to access the S3 Bucket ",
"original_severity": "medium"
},
"relationships": {
"scan": {
"data": {
"id": "3c807067-4097-43ac-82d7-4ee2ef******",
"type": "scan"
}
},
"scan_group": {
"data": {
"id": "16beea3e-d011-4c0c-932c-8d8e53******",
"type": "scan_group"
} },
"rule": {
"data": {
"id": "d660659c-acea-4b0d-bc7a-fa2acd******",
"type": "rule",
"meta": {
"name": "cloud_scan/aws/config/log_files_delivery_failing",
"version": 1
}
}
},
"controls": {
"data": [
{
"id": "7.3.2",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "seojk-21",
"section_id": "7"
}
},
{
"id": "2.9.4",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "korean-isms-p",
"section_id": "2.9"
}
},
{
"...": "..."
}
]
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/checks/001c7b5e-26c3-41e3-94f3-f88360******"
}
},
{
"...": "..."
}
],
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/checks?page_limit=500",
"next": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/checks?page_cursor=eyJ0b3RhbCI6IDMwODE3LCAiZWxhcHNlZCI6IDUwMCwgIm5vX2xhdGVyX3RoYW4iOiAiMjAyNC0wMS0xNFQwNjo0NzoxNS40OTQwNDAiLCAibmV4dF9iZWdpbl91aWQiOiAiMTIwMzQyODctYjdkZC00NmZhLWE5Y2YtMmY2OTdiYmZlNGRjIn0%3D&page_limit=500"
},
"meta": {
"total": 30817,
"elapsed": 500
}
}0015c4a9-82b9-4a40-9bf4-55130c****** ID-тай шалгалтын мэдээллийг хүссэн:
{
"data": {
"id": "0015c4a9-82b9-4a40-9bf4-55130c******",
"type": "check",
"attributes": {
"resource_region": "ap-southeast-1",
"resource_id": "arn:aws:ec2:ap-southeast-1:829960215***:security-group/sg-06c75b15c86d92***",
"resource_name": "sg-06c75b15c86d92***",
"resource_type": "EC2 Security Group",
"result": "pass",
"severity": "medium",
"status": null,
"created_at": "2023-12-31T17:08:45+00:00",
"scan_name": "[Staging] ****** AWS Account",
"scan_group_name": "demo-group",
"title": "Unrestricted EC2 Security Group Ingress Rule - MSSQL Access",
"description": "It was discovered that one or more AWS EC2 security groups declare unrestricted ingress access to MSSQL. MSSQL runs on TCP port 1433 by default.\n\nA security group acts as a virtual firewall for an instance to control inbound and outbound traffic. When launching an instance in a VPC, it is possible to assign up to five security groups to the instance. Security groups act at the instance level, not the subnet level.",
"original_severity": "medium"
},
"relationships": {
"scan": {
"data": {
"id": "3c807067-4097-43ac-82d7-4ee2ef******",
"type": "scan"
}
},
"scan_group": {
"data": {
"id": "16beea3e-d011-4c0c-932c-8d8e53******",
"type": "scan_group"
}
},
"rule": {
"data": {
"id": "407928a2-6539-4eb2-abe5-959613******",
"type": "rule",
"meta": {
"name": "cloud_scan/aws/ec2/security_group_unrestricted_ingress_access_mssql",
"version": 1
}
}
},
"controls": {
"data": [
{
"id": "CC6.0.24",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "sg-pdpa-26-2012",
"section_id": "CC6"
}
},
{
"id": "IV.2.17",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "pojk-11-2022",
"section_id": "IV"
}
},
{
"...": "..."
}
]
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/checks/0015c4a9-82b9-4a40-9bf4-55130c******"
}
}
}high хүндийн зэрэгтэй илрүүлэлт үүсгэсэн, Configuration Recorder төрлийн нөөцийг хамарсан шалгалтуудын мэдээллийг хүссэн:
{
"data": [
{
"id": "05dcf14e-8ef5-470b-811b-b27052******",
"type": "check",
"attributes": {
"resource_region": "ap-south-1",
"resource_id": null,
"resource_name": null,
"resource_type": "Configuration Recorder",
"result": "fail",
"severity": "high",
"status": "open",
"created_at": "2024-01-04T17:06:14+00:00",
"scan_name": "chifeng-backyard",
"scan_group_name": "Test Scan Group 1",
"title": "AWS Config Not Enabled",
"description": "It was discovered that AWS Config Service is not enabled and recording in one or more regions. AWS Config keeps track of changes in the configurations made to selected critical AWS resources. ",
"original_severity": "high"
},
"relationships": {
"scan": {
"data": {
"id": "a76b1756-fde2-4754-8019-af82d9******",
"type": "scan"
}
},
"scan_group": {
"data": {
"id": "87b1da1d-9ce4-4924-b8b2-5f0b06******",
"type": "scan_group"
}
},
"rule": {
"data": {
"id": "c4b1c0f5-85d7-42d2-aee1-bb11a7******",
"type": "rule",
"meta": {
"name": "cloud_scan/aws/config/not_in_use",
"version": 1
}
}
},
"controls": {
"data": [
{
"id": "4.1.1",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "ccop-v2",
"section_id": "4"
}
},
{
"id": "CM-8(2)",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "nist-sp-800-53-r5",
"section_id": "CM"
}
},
{
"...": "..."
}
]
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/checks/05dcf14e-8ef5-470b-811b-b27052******"
}
},
{
"id": "14c592c3-1b3f-4b1f-ae62-e77dc810b79f",
"type": "check",
"attributes": {
"resource_region": "eu-west-3",
"resource_id": null,
"resource_name": null,
"resource_type": "Configuration Recorder",
"result": "fail",
"severity": "high",
"status": "open",
"created_at": "2024-01-04T17:06:14+00:00",
"scan_name": "chifeng-backyard",
"scan_group_name": "Test Scan Group 1",
"title": "AWS Config Not Enabled",
"description": "It was discovered that AWS Config Service is not enabled and recording in one or more regions. AWS Config keeps track of changes in the configurations made to selected critical AWS resources. ",
"original_severity": "high"
},
"relationships": {
"scan": {
"data": {
"id": "a76b1756-fde2-4754-8019-af82d9******",
"type": "scan"
}
},
"scan_group": {
"data": {
"id": "87b1da1d-9ce4-4924-b8b2-5f0b06******",
"type": "scan_group"
}
},
"rule": {
"data": {
"id": "c4b1c0f5-85d7-42d2-aee1-bb11a7******",
"type": "rule",
"meta": {
"name": "cloud_scan/aws/config/not_in_use",
"version": 1
}
}
},
"controls": {
"data": [
{
"id": "4.1.1",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "ccop-v2",
"section_id": "4"
}
},
{
"id": "CM-8(2)",
"type": "control",
"meta": {
"compliance_type": "system_compliance",
"compliance_id": "nist-sp-800-53-r5",
"section_id": "CM"
}
},
{
"...": "..."
}
]
}
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/checks/14c592c3-1b3f-4b1f-ae62-e77dc810b79f"
}
},
{
"...": "..."
}
],
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/checks?severities=high&page_limit=500&resource_types=Configuration+Recorder",
"next": null
},
"meta": {
"total": 35,
"elapsed": 35
}
}Энэ хуудсанд гарсан нэр томъёо
- Endpoint
- Хамгаалж буй компьютер, сервер, виртуал машин