update API: шалгалтын төлөв, ноцтой байдлыг шинэчлэх

Энэ API нь нэг буюу хэд хэдэн шалгалтын (check) атрибутуудыг шинэчилнэ.

Хүсэлт

HTTP method ба URL

POST /cspm/vm/update

Body-ийн формат

{
  "status": "open",
  "status_remarks": "string",
  "expires_at": "2024-01-08",
  "severity": "informational",
  "severity_remarks": "string",
  "ids": [
    "string"
  ]
}

Параметрүүд

• status — String; заавал биш: Тийм*; сонгосон шалгалтуудын төлвийг өөрчилнө. Боломжит утга: open, remediated, risk_accepted, false_positive, needs_review.
• status_remarks — String; заавал биш: Тийм; төлвийн өөрчлөлттэй холбоотой тэмдэглэл нэмнэ. Энэ талбарын дээд урт 2000 тэмдэгт.

> Тэмдэглэл: Энэ параметрийг зөвхөн хүсэлтэд status параметр орсон үед ашиглаж болно.

• expires_at — String; заавал биш: Тийм; шинэ төлвийн дуусах хугацааг тохируулна. Дуусах хугацаа өнгөрсний дараа шалгалтуудын төлөв needs_review болж өөрчлөгдөнө. Параметр yyyy-mm-dd огнооны форматыг хүлээн авна.

> Тэмдэглэл: Энэ параметрийг зөвхөн хүсэлтэд status параметр орсон бөгөөд утга нь risk_accepted байх үед ашиглаж болно.

• severity — String; заавал биш: Тийм*; сонгосон шалгалтуудын ноцтой байдлыг өөрчилнө. Боломжит утга: informational, low, medium, high, critical.
• severity_remarks — String; заавал биш: Тийм; ноцтой байдлын өөрчлөлттэй холбоотой тэмдэглэл нэмнэ. Энэ талбарын дээд урт 2000 тэмдэгт.

> Тэмдэглэл: Энэ параметрийг зөвхөн хүсэлтэд severity параметр орсон үед ашиглаж болно.

• ids — Array of Strings; заавал биш: Үгүй; өөрчлөх шалгалтуудын ID. Нэг хүсэлтэд хамгийн ихдээ 100 ID нэмж болно. ID нь RFC 4122 форматтай байх бөгөөд Cloud Security мэдээллийн сангийн шалгалттай тохирч байх ёстой.

status болон severity параметрийн аль нэг эсвэл хоёулаа хүсэлтэд заавал орсон байх ёстой.

Жишээнүүд

001ca9fe-7f34-4a43-9d9c-7d543badd802, 00dff8ea-3bd9-447b-ba57-2da616357238, 01e1706e-969f-42f9-9d27-4a5971251972 шалгалтын бичлэгүүдийн төлвийг remediated болгох:

{
    "status": "remediated",
    "status_remarks": "Updated status via POST endpoint",
    "ids": [
        "001ca9fe-7f34-4a43-9d9c-7d543badd802",
        "00dff8ea-3bd9-447b-ba57-2da616357238",
        "01e1706e-969f-42f9-9d27-4a5971251972"
    ]
}

001ca9fe-7f34-4a43-9d9c-7d543badd802, 00dff8ea-3bd9-447b-ba57-2da616357238, 01e1706e-969f-42f9-9d27-4a5971251972 шалгалтын бичлэгүүдийн төлвийг risk_accepted болгож, төлвийн хугацааг 2025-12-10-нд дуусгах:

{
    "status": "risk_accepted",
    "status_remarks": "Updated status via POST endpoint",
    "expires_at": "2025-12-10",
    "ids": [
        "001ca9fe-7f34-4a43-9d9c-7d543badd802",
        "00dff8ea-3bd9-447b-ba57-2da616357238",
        "01e1706e-969f-42f9-9d27-4a5971251972"
    ]
}

001ca9fe-7f34-4a43-9d9c-7d543badd802, 00dff8ea-3bd9-447b-ba57-2da616357238, 01e1706e-969f-42f9-9d27-4a5971251972 шалгалтын бичлэгүүдийн ноцтой байдлыг high болгох:

