FaithServer Developer API

Kelola server dan katalog produk lewat satu API.

FaithServer Gateway API menyediakan interface untuk mengelola layanan aktif dan mengambil katalog produk secara programatis. Dokumentasi ini dipisahkan berdasarkan jenis produk agar endpoint yang digunakan lebih jelas.

Premium VPS Multi-region Budget VPS Flexible Dedicated Server Product Catalog API Keys via Client Area
Download API Documentation
Base URL
https://api.faithserver.com/api/v1
Authorization
Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx
Document Version 2026.06.25 Reference Type Client API Reference
API key dapat dibuat melalui FaithServer Client Area pada menu API Keys. Full API key hanya ditampilkan sekali saat generate, jadi simpan key dengan aman.
API key hanya dapat mengakses service aktif yang terdaftar pada akun tersebut. Layanan suspended, terminated, cancelled, inactive, atau belum aktif tidak dapat dikontrol melalui API.
Getting Started

Ringkasan

FaithServer Gateway API menyediakan satu interface untuk mengelola layanan FaithServer secara programatis. Ketersediaan action mengikuti field allowed_actions pada setiap service.

Premium VPS Multi-region Gunakan bagian ini jika server Anda adalah VPS Premium/Multi-region. Fitur utama: status, start, stop, reboot, console, rescue, reinstall Linux/Windows, credentials, dan traffic.
Budget VPS Gunakan bagian ini jika server Anda adalah VPS Budget. Fitur utama: power actions, VNC console, rescue jika tersedia, reinstall via OS ID, reset password, IP, monitor, traffic, dan tasks.
Flexible Dedicated Server Gunakan bagian ini jika layanan Anda adalah dedicated server flexible. Fitur utama: status, overview, hardware reboot, Wake On LAN, images, dan Linux/Windows reinstall.
Product Catalog Gunakan bagian Product Catalog API untuk mengambil stok, spesifikasi, lokasi, harga, dan billing policy dedicated global.
Untuk melihat server yang dapat diakses oleh API key, gunakan endpoint GET /servers. Field id pada response adalah Service ID publik untuk endpoint lain.
Getting Started

Quick Start

Alur penggunaan API secara sederhana:

1
Generate API Key Buat API key dari Client Area pada menu API Keys.
2
List Server Jalankan GET /servers untuk melihat service aktif.
3
Ambil Service ID Gunakan field id dari response sebagai {service_id}.
4
Jalankan Action Gunakan endpoint sesuai produk, misalnya reboot, reinstall, traffic, atau console.

Contoh request pertama

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers
Getting Started

Autentikasi

Setiap request wajib menyertakan API key sebagai Bearer token pada header Authorization.

Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx

Contoh cURL

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers
API key tidak dapat dikirim melalui URL query, form body, atau parameter api_key. Gunakan header Authorization.
Full API key hanya ditampilkan sekali saat dibuat. Jika key hilang atau terindikasi bocor, revoke API key lama dan generate API key baru dari Client Area.
Getting Started

API Keys di Client Area

API key dapat dibuat dan dikelola langsung melalui FaithServer Client Area pada menu API Keys.

Fitur Keterangan
Generate API Key Membuat API key baru untuk mengakses FaithServer Gateway API.
Whitelist IP Membatasi API key agar hanya dapat digunakan dari IP address tertentu. Jika dikosongkan, API key dapat digunakan dari semua IP.
Edit API Key Mengubah nama API key dan daftar whitelist IP.
Revoke API Key Menonaktifkan API key agar tidak dapat digunakan lagi.
Service API Access Menampilkan service aktif yang tersync dari Client Area ke Gateway API.
Jika whitelist IP diaktifkan, request hanya akan diterima dari IP address yang sudah terdaftar pada API key tersebut.
Endpoint Umum

Servers

Endpoint ini berlaku untuk semua produk yang sudah aktif dan tersync ke Gateway API.

List Servers

GET /servers

