API Insiden

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Incidents API memungkinkan Anda melihat statistik insiden keamanan yang terkait dengan deteksi penyalahgunaan.

Parameter dalam contoh panggilan API

Bagian berikut memberikan contoh panggilan API yang menggunakan Incidents API. Panggilan API berisi parameter variabel berikut:

  • ORG adalah organisasi Anda.
  • ENV adalah lingkungan yang Anda inginkan untuk menghitung skor.
  • INCIDENT_UUID adalah UUID untuk insiden tersebut.
  • $TOKEN adalah variabel lingkungan untuk token akses OAuth.

Membuat daftar insiden dan mendapatkan detailnya

Contoh berikut menunjukkan cara membuat daftar insiden dan mendapatkan detailnya.

Contoh: Menampilkan daftar semua insiden untuk lingkungan

Untuk menampilkan daftar semua insiden untuk lingkungan, kirim permintaan berikut:

curl "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityIncidents" \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

Lihat halaman referensi SecurityIncident untuk mengetahui deskripsi permintaan dan respons.

Contoh: Mendapatkan detail insiden tertentu

Untuk mendapatkan detail insiden tertentu, kirim permintaan seperti berikut:

curl "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityIncidents/INCIDENT_UUID" \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

dengan INCIDENT_UUID adalah UUID untuk insiden, yang ditampilkan dalam kolom name oleh panggilan yang ditunjukkan dalam Contoh: Mencantumkan semua insiden untuk lingkungan.

Lihat halaman referensi SecurityIncident untuk mengetahui deskripsi permintaan dan respons.

Mengarsipkan insiden

Untuk membantu membedakan antara insiden yang telah diselidiki dan yang belum, Anda dapat mengarsipkan insiden yang tidak lagi memerlukan perhatian. Pengarsipan insiden memiliki efek berikut:

  • Di UI Apigee, insiden yang diarsipkan tidak ditampilkan dalam daftar Environment details > Incidents (asalkan Include arsip failed tidak dipilih).
  • Di API, saat Anda melakukan panggilan untuk mencantumkan semua insiden, insiden yang diarsipkan memiliki baris berikut: 
    "observability": "ARCHIVED"

    Anda dapat menggunakan kolom "observability" untuk memfilter insiden yang diarsipkan dari daftar insiden.

    Nilai yang mungkin untuk "observability" adalah:

    • ACTIVE
    • ARCHIVED

Insiden yang diarsipkan tidak dihapus: Anda dapat membatalkan pengarsipannya kapan saja, yang akan mengubah "observability" insiden menjadi ACTIVE.

Contoh berikut menunjukkan cara mengarsipkan dan membatalkan pengarsipan insiden.

Mengarsipkan insiden

Untuk mengarsipkan insiden, kirim permintaan seperti berikut:

curl "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityIncidents/INCIDENT_UUID?updateMask=observability" \
       -X POST \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"name": "organizations/ORG/environments/ENV/securityIncidents/INCIDENT_UUID",
            "observability": "ARCHIVED"}' \
       -X PATCH

Ini akan mengembalikan respons seperti berikut:

{
    "name": "INCIDENT_UUID",
    "displayName": "Multi type attack from US",
    "firstDetectedTime": "2023-04-04T17:00:00Z",
    "lastDetectedTime": "2023-09-12T03:10:00Z",
    "detectionTypes": [
      "Advanced Anomaly Detection",
      "OAuth Abuser"
    ],
    "trafficCount": "4052130",
    "containsMlAbuses": false,
    "riskLevel": "MODERATE",
    "observability": "ARCHIVED"
}

Baris terakhir, "observability": "ARCHIVED", menunjukkan bahwa insiden telah diarsipkan.

Membatalkan pengarsipan insiden

Untuk membatalkan pengarsipan insiden, gunakan panggilan yang sama seperti di bagian sebelumnya, tetapi gunakan jalur 

"observability": "ACTIVE"

Filter insiden menurut status arsip

Contoh berikutnya memfilter hasil panggilan untuk membuat daftar insiden sehingga hanya insiden aktif yang ditampilkan.

curl "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityIncidents?filter=observability=\"ACTIVE\"" \
       -X POST \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json"

Ini akan mengembalikan hasil seperti berikut.

{
  "securityIncidents": [
    {
      "name": "1850fbb9-53a9-44e7-8893-f0b0c987d55e",
      "displayName": "Multi type attack from US",
      "firstDetectedTime": "2023-04-04T17:00:00Z",
      "lastDetectedTime": "2023-09-12T03:10:00Z",
      "detectionTypes": [
        "Advanced Anomaly Detection",
        "OAuth Abuser"
      ],
      "trafficCount": "4052130",
      "containsMlAbuses": false,
      "riskLevel": "MODERATE",
      "observability": "ACTIVE"
    }
  ],
  "nextPageToken": "ClAKAjUwEj1saXN0U2VjdXJpdHlJbmNpZGVudC9hcGlzZWN1cml0eS1tbHRlc3QtYXV0b3B1c2gvZGVmYXVsdC1wcm9kGgsI_KW1qQYQ6fqSDg"
}

Mengarsipkan atau membatalkan pengarsipan beberapa insiden keamanan

Untuk mengarsipkan atau membatalkan pengarsipan lebih dari satu insiden keamanan, masukkan perintah seperti berikut:

curl "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityIncidents:batchUpdate" \
       -X POST \
       -d '{"requests": 
        [{"security_incident": {"name": "organizations/apisecurity-mltest-autopush/environments/default-prod/securityIncidents/INCIDENT_UUID1", "observability": "ARCHIVE"}, "update_mask": "observability"}, 
         {"security_incident": {"name": "organizations/apisecurity-mltest-autopush/environments/default-prod/securityIncidents/INCIDENT_UUID2", "observability": "ARCHIVE"}, "update_mask": "observability"}]}'

Batasan Security Incidents API

Security Incidents API memiliki batasan berikut:

  • Insiden disimpan selama maksimum 14 bulan.
  • ListIncidents hanya mendukung filter untuk hal berikut:
    • first_detected_time
    • last_detected_time
    • apiproxy
  • Saat Anda pertama kali mengaktifkan Advanced API untuk organisasi, atau kemudian mengaktifkannya kembali, akan ada penundaan saat peristiwa dikelompokkan ke dalam insiden. Setelah itu, insiden akan dihitung ulang secara berkala.