{
    "severity": "high",
    "severity_remarks": "Updated severity via POST endpoint",
    "ids": [
        "001ca9fe-7f34-4a43-9d9c-7d543badd802",
        "00dff8ea-3bd9-447b-ba57-2da616357238",
        "01e1706e-969f-42f9-9d27-4a5971251972"
    ]
}

001ca9fe-7f34-4a43-9d9c-7d543badd802, 00dff8ea-3bd9-447b-ba57-2da616357238, 01e1706e-969f-42f9-9d27-4a5971251972 шалгалтын бичлэгүүдийн төлвийг risk_accepted болгож, төлвийн хугацааг 2025-12-10-нд дуусгаж, ноцтой байдлыг high болгох:

{
    "status": "risk_accepted",
    "status_remarks": "Updated status via POST endpoint",
    "expires_at": "2022-12-10",
    "severity": "high",
    "severity_remarks": "Updated severity via POST endpoint",
    "ids": [
        "001ca9fe-7f34-4a43-9d9c-7d543badd802",
        "00dff8ea-3bd9-447b-ba57-2da616357238",
        "01e1706e-969f-42f9-9d27-4a5971251972"
    ]
}

Хариу

Формат

{
  "statusCode": 0,
  "message": "string"
}

Атрибутууд

• statusCode — Integer; таны хүсэлтийн төлвийг заана.
• message — String; төлвийн тайлбарыг өгнө.

Боломжит утгууд:

• 200 - OK

Хүсэлт амжилттай боллоо.

• 400 - Bad Request

Хүсэлтийн формат эсвэл өгсөн утгууд буруу байна.

• 504 - Gateway Timeout.

Хүсэлт амжилтгүй боллоо. Дараа дахин оролдоно уу.

Жишээнүүд

Хүсэлт амжилттай болсон тохиолдол:

{
    "status_code": 200,
    "message": {
        "status": "risk_accepted",
        "status_remarks": "Status updated via POST endpoint",
        "expires_at": "2022-12-10",
        "severity": "high",
        "severity_remarks": "Severity updated via POST endpoint",
        "ids": [
            "001ca9fe-7f34-4a43-9d9c-7d543badd802",
            "00dff8ea-3bd9-447b-ba57-2da616357238",
            "01e1706e-969f-42f9-9d27-4a5971251972"
        ]
    }
}

Хүсэлтэд хүчинтэй шалгалтын ID байхгүй тохиолдол:

{
    "status_code": 400,
    "message": {
        Error: Please provide one or more check ids
    }
}

ids параметрт орсон ID-ийн тоо хүсэлтийн хязгаараас хэтэрсэн тохиолдол:

{
    "status_code": 400,
    "message": {
        Error: Check ids should not exceed the prescribed request limit. Limit:100/request
    }
}

Ашигласан шалгалтын ID буруу тохиолдол:

{
    "status_code": 400,
    "message": {
        Error: The following check ids were not found: 001ca9fe-7f34-4a43-9d9c-7d543badd801
    }
}

Хүсэлтэд status ч, severity ч параметр байхгүй тохиолдол:

{
    "status_code": 400,
    "message": {
        Error: Please provide a status change, severity change or both.
    }
}

status параметрт буруу утга өгсөн тохиолдол:

{
    "status_code": 400,
    "message": {
        Error: 'invlid_status_example' is not a valid status. Valid statuses:open, remediated, risk_accepted, false_positive, needs_review.
    }
}

status_remarks параметрийн утга уртын хязгаараас хэтэрсэн тохиолдол:

{
    "status_code": 400,
    "message": {
        Error: status_remarks must not exceed 2000 characters
    }
}

expires_at параметрийн утга буруу тохиолдол:

{
    "status_code": 400,
    "message": {
        Error: The date format is not valid. Required format:'yyyy-mm-d-d'
    }
}

Хүсэлтэд status параметр орсон бөгөөд утга нь risk_accepted биш бол expires_at параметрийг ашиглах боломжгүй.

{
    "status_code": 400,
    "message": {
        Error: Only the 'risk_accepted' status can be set to expire.
    }
}