Menampilkan semua server aktif yang terhubung dengan API key Anda.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers
{
  "success": true,
  "data": [
    {
      "id": "fsrv_111",
      "name": "VPS AMD 1",
      "region": "SG",
      "product": "Premium VPS Multi-region",
      "status": "active",
      "allowed_actions": [
        "status",
        "start",
        "stop",
        "reboot",
        "reinstall",
        "reset-password",
        "console",
        "rescue-status",
        "rescue-enable",
        "rescue-disable"
      ]
    },
    {
      "id": "fsrv_158",
      "name": "VPS-B1",
      "region": "US",
      "product": "Budget VPS",
      "status": "active",
      "allowed_actions": [
        "status",
        "start",
        "stop",
        "reboot",
        "reinstall",
        "reset-password",
        "console",
        "rescue-status",
        "rescue-enable",
        "rescue-disable"
      ]
    }
  ]
}
Nilai id pada response adalah Service ID publik yang digunakan untuk endpoint lain. Contoh: /servers/fsrv_111/reboot.

Get Server Detail

GET /servers/{service_id}

Menampilkan detail singkat server berdasarkan Service ID publik.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111

Get Server Status

GET /servers/{service_id}/status

Mengecek status server langsung dari sistem layanan.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/status

Get Server Overview

GET /servers/{service_id}/overview

Menampilkan ringkasan server, termasuk status, region, IP address, paket, dan capability yang tersedia.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/overview
Format detail response dapat berbeda tergantung jenis produk. Gunakan field utama seperti success, server_id, action, provider_status_code, dan data sebagai acuan umum.
Endpoint Umum

Logs & Jobs

Action Logs per Server

GET /servers/{service_id}/actions

Menampilkan action logs per server.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/actions

All API Logs

GET /logs

Menampilkan semua API logs.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/logs

List Jobs

GET /jobs

Menampilkan daftar jobs.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/jobs

Job Detail

GET /jobs/{job_id}

Menampilkan detail job tertentu.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/jobs/10
Field sensitif seperti password, token, secret, API key, session, dan cookie dapat disamarkan pada log API/job.
Product Catalog API

Product Catalog API

Endpoint catalog digunakan untuk mengambil daftar varian produk yang tersedia untuk website, panel, atau integrasi eksternal.

Endpoint Produk Keterangan
GET /product/variants/premiumvps Premium VPS Multi-region Varian VPS premium per region dan location.
GET /dedicated/variants Flexible Dedicated Server Varian dedicated server flexible dari dynamic auction catalog.
GET /dedicated/leaseweb/variants Global Dedicated Server Varian dedicated server global dari catalog dedicated global.
Field catalog dapat berubah mengikuti kebutuhan internal API. Untuk harga jual, gunakan field pricing.*_idr atau pricing.*_display jika tersedia.
Product Catalog API

Premium VPS Multi-region Catalog

GET /product/variants/premiumvps

Menampilkan varian Premium VPS Multi-region yang tersedia.

Parameter Keterangan
region Opsional. Filter berdasarkan region, contoh SG, JP, UK, NL.
location Opsional. Filter berdasarkan location code, contoh SIN-11 atau AMS-01.
refresh Opsional. Gunakan refresh=1 untuk mengambil data terbaru dari cache/API gateway.

Contoh request

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
"https://api.faithserver.com/api/v1/product/variants/premiumvps?region=SG"

Contoh response

{
  "success": true,
  "product": "premiumvps",
  "provider": "premium_vps_multi_region",
  "meta": {
    "count": 6,
    "regions": ["SG"],
    "locations": ["SIN-11"]
  },
  "data": [
    {
      "id": "premium-sin-11-vps02-1",
      "product": "premiumvps",
      "region": "SG",
      "location": "SIN-11",
      "plan_code": "VPS-1",
      "cpu_cores": 4,
      "ram_gb": 6,
      "disk_gb": 100,
      "bandwidth_tb": 30,
      "pricing": {
        "monthly_idr": 210000,
        "monthly_label": "210k/bulan"
      },
      "available": true
    }
  ]
}
Product Catalog API

Flexible Dedicated Server Catalog

GET /dedicated/variants

Menampilkan varian Flexible Dedicated Server dari dynamic auction catalog.

Parameter Keterangan
min_ram Opsional. Minimum RAM dalam GB. Default 64.
disk_type Opsional. Filter storage, contoh NVMe, SSD, HDD.
q Opsional. Search CPU/storage/description. Contoh i9 atau Ryzen.

Contoh request

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
"https://api.faithserver.com/api/v1/dedicated/variants?min_ram=64&disk_type=NVMe"

Contoh response

