الانتقال إلى المحتوى الرئيسي
GET
/
instances
/
{instanceId}
استرداد نسخة بوابة مقيدة
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "auth_integration_id": "c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
  "strategy": "oauth2",
  "name": "شبكة واي فاي ضيوف المكتب الرئيسي",
  "session_ttl": 43200,
  "auth_window_ttl": 300,
  "theme": {
    "logo": "https://api.altostrat.io/captive/assets/.../logo_abc123.png?signature=...",
    "icon": "https://api.altostrat.io/captive/assets/.../icon_def456.png?signature=...",
    "accent_text": "#FFFFFF",
    "accent_color": "#0396d5",
    "text_color": "#4f4f4f",
    "secondary_text_color": "#8f8f8f",
    "background_color": "#f9f9f9",
    "border_color": "#e0e0e0",
    "box_color": "#ffffff"
  },
  "terms_text": "بالاتصال، أنت توافق على شروط الخدمة الخاصة بنا...",
  "sites": [
    {
      "id": "a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6",
      "subnets": [
        "192.168.88.0/24"
      ]
    }
  ],
  "created_at": "2025-10-29T12:00:00Z",
  "preview_url": "https://captive.altostr.at/preauth?token=eyJpdiI6..."
}

Authorizations

​
Authorization
string
header
required

مصادقة مفتاح API. قدم الرمز الخاص بك في ترويسة 'Authorization'. مثال: Authorization: Bearer <YOUR_TOKEN>

Path Parameters

​
instanceId
string<uuid>
required

المعرف الفريد لنسخة البوابة المقيدة.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

Response

نسخة البوابة المقيدة المطلوبة.

​
id
string<uuid>

المعرف الفريد للنسخة.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

​
auth_integration_id
string<uuid> | null

معرف تكامل المصادقة المستخدم إذا كانت الاستراتيجية 'oauth2'. يكون null لاستراتيجية 'coupon'.

Example:

"c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f"

​
strategy
enum<string>

طريقة المصادقة لهذه البوابة المقيدة.

الخيارات المتاحة:
oauth2,
coupon
Example:

"oauth2"

​
name
string

اسم قابل للقراءة البشرية للنسخة.

Example:

"شبكة واي فاي ضيوف المكتب الرئيسي"

​
session_ttl
integer

المدة بالثواني التي تظل فيها جلسة المستخدم نشطة بعد المصادقة الناجحة.

Example:

43200

​
auth_window_ttl
integer

لاستراتيجية OAuth2، المدة بالثواني التي يتم فيها فتح الحديقة المسورة مؤقتًا للسماح للمستخدم بإكمال المصادقة مع موفر الهوية.

Example:

300

​
theme
object

مجموعة من إعدادات العلامة التجارية والمظهر.

​
terms_text
string | null

نص الشروط والأحكام الذي يمكن عرضه للمستخدم.

Example:

"بالاتصال، أنت توافق على شروط الخدمة الخاصة بنا..."

​
sites
object[]

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

​
created_at
string<date-time>

الطابع الزمني عند إنشاء النسخة.

Example:

"2025-10-29T12:00:00Z"

​
preview_url
string<uri> | null

رابط مؤقت وموقع لمعاينة مظهر البوابة المقيدة.

Example:

"https://captive.altostr.at/preauth?token=eyJpdiI6..."