الانتقال إلى المحتوى الرئيسي
PUT
/
security-groups
/
{securityGroupId}
تحديث مجموعة أمان
curl --request PUT \
  --url https://api.altostrat.io/security-groups/{securityGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "خوادم تطبيقات الويب",
  "description": "يسمح بـ HTTP/S من العالم و SSH من المكتب.",
  "rules": [
    {
      "direction": "inbound",
      "order": 10,
      "protocol": 6,
      "port": "443",
      "address": "0.0.0.0/0",
      "description": "السماح بـ HTTPS"
    },
    {
      "direction": "inbound",
      "order": 20,
      "protocol": 6,
      "port": "80",
      "address": "0.0.0.0/0",
      "description": "السماح بـ HTTP"
    },
    {
      "direction": "inbound",
      "order": 30,
      "protocol": 6,
      "port": "22",
      "address": "prfx_lst_0ujsswThIGTUYm2K8FjOOfxcYpw",
      "description": "السماح بـ SSH من المكتب"
    }
  ],
  "sites": [
    "site_0ujsswThIGTUYm2K8FjOOfxcYpw",
    "site_0ujsswThIGTUYm2K8FjOOfxcYpz"
  ]
}'
{
  "id": "sec_grp_0ujsswThIGTUYm2K8FjOOfxcYpw",
  "name": "خوادم الويب الافتراضية",
  "description": "يسمح بحركة مرور HTTP/HTTPS الواردة من أي مكان.",
  "status": "active",
  "sites": [
    "site_12345"
  ],
  "rules": [
    {
      "id": "fltr_0ujsswThIGTUYm2K8FjOOfxcYpw",
      "direction": "inbound",
      "order": 10,
      "protocol": 6,
      "port": "443",
      "address": "0.0.0.0/0",
      "description": "السماح بحركة مرور HTTPS الواردة"
    }
  ]
}

Authorizations

Authorization
string
header
required

تتم المصادقة عبر رمز ويب JSON (JWT) صادر عن Auth0. قدم الرمز في ترويسة Authorization مع مخطط Bearer.

Path Parameters

securityGroupId
string
required

المعرف الفريد لمجموعة الأمان المراد تحديثها.

Example:

"sec_grp_0ujsswThIGTUYm2K8FjOOfxcYpw"

Body

application/json

الحالة الجديدة لمجموعة الأمان.

يحدد الخصائص القابلة للكتابة لإنشاء أو تحديث مجموعة أمان.

name
string
required

اسم يمكن للإنسان قراءته لمجموعة الأمان.

Required string length: 3 - 255
Example:

"جدار حماية تطبيقات الويب"

rules
object[]
required

قائمة بقواعد جدار الحماية. يتم تحديد ترتيب القواعد بواسطة خاصية order داخل كل كائن قاعدة. يتم استبدال القائمة الكاملة للقواعد عند التحديث.

Maximum length: 250
sites
string[]
required

قائمة بمعرفات المواقع التي يجب تطبيق مجموعة الأمان هذه عليها. يتم استبدال القائمة الكاملة للمواقع عند التحديث.

description
string | null

وصف اختياري لمجموعة الأمان.

Maximum length: 1024
Example:

"يسمح بحركة مرور HTTP/S الواردة ويحظر نواقل الهجوم الشائعة."

Response

كائن مجموعة الأمان المحدث.

يمثل حاوية لمجموعة قواعد جدار حماية ذات حالة.

id
string

المعرف الفريد لمجموعة الأمان، مسبوقًا بـ sec_grp_.

Example:

"sec_grp_0ujsswThIGTUYm2K8FjOOfxcYpw"

name
string

اسم يمكن للإنسان قراءته لمجموعة الأمان.

Example:

"خوادم الويب الافتراضية"

description
string

وصف اختياري لمجموعة الأمان، يوفر المزيد من السياق.

Example:

"يسمح بحركة مرور HTTP/HTTPS الواردة من أي مكان."

status
enum<string>

حالة المزامنة الحالية لمجموعة الأمان. syncing تعني أنه يتم نشر التغييرات وأن المورد مقفل من التعديل.

الخيارات المتاحة:
active,
syncing,
failed
Example:

"active"

sites
string[]

قائمة بمعرفات المواقع التي يتم تطبيق مجموعة الأمان هذه عليها حاليًا.

rules
object[]

قائمة مرتبة من قواعد جدار الحماية التي تحدد سياسة الأمان.