{
  "success": true,
  "data": [
    {
      "code": "intel-core-i9-13900-128gb-2x1tb-nvme",
      "name": "Intel Core i9-13900 128GB 2x1 TB NVMe",
      "available": true,
      "available_count": 1,
      "spec": {
        "cpu": "Intel Core i9-13900",
        "memory_gb": 128,
        "storage": "2x1 TB NVMe",
        "network_speed": "1 Gbit/s",
        "datacenter_display": "Germany / Finland"
      },
      "pricing": {
        "monthly_idr": 2100000,
        "weekly_idr": 570000,
        "monthly_display": "Rp 2.100.000/bulan",
        "weekly_display": "Rp 570.000/minggu"
      }
    }
  ],
  "meta": {
    "source": "flexible_dedicated_dynamic",
    "count": 1
  }
}
Product Catalog API

Global Dedicated Server Catalog

GET /dedicated/leaseweb/variants

Menampilkan varian Global Dedicated Server.

Parameter Keterangan
min_ram Opsional. Minimum RAM dalam GB. Contoh 32, 64, 128.
location Opsional. Filter lokasi/datacenter, contoh FRA-01 atau AMS-01.
account Opsional. Filter account/region catalog, contoh de, nl, sg.
limit Opsional. Batas data response. Contoh 20.
offset Opsional. Offset pagination. Contoh 0 atau 20.

Contoh request

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
"https://api.faithserver.com/api/v1/dedicated/leaseweb/variants?min_ram=32&limit=20"

Contoh response

{
  "success": true,
  "data": [
    {
      "provider": "global_dedicated_server",
      "code": "de-dell-r730xd-128gb-fra-01",
      "account": "de",
      "name": "Dell R730XD (12xLFF) 2x Intel Xeon E5-2620v4",
      "available": true,
      "available_count": 1,
      "spec": {
        "cpu": "Dual Intel Xeon E5-2620v4 (16 cores)",
        "memory_gb": 128,
        "storage": "4xSATA 2 TB",
        "location": "FRA-01",
        "datacenter_display": "Germany FRA-01",
        "delivery": "5 days",
        "network": "1 x GE port UTP"
      },
      "pricing": {
        "currency": "EUR",
        "monthly_idr": 3230000,
        "setup_fee_idr": 0,
        "initial_due_idr": 4200000,
        "monthly_display": "Rp 3.230.000/bulan"
      },
      "billing_policy": {
        "cutoff_day": 25
      }
    }
  ],
  "meta": {
    "source": "global_dedicated_catalog",
    "count": 1
  }
}
Premium VPS Multi-region

Overview Premium VPS Multi-region

Bagian ini digunakan untuk layanan Premium VPS Multi-region. Fitur umum: status, overview, start, stop, reboot, VNC console, rescue mode, reinstall, reset password, credentials, dan traffic usage.

Selalu cek allowed_actions dari endpoint GET /servers sebelum menjalankan action. Jika action tidak muncul di allowed_actions, action tersebut tidak tersedia untuk server tersebut.
Premium VPS Multi-region

Power Actions

Start Server

POST /servers/{service_id}/start

Menyalakan server.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/start

Stop Server

POST /servers/{service_id}/stop

Mematikan server.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/stop

Reboot Server

POST /servers/{service_id}/reboot

Melakukan reboot server.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/reboot
{
  "success": true,
  "message": "Reboot command accepted.",
  "server_id": "fsrv_111",
  "action": "reboot",
  "provider": "premium_vps_multi_region",
  "job_id": null,
  "provider_status_code": 202,
  "provider_response": []
}
Premium VPS Multi-region

VNC Console

GET /servers/{service_id}/console

Membuat URL VNC console sementara untuk mengakses tampilan server melalui browser.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/console
{
  "success": true,
  "message": "Console request processed.",
  "server_id": "fsrv_111",
  "action": "console",
  "provider": "premium_vps_multi_region",
  "provider_status_code": 200,
  "provider_response": {
    "url": "https://console.example/vnc.html?token=temporary_token",
    "expires_in": 600,
    "note": "Open this URL in browser to access console."
  }
}
URL console berisi token akses sementara dan bersifat sensitif. Jangan membagikan URL console secara publik, pada screenshot, chat umum, repository, atau log aplikasi.
Premium VPS Multi-region

Rescue Mode

Rescue Mode memungkinkan server boot ke environment rescue untuk troubleshooting, recovery, atau perbaikan sistem.

Rescue Status

GET /servers/{service_id}/rescue/status

Mengecek status rescue mode.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/status

Enable Rescue Mode

POST /servers/{service_id}/rescue/enable

Mengaktifkan rescue mode.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/enable

Disable Rescue Mode

POST /servers/{service_id}/rescue/disable

Menonaktifkan rescue mode.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/disable
Setelah rescue mode diaktifkan atau dinonaktifkan, server perlu direboot agar perubahan mode boot diterapkan.
Premium VPS Multi-region

Reinstall Premium VPS

List Images

GET /servers/{service_id}/images

Menampilkan image Linux dan Windows yang tersedia untuk reinstall.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/images
{
  "success": true,
  "server_id": "fsrv_111",
  "provider": "premium_vps_multi_region",
  "data": {
    "images": [
      {
        "id": "UBUNTU_24_04_64BIT",
        "name": "Ubuntu 24.04 LTS (x86_64)",
        "family": "linux"
      },
      {
        "id": "windows-server-2019",
        "name": "Windows Server 2019 (x86_64)",
        "family": "windows"
      },
      {
        "id": "windows-server-2022",
        "name": "Windows Server 2022 (x86_64)",
        "family": "windows"
      },
      {
        "id": "windows-server-2025",
        "name": "Windows Server 2025 (x86_64)",
        "family": "windows"
      },
      {
        "id": "windows-10-ltsc",
        "name": "Windows 10 Enterprise LTSC 2021 (x86_64)",
        "family": "windows"
      },
      {
        "id": "windows-11-ltsc",
        "name": "Windows 11 Enterprise LTSC 2024 (x86_64)",
        "family": "windows"
      }
    ]
  }
}

Reinstall Server

POST /servers/{service_id}/reinstall

Linux menggunakan imageId. Windows menggunakan image atau imageId. Field password opsional untuk Windows; jika dikosongkan, password Administrator digenerate otomatis dan dikembalikan pada response.

Contoh request Linux

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"imageId":"UBUNTU_24_04_64BIT"}' \
https://api.faithserver.com/api/v1/servers/fsrv_111/reinstall

Contoh request Windows

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"image":"windows-server-2019","password":"StrongPassword123!"}' \
https://api.faithserver.com/api/v1/servers/fsrv_111/reinstall

Contoh response Windows reinstall

{
  "success": true,
  "message": "Reinstall command accepted.",
  "server_id": "fsrv_111",
  "action": "reinstall",
  "provider": "premium_vps_multi_region",
  "job_id": 6,
  "provider_status_code": 202,
  "provider_response": {
    "status": "queued",
    "image": "windows-server-2019",
    "username": "Administrator",
    "password": "StrongPassword123!"
  }
}

Cek status job

GET /jobs/{job_id} 
{
  "success": true,
  "data": {
    "id": 6,
    "service_id": "fsrv_111",
    "action": "reinstall",
    "status": "running",
    "message": "Windows installer started. Waiting for Windows installation to complete.",
    "provider_response": {
      "job": {
        "status": "running",
        "rdp_reachable": false
      }
    }
  }
}
Reinstall akan menghapus data di server. Simpan password dan pastikan data sudah di-backup sebelum menjalankan action ini.
Premium VPS Multi-region

Password & Credentials

Reset Password

POST /servers/{service_id}/reset-password 
curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/reset-password

List Credentials

GET /servers/{service_id}/credentials

Menampilkan credential yang tersedia.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/credentials

Get Credential Detail

GET /servers/{service_id}/credentials/{type}/{username}

Menampilkan credential detail.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_111/credentials/OPERATING_SYSTEM/root
{
  "success": true,
  "server_id": "fsrv_111",
  "product": "Premium VPS Multi-region",
  "data": {
    "type": "OPERATING_SYSTEM",
    "username": "root",
    "password": "GeneratedPasswordHere"
  }
}
Credentials dan generated password bersifat sensitif. Jangan simpan di repository publik, log aplikasi, atau membagikannya melalui channel yang tidak aman.
Premium VPS Multi-region

Traffic Usage

GET /servers/{service_id}/traffic

Menampilkan penggunaan traffic/bandwidth.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
"https://api.faithserver.com/api/v1/servers/fsrv_111/traffic?period=month"
curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
"https://api.faithserver.com/api/v1/servers/fsrv_111/traffic?from=2026-05-01&to=2026-05-28&granularity=DAY"
Budget VPS

Overview Budget VPS

