Langsung ke konten utama
PUT
/
instances
/
{instanceId}
Perbarui instance captive portal
curl --request PUT \
  --url https://api.altostrat.io/instances/{instanceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "WiFi Tamu Kantor Utama",
  "strategy": "oauth2",
  "session_ttl": 43200,
  "auth_integration_id": "c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
  "auth_window_ttl": 300,
  "theme": {
    "accent_text": "#FFFFFF",
    "accent_color": "#0396d5",
    "text_color": "#4f4f4f",
    "secondary_text_color": "#8f8f8f",
    "background_color": "#f9f9f9",
    "border_color": "#e0e0e0",
    "box_color": "#ffffff"
  },
  "terms_text": "Dengan terhubung, Anda menyetujui persyaratan layanan kami...",
  "sites": [
    {
      "id": "a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6",
      "subnets": [
        "192.168.88.0/24"
      ]
    }
  ]
}'
{
  "id": "9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "auth_integration_id": "c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
  "strategy": "oauth2",
  "name": "WiFi Tamu Kantor Utama",
  "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": "Dengan terhubung, Anda menyetujui persyaratan layanan kami...",
  "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

Autentikasi Kunci API. Sediakan token Anda di header 'Authorization'. Contoh: Authorization: Bearer <TOKEN_ANDA>

Path Parameters

โ€‹
instanceId
string<uuid>
required

Pengidentifikasi unik untuk instance captive portal.

Example:

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

Body

application/json
โ€‹
name
string
required

Nama yang mudah dibaca untuk instance.

Example:

"WiFi Tamu Kantor Utama"

โ€‹
strategy
enum<string>
required

Metode autentikasi untuk captive portal ini.

Opsi yang tersedia:
oauth2,
coupon
Example:

"oauth2"

โ€‹
session_ttl
integer
required

Durasi dalam detik sesi pengguna tetap aktif setelah autentikasi. Minimum 1200, maksimum 604800.

Example:

43200

โ€‹
auth_integration_id
string<uuid> | null

Diperlukan jika strategi adalah 'oauth2'. ID dari integrasi autentikasi yang telah dikonfigurasi sebelumnya.

Example:

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

โ€‹
auth_window_ttl
integer

Untuk strategi OAuth2, durasi dalam detik untuk membuka walled garden untuk autentikasi. Minimum 120, maksimum 900.

Example:

300

โ€‹
theme
object

Kumpulan pengaturan branding dan penampilan.

โ€‹
terms_text
string | null

Teks syarat dan ketentuan.

Example:

"Dengan terhubung, Anda menyetujui persyaratan layanan kami..."

โ€‹
sites
object[]

Array situs dan subnet terkaitnya di mana instance ini aktif.

Response

Instance captive portal berhasil diperbarui.

โ€‹
id
string<uuid>

Pengidentifikasi unik untuk instance.

Example:

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

โ€‹
auth_integration_id
string<uuid> | null

ID integrasi autentikasi yang digunakan jika strateginya adalah 'oauth2'. Null untuk strategi 'coupon'.

Example:

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

โ€‹
strategy
enum<string>

Metode autentikasi untuk captive portal ini.

Opsi yang tersedia:
oauth2,
coupon
Example:

"oauth2"

โ€‹
name
string

Nama yang mudah dibaca untuk instance.

Example:

"WiFi Tamu Kantor Utama"

โ€‹
session_ttl
integer

Durasi dalam detik sesi pengguna tetap aktif setelah autentikasi berhasil.

Example:

43200

โ€‹
auth_window_ttl
integer

Untuk strategi OAuth2, durasi dalam detik walled garden dibuka sementara untuk memungkinkan pengguna menyelesaikan autentikasi dengan penyedia identitas.

Example:

300

โ€‹
theme
object

Kumpulan pengaturan branding dan penampilan.

โ€‹
terms_text
string | null

Teks syarat dan ketentuan yang dapat ditampilkan kepada pengguna.

Example:

"Dengan terhubung, Anda menyetujui persyaratan layanan kami..."

โ€‹
sites
object[]

Daftar situs dan subnetnya di mana instance captive portal ini aktif.

โ€‹
created_at
string<date-time>

Stempel waktu saat instance dibuat.

Example:

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

โ€‹
preview_url
string<uri> | null

URL sementara yang ditandatangani untuk melihat pratinjau penampilan captive portal.

Example:

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