Bagian ini digunakan untuk layanan Budget VPS. Fitur umum: status, start, stop, reboot, VNC console, rescue jika tersedia, reinstall via OS ID, custom password reset, OS templates, traffic usage, IP list, monitor, dan task history.

Gunakan field allowed_actions pada response GET /servers sebagai acuan utama. Fitur dapat berbeda tergantung status layanan dan konfigurasi sistem layanan.
Budget VPS

Power Actions

Start Server

POST /servers/{service_id}/start

Menyalakan server.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/start

Stop Server

POST /servers/{service_id}/stop

Mematikan server.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/stop

Reboot Server

POST /servers/{service_id}/reboot

Melakukan reboot server.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/reboot
{
  "success": true,
  "message": "Reboot command accepted.",
  "server_id": "fsrv_158",
  "action": "reboot",
  "provider": "budget_vps",
  "job_id": null,
  "provider_status_code": 200,
  "provider_response": {
    "status": 1,
    "message": "The VPS was restarted successfully",
    "output": "Starting the VM...\nThe VM has been successfully started.",
    "time_taken": "36.78"
  }
}
Action reboot Budget VPS dapat membutuhkan waktu lebih lama karena proses dari sistem layanan. Gateway akan menunggu response lebih lama.
Budget VPS

VNC Console

GET /servers/{service_id}/console

Membuat URL VNC console sementara untuk Budget VPS.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/console
{
  "success": true,
  "message": "Console request processed.",
  "server_id": "fsrv_158",
  "action": "console",
  "provider": "budget_vps",
  "provider_status_code": 200,
  "provider_response": {
    "url": "https://console.faithserver.com/vnc.html?autoconnect=true&path=websockify%3Ftoken%3Dtemporary_token",
    "expires_in": 600,
    "note": "Open this URL in browser to access console."
  }
}
URL console berisi token akses sementara dan bersifat sensitif. Jangan membagikan URL console secara publik.
Budget VPS

Rescue Mode

Rescue Mode tersedia untuk Budget VPS jika action rescue muncul pada allowed_actions.

Rescue Status

GET /servers/{service_id}/rescue/status

Mengecek status rescue mode.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/rescue/status

Enable Rescue Mode

POST /servers/{service_id}/rescue/enable

Mengaktifkan rescue mode jika tersedia.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/rescue/enable

Disable Rescue Mode

POST /servers/{service_id}/rescue/disable

Menonaktifkan rescue mode jika tersedia.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/rescue/disable
Setelah rescue mode diaktifkan atau dinonaktifkan, server perlu direboot agar perubahan mode boot diterapkan.
Budget VPS

OS Templates / OS ID

Khusus Budget VPS, reinstall menggunakan field osid. Nilai osid adalah ID angka dari OS template yang dikembalikan oleh endpoint GET /servers/{service_id}/images.

GET /servers/{service_id}/images 
curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/images
{
  "success": true,
  "server_id": "fsrv_158",
  "provider": "budget_vps",
  "provider_status_code": 200,
  "data": {
    "images": [
      {
        "id": "1109",
        "name": "ubuntu-24.04-x86_64",
        "family": "Ubuntu"
      },
      {
        "id": "1056",
        "name": "debian-12-x86_64",
        "family": "Debian"
      },
      {
        "id": "100001",
        "name": "windows-2022",
        "family": "Windows"
      }
    ]
  }
}
Field Arti Dipakai untuk reinstall?
id ID/template number OS dari Budget VPS. Ya, kirim sebagai osid.
name Nama OS agar mudah dibaca manusia. Tidak, hanya untuk referensi.
family Kategori OS seperti Ubuntu, Debian, AlmaLinux, Windows, atau CentOS. Tidak, hanya untuk grouping/tampilan.
ID OS dapat berubah mengikuti template yang tersedia di backend Budget VPS. Selalu ambil daftar terbaru melalui endpoint /images sebelum menjalankan reinstall.
Budget VPS

Reinstall Budget VPS

Budget VPS menggunakan osid, bukan imageId. Nilai osid diambil dari field id pada endpoint /images.

POST /servers/{service_id}/reinstall

Contoh reinstall Ubuntu 24.04

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"osid":"1109","password":"PasswordKuat123!"}' \
https://api.faithserver.com/api/v1/servers/fsrv_158/reinstall

Contoh reinstall Windows Server 2022

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"osid":"100001","password":"PasswordKuat123!"}' \
https://api.faithserver.com/api/v1/servers/fsrv_158/reinstall
OS Contoh ID Payload reinstall
Ubuntu 24.04 1109 {"osid":"1109","password":"PasswordKuat123!"}
Ubuntu 22.04 1024 {"osid":"1024","password":"PasswordKuat123!"}
Debian 12 1056 {"osid":"1056","password":"PasswordKuat123!"}
Windows Server 2022 100001 {"osid":"100001","password":"PasswordKuat123!"}
Reinstall akan menghapus data di server. Pastikan data sudah di-backup sebelum menjalankan action ini. FaithServer tidak menyimpan backup otomatis untuk data pengguna.
Budget VPS

Reset Password

Budget VPS dapat menggunakan custom password jika produk atau sistem layanan mendukung fitur tersebut.

POST /servers/{service_id}/reset-password 
curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"password":"PasswordKuat123!"}' \
https://api.faithserver.com/api/v1/servers/fsrv_158/reset-password
Gunakan password kuat dan simpan dengan aman.
Budget VPS

IP & Monitor

List IP Addresses

GET /servers/{service_id}/ips

Menampilkan daftar IP address yang terpasang pada server.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/ips

Server Monitor

GET /servers/{service_id}/monitor

Menampilkan data monitoring dasar yang tersedia dari sistem layanan.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/monitor
Format response /ips dan /monitor dapat berbeda antar produk. Gunakan field success, server_id, provider_status_code, dan data sebagai acuan utama.
Budget VPS

Traffic Usage

GET /servers/{service_id}/traffic

Menampilkan penggunaan traffic/bandwidth Budget VPS.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/traffic
curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
"https://api.faithserver.com/api/v1/servers/fsrv_158/traffic?month=202605"
{
  "success": true,
  "server_id": "fsrv_158",
  "provider": "budget_vps",
  "provider_status_code": 200,
  "data": {
    "month": "202605",
    "used": "65.45 GB",
    "limit": "9.77 TB",
    "percent": 0.65,
    "percent_text": "0.65%",
    "labels": ["30 Apr", "01 May", "02 May"],
    "in": [0, 0, 7600.32],
    "out": [0, 0, 250.66],
    "total": [0, 0, 7850.98],
    "has_graph": true
  }
}
Budget VPS

Server Tasks

GET /servers/{service_id}/tasks

Menampilkan task/action terbaru dari server jika produk mendukungnya. Untuk Budget VPS, task history difilter agar hanya menampilkan task terbaru yang relevan.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_158/tasks
Task lama dapat otomatis disembunyikan dari response agar output tetap ringkas dan tidak menampilkan detail internal yang tidak diperlukan.
Flexible Dedicated Server

Overview Flexible Dedicated Server

Bagian ini digunakan untuk layanan Flexible Dedicated Server. Fitur utama: status, overview, hardware reboot, Wake On LAN, images, dan reinstall Linux/Windows.

Dedicated server tidak memiliki fitur start/stop seperti VPS. Untuk power action yang tersedia, gunakan reboot atau wol jika muncul pada allowed_actions.
Flexible Dedicated Server

Dedicated Server Actions

Get Status

GET /servers/{service_id}/status

Mengecek status dedicated server.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_220/status

Get Overview

GET /servers/{service_id}/overview

Menampilkan ringkasan dedicated server.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_220/overview

Reboot Server

POST /servers/{service_id}/reboot

Melakukan hardware reboot.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_220/reboot

Wake On LAN

POST /servers/{service_id}/wol

Menjalankan Wake On LAN jika tersedia.

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_220/wol
Action seperti reboot dan wol dapat memengaruhi operasional server. Gunakan hanya jika Anda memahami dampaknya.
Flexible Dedicated Server

Images & Reinstall Dedicated Server

List Images

GET /servers/{service_id}/images

Menampilkan daftar image reinstall Linux/Windows.

curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
https://api.faithserver.com/api/v1/servers/fsrv_220/images
{
  "success": true,
  "server_id": "fsrv_220",
  "provider": "flexible_dedicated_server",
  "data": {
    "images": [
      {
        "id": "debian-12",
        "name": "Debian 12 base",
        "family": "linux",
        "requires_password": false
      },
      {
        "id": "windows-server-2019",
        "name": "Windows Server 2019",
        "family": "windows",
        "requires_password": true
      }
    ]
  }
}

Reinstall Server

POST /servers/{service_id}/reinstall

Menjalankan reinstall Linux atau Windows sesuai image.

Contoh request Linux

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"image":"debian-12"}' \
https://api.faithserver.com/api/v1/servers/fsrv_220/reinstall

Contoh request Windows

curl -X POST \
-H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"image":"windows-server-2019","password":"StrongPassword123!","hostname":"FS-TEST"}' \
https://api.faithserver.com/api/v1/servers/fsrv_220/reinstall
Field Keterangan
image Wajib. Gunakan id dari endpoint /images.
password Untuk Windows. Digunakan sebagai password Administrator.
hostname Opsional untuk Windows.
Reinstall akan menghapus data di server. Untuk Windows, proses masuk ke job queue dan status dapat dicek melalui /jobs.
Reference

Matrix Fitur Produk

Fitur Premium VPS Multi-region Budget VPS Flexible Dedicated Server
List servers Ya Ya Ya
Status Ya Ya Ya
Overview Ya Ya Ya
Start Ya Ya Tidak
Stop Ya Ya Tidak
Reboot Ya Ya Ya
VNC Console Ya Ya Tidak
Rescue Mode Ya Ya, jika tersedia Tidak
Wake On LAN Tidak Tidak Ya
Images / OS Templates Ya Ya Ya
Reinstall Linux / Windows via image Windows / Linux via osid Linux / Windows via image
Reset Password Ya, jika didukung layanan Custom password jika didukung layanan Tidak
Credentials Ya Terbatas Tidak
Traffic Ya Ya Tidak
IP List Ya Ya Terbatas via overview
Monitor Ya Ya Tidak
Server Tasks Ya Ya Tidak
Action Logs Ya Ya Ya
Jobs Ya Ya Ya
Ketersediaan fitur dapat berbeda tergantung jenis produk, region, status layanan, dan konfigurasi server. Selalu gunakan field allowed_actions dari response GET /servers sebagai acuan sebelum menjalankan action.
Reference

Error Responses

Missing API Key

Terjadi jika header Authorization tidak dikirim, format Bearer salah, atau API key dikirim melalui query/body.

{
  "success": false,
  "message": "Missing API key."
}

Invalid API Key

API key tidak valid atau sudah dinonaktifkan.

{
  "success": false,
  "message": "Invalid API key."
}

IP Not Allowed

API key menggunakan whitelist IP dan request datang dari IP yang tidak terdaftar.

{
  "success": false,
  "message": "IP address is not whitelisted for this API key."
}

Server Not Found

Service ID salah, server bukan milik akun Anda, atau layanan tidak aktif/belum tersync.

{
  "success": false,
  "message": "Server not found."
}

Action Not Allowed

Action tidak tersedia untuk produk tersebut, service tidak aktif, atau action tidak masuk allowed_actions.

{
  "success": false,
  "message": "Action not allowed for this server."
}

Feature Unavailable

Sistem layanan tidak menyediakan fitur yang diminta pada saat request diproses.

{
  "success": false,
  "message": "Service API request failed.",
  "provider_response": {
    "message": "Console is currently unavailable for this server."
  }
}
Reference

Catatan Keamanan

  • API key hanya berlaku untuk akun Anda dan tidak dapat mengakses layanan yang tidak terdaftar pada akun tersebut.
  • Jika whitelist IP diaktifkan, request hanya akan diterima dari IP address yang sudah didaftarkan.
  • API key wajib dikirim melalui header Authorization. Jangan mengirim API key melalui URL query atau body request.
  • Service ID yang digunakan pada public API adalah Service ID publik dari Gateway. Jangan menggunakan ID internal layanan, ID invoice, IP address, atau ID dari panel pihak ketiga.
  • Public API menggunakan nama produk FaithServer seperti Premium VPS Multi-region, Budget VPS, dan Flexible Dedicated Server.
  • Action reinstall akan menghapus data server. Layanan FaithServer bersifat unmanaged, sehingga backup data menjadi tanggung jawab pengguna.
  • Jangan membagikan API key, credentials, generated password, atau VNC console URL secara publik. Jika API key terindikasi bocor, segera revoke dan generate API key baru.
API key dapat digenerate melalui FaithServer Client Area pada menu API Keys. Pastikan layanan dalam status aktif sebelum menggunakan API.

Butuh referensi offline?

Download versi PDF untuk dibagikan ke developer, tim internal, atau client yang membutuhkan dokumentasi API.

Download API Documentation