Production Developer API

Bangun integrasi dengan FaithServer API

Gunakan API untuk mengakses layanan aktif, menjalankan action yang tersedia, serta mengambil katalog produk sesuai kebutuhan integrasi Anda.

EnvironmentProduction
Base URLhttps://api.faithserver.com/api/v1
AuthenticationBearer token
Document version2026.06.25

API key hanya dapat mengakses service aktif yang terdaftar pada akun pemilik key.

Quick Start

Mulai integrasi pertama Anda

Empat langkah ini membawa Anda dari pembuatan key hingga action pertama tanpa menggunakan ID internal layanan.

  1. 1
    Generate API Key

    Buka Client Area, masuk ke menu API Keys, lalu buat key baru.

  2. 2
    List Server

    Jalankan GET /servers untuk melihat service aktif.

  3. 3
    Ambil Service ID

    Gunakan field id sebagai Public Service ID.

  4. 4
    Jalankan Action

    Pilih endpoint sesuai produk dan field allowed_actions.

API KeyGET /serversService IDAllowed ActionJob / Response
Request pertama
curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
+  https://api.faithserver.com/api/v1/servers

Authentication

Kirim API key melalui header

Setiap request wajib memakai Bearer token pada header Authorization. Jangan kirim key melalui query string, form body, atau parameter api_key.

Base URLhttps://api.faithserver.com/api/v1
HeaderAuthorization: Bearer <API_KEY>
cURL
curl -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
+  https://api.faithserver.com/api/v1/servers
JavaScript fetch
const response = await fetch("https://api.faithserver.com/api/v1/servers", {
  headers: {
    Authorization: "Bearer fs_live_xxxxxxxxxxxxxxxxx"
  }
});

const data = await response.json();
PHP cURL
$curl = curl_init("https://api.faithserver.com/api/v1/servers");
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx"
    ],
]);
$response = curl_exec($curl);
curl_close($curl);

API Key management

Kelola akses dari Client Area

Full API key hanya ditampilkan sekali. Simpan dengan aman dan revoke segera bila key hilang atau bocor.

Generate API Key

Membuat key baru untuk Gateway API.

Whitelist IP

Batasi penggunaan key ke IP address tertentu. Jika kosong, key dapat digunakan dari semua IP.

Edit API Key

Ubah nama key dan daftar whitelist IP.

Revoke API Key

Nonaktifkan key agar tidak dapat digunakan lagi.

Service API Access

Lihat service aktif yang tersync dari Client Area.

Fundamental concepts

Konsep yang perlu dipahami

Public Service ID

Field id dari GET /servers. Jangan gunakan ID invoice, IP address, atau ID panel pihak ketiga.

Active services

API key hanya menjangkau service aktif pada akun yang sama.

allowed_actions

Daftar action yang benar-benar tersedia untuk service tersebut.

Jobs & logs

Jobs membantu memantau proses; logs mencatat action dan dapat menyamarkan field sensitif.

Temporary console URL

URL console memuat token sementara dan harus dijaga seperti credential.

Product capabilities

Fitur berbeda menurut produk, region, status, dan konfigurasi server.

Destructive actions

Reinstall menghapus data. Pastikan backup tersedia sebelum menjalankannya.

Product selector

Pilih produk yang ingin diintegrasikan

Gunakan navigasi berikut untuk menuju capability dan endpoint yang sesuai.

Endpoint documentation

Endpoint Umum

Gunakan bagian ini untuk menemukan service aktif, membaca status, serta memantau logs dan jobs.

  • Service aktif
  • Public Service ID
  • Allowed actions
  • Logs & jobs
GET/serversMenampilkan semua server aktif yang terhubung dengan API key.
Product scopeSemua service aktif

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers
Example response
{
  "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", "console"]
    }
  ]
}
GET/servers/{service_id}Menampilkan detail singkat server berdasarkan Public Service ID.
Product scopeSemua service aktif

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111
GET/servers/{service_id}/statusMengecek status server langsung dari sistem layanan.
Product scopeProduk yang mendukung statusAction / permissionstatus

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/status
GET/servers/{service_id}/overviewMenampilkan ringkasan server, region, IP address, paket, dan capability.
Product scopeProduk yang mendukung overviewAction / permissionoverview

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/overview
GET/servers/{service_id}/actionsMenampilkan action logs per server.
Product scopeSemua service aktif

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/actions
GET/logsMenampilkan semua API logs.
Product scopeAkun pemilik API key

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/logs
GET/jobsMenampilkan daftar jobs.
Product scopeAkun pemilik API key

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/jobs
GET/jobs/{job_id}Menampilkan detail job tertentu.
Product scopeAkun pemilik API key

Path parameters

job_idRequired
ID job yang dikembalikan oleh action terkait.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/jobs/6
Example response
{
  "success": true,
  "data": {
    "id": 6,
    "service_id": "fsrv_111",
    "action": "reinstall",
    "status": "running",
    "message": "Windows installer started. Waiting for Windows installation to complete."
  }
}

Endpoint documentation

Product Catalog API

Ambil varian produk untuk website, panel, atau integrasi eksternal tanpa mengubah data katalog.

  • Premium VPS
  • Flexible Dedicated
  • Global Dedicated
  • Filter katalog
GET/product/variants/premiumvpsMenampilkan varian Premium VPS Multi-region yang tersedia.
Product scopePremium VPS Multi-region catalog

Query parameters

region
Opsional. Region seperti SG, JP, UK, atau NL.
location
Opsional. Location code seperti SIN-11 atau AMS-01.
refresh
Opsional. Gunakan refresh=1 untuk mengambil data terbaru dari cache/API gateway.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/product/variants/premiumvps?region=SG
Example response
{
  "success": true,
  "product": "premiumvps",
  "meta": {"count": 6, "regions": ["SG"], "locations": ["SIN-11"]},
  "data": [{
    "id": "leaseweb-sin-11-vps02-1",
    "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
  }]
}
GET/dedicated/variantsMenampilkan varian Flexible Dedicated Server dari dynamic auction catalog.
Product scopeFlexible Dedicated Server catalog

Query parameters

min_ram
Opsional. Minimum RAM dalam GB. Default 64.
disk_type
Opsional. Storage seperti NVMe, SSD, atau HDD.
q
Opsional. Pencarian CPU, storage, atau description.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/dedicated/variants?min_ram=64&disk_type=NVMe
Example 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"
    }
  }]
}
GET/dedicated/leaseweb/variantsMenampilkan varian Global Dedicated Server.
Product scopeGlobal Dedicated Server catalog

Query parameters

min_ram
Opsional. Minimum RAM dalam GB.
location
Opsional. Location/datacenter seperti FRA-01 atau AMS-01.
account
Opsional. Account/region catalog seperti de, nl, atau sg.
limit
Opsional. Batas jumlah data response.
offset
Opsional. Offset pagination.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/dedicated/leaseweb/variants?min_ram=32&limit=20
Example response
{
  "success": true,
  "data": [{
    "provider": "leaseweb",
    "code": "de-dell-r730xd-128gb-fra-01",
    "account": "de",
    "name": "Dell R730XD (12xLFF) 2x Intel Xeon E5-2620v4",
    "available": true,
    "spec": {
      "cpu": "Dual Intel Xeon E5-2620v4 (16 cores)",
      "memory_gb": 128,
      "storage": "4xSATA 2 TB",
      "location": "FRA-01",
      "datacenter_display": "Germany FRA-01",
      "network": "1 x GE port UTP"
    },
    "pricing": {"monthly_idr": 3230000, "setup_fee_idr": 0, "initial_due_idr": 4200000, "monthly_display": "Rp 3.230.000/bulan"}
  }]
}

Endpoint documentation

Premium VPS Multi-region

Kelola power, console, rescue, reinstall, password, credentials, dan traffic sesuai allowed_actions.

  • Power actions
  • VNC console
  • Rescue mode
  • Reinstall & traffic
POST/servers/{service_id}/startMenyalakan server.
Product scopePremium VPS Multi-regionAction / permissionstart

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/start
POST/servers/{service_id}/stopMematikan server.
Product scopePremium VPS Multi-regionAction / permissionstop

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/stop
POST/servers/{service_id}/rebootMelakukan reboot server.
Product scopePremium VPS Multi-regionAction / permissionreboot

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/reboot
GET/servers/{service_id}/consoleMembuat URL VNC console sementara.
Product scopePremium VPS Multi-regionAction / permissionconsole

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/console
Example response
{
  "success": true,
  "message": "Console request processed.",
  "server_id": "fsrv_111",
  "action": "console",
  "provider_response": {
    "url": "https://console.example/vnc.html?token=temporary_token",
    "expires_in": 600
  }
}
GET/servers/{service_id}/rescue/statusMengecek status rescue mode.
Product scopePremium VPS Multi-regionAction / permissionrescue

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/status
POST/servers/{service_id}/rescue/enableMengaktifkan rescue mode.
Product scopePremium VPS Multi-regionAction / permissionrescue

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/enable
POST/servers/{service_id}/rescue/disableMenonaktifkan rescue mode.
Product scopePremium VPS Multi-regionAction / permissionrescue

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/disable
GET/servers/{service_id}/imagesMenampilkan image Linux dan Windows untuk reinstall.
Product scopePremium VPS Multi-regionAction / permissionreinstall

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/images
POST/servers/{service_id}/reinstallMenjalankan reinstall Linux atau Windows.
Product scopePremium VPS Multi-regionAction / permissionreinstall

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

imageId / imageRequired
ID image dari endpoint /images.
password
Opsional untuk Windows; jika kosong, password Administrator dibuat otomatis.
Example request
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
POST/servers/{service_id}/reset-passwordReset password jika layanan mendukung.
Product scopePremium VPS Multi-regionAction / permissionreset-password

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/reset-password
GET/servers/{service_id}/credentialsMenampilkan daftar credentials.
Product scopePremium VPS Multi-regionAction / permissioncredentials

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/credentials
GET/servers/{service_id}/credentials/{type}/{username}Menampilkan detail credential.
Product scopePremium VPS Multi-regionAction / permissioncredentials

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.
typeRequired
Tipe credential yang dikembalikan layanan.
usernameRequired
Username credential yang ingin dibaca.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/credentials/administrator/Administrator
GET/servers/{service_id}/trafficMenampilkan penggunaan traffic atau bandwidth.
Product scopePremium VPS Multi-regionAction / permissiontraffic

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Query parameters

period
Opsional. Contoh period=month.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/traffic?period=month

Endpoint documentation

Budget VPS

Gunakan osid untuk reinstall Budget VPS dan selalu ambil template terbaru dari endpoint images.

  • Power actions
  • VNC console
  • OS templates
  • IP, monitor & tasks
POST/servers/{service_id}/startMenyalakan server.
Product scopeBudget VPSAction / permissionstart

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/start
POST/servers/{service_id}/stopMematikan server.
Product scopeBudget VPSAction / permissionstop

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/stop
POST/servers/{service_id}/rebootMelakukan reboot server.
Product scopeBudget VPSAction / permissionreboot

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/reboot
GET/servers/{service_id}/consoleMembuat URL VNC console sementara.
Product scopeBudget VPSAction / permissionconsole

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/console
GET/servers/{service_id}/rescue/statusMengecek status rescue mode.
Product scopeBudget VPSAction / permissionrescue

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/status
POST/servers/{service_id}/rescue/enableMengaktifkan rescue mode jika tersedia.
Product scopeBudget VPSAction / permissionrescue

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/enable
POST/servers/{service_id}/rescue/disableMenonaktifkan rescue mode jika tersedia.
Product scopeBudget VPSAction / permissionrescue

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/rescue/disable
GET/servers/{service_id}/imagesMenampilkan OS templates dan nilai osid terbaru.
Product scopeBudget VPSAction / permissionreinstall

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/images
POST/servers/{service_id}/reinstallReinstall Budget VPS menggunakan osid.
Product scopeBudget VPSAction / permissionreinstall

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

osidRequired
ID angka dari endpoint /images.
passwordRequired
Password baru untuk template yang dipilih.
Example request
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_111/reinstall
POST/servers/{service_id}/reset-passwordMengatur custom password bila layanan mendukung.
Product scopeBudget VPSAction / permissionreset-password

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

passwordRequired
Password baru.
Example request
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_111/reset-password
GET/servers/{service_id}/ipsMenampilkan daftar IP address pada server.
Product scopeBudget VPSAction / permissionips

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/ips
GET/servers/{service_id}/monitorMenampilkan monitoring dasar yang tersedia.
Product scopeBudget VPSAction / permissionmonitor

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/monitor
GET/servers/{service_id}/trafficMenampilkan penggunaan traffic atau bandwidth.
Product scopeBudget VPSAction / permissiontraffic

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Query parameters

month
Opsional. Bulan dalam format YYYYMM, contoh 202605.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/traffic?month=202605
GET/servers/{service_id}/tasksMenampilkan task atau action terbaru jika didukung.
Product scopeBudget VPSAction / permissiontasks

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

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

Endpoint documentation

Flexible Dedicated Server

Dedicated server tidak memiliki start/stop seperti VPS. Gunakan hardware reboot atau Wake On LAN bila tersedia.

  • Status & overview
  • Hardware reboot
  • Wake On LAN
  • Linux/Windows reinstall
GET/servers/{service_id}/statusMengecek status dedicated server.
Product scopeFlexible Dedicated ServerAction / permissionstatus

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/status
GET/servers/{service_id}/overviewMenampilkan ringkasan dedicated server.
Product scopeFlexible Dedicated ServerAction / permissionoverview

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/overview
POST/servers/{service_id}/rebootMelakukan hardware reboot.
Product scopeFlexible Dedicated ServerAction / permissionreboot

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/reboot
POST/servers/{service_id}/wolMenjalankan Wake On LAN jika tersedia.
Product scopeFlexible Dedicated ServerAction / permissionwol

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl -X POST \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/wol
GET/servers/{service_id}/imagesMenampilkan image reinstall Linux atau Windows.
Product scopeFlexible Dedicated ServerAction / permissionreinstall

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

Tidak diperlukan.

Example request
curl \
  -H "Authorization: Bearer fs_live_xxxxxxxxxxxxxxxxx" \
  https://api.faithserver.com/api/v1/servers/fsrv_111/images
POST/servers/{service_id}/reinstallMenjalankan reinstall Linux atau Windows sesuai image.
Product scopeFlexible Dedicated ServerAction / permissionreinstall

Path parameters

service_idRequired
Public Service ID dari field id pada GET /servers.

Request body

imageRequired
Wajib. Gunakan id dari endpoint /images.
password
Digunakan sebagai password Administrator untuk Windows.
hostname
Opsional untuk Windows.
Example request
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_111/reinstall

Error reference

Pahami penyebab sebelum mencoba lagi

Dokumen referensi tidak menetapkan HTTP status untuk error berikut, sehingga halaman ini tidak menambahkannya.

Missing API Key

Penyebab: Header Authorization tidak dikirim, format Bearer salah, atau key dikirim melalui query/body.

Cara memperbaiki: Kirim API key melalui header Authorization dengan format Bearer.

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

Invalid API Key

Penyebab: API key tidak valid atau sudah dinonaktifkan.

Cara memperbaiki: Periksa key yang dipakai atau generate key baru setelah key lama direvoke.

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

IP Not Allowed

Penyebab: Whitelist aktif dan request datang dari IP yang tidak terdaftar.

Cara memperbaiki: Tambahkan IP aplikasi ke whitelist key atau gunakan IP yang sudah terdaftar.

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

Server Not Found

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

Cara memperbaiki: Ambil ulang Public Service ID dari GET /servers dan pastikan service aktif.

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

Action Not Allowed

Penyebab: Action tidak tersedia untuk produk, service tidak aktif, atau action tidak ada di allowed_actions.

Cara memperbaiki: Periksa allowed_actions lalu pilih action yang tersedia untuk service tersebut.

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

Feature Unavailable

Penyebab: Sistem layanan tidak menyediakan fitur yang diminta saat request diproses.

Cara memperbaiki: Periksa capability dan allowed_actions; coba kembali hanya setelah memastikan kondisi layanan.

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

Security guidelines

Lindungi key dan tindakan sensitif

Perlakukan API key, generated password, credentials, dan console URL sebagai secret.

  • Jangan membagikan API key, credentials, generated password, atau console URL.
  • Jangan memasukkan API key ke frontend atau public repository; simpan sebagai environment variable pada aplikasi server-side.
  • Gunakan IP whitelist bila arsitektur aplikasi memungkinkan.
  • Revoke key yang bocor lalu generate API key baru.
  • Kirim API key hanya melalui header Authorization, bukan query string atau request body.
  • Gunakan Public Service ID dari Gateway, bukan ID invoice, IP address, atau ID panel pihak ketiga.
  • Console URL memuat token sementara dan harus diperlakukan sebagai informasi sensitif.
  • Reinstall menghapus data; backup layanan unmanaged menjadi tanggung jawab pengguna.

Offline reference

FaithServer API Documentation - Client Reference

Version 2026.06.25 · 22 halaman · PDF aktual

Download PDF

FAQ produk

FAQ Developer API

Temukan informasi penting sebelum memilih dan menggunakan layanan.

8 pertanyaan

Autentikasi

Buat API key melalui Client Area, lalu kirimkan key sebagai Bearer token pada header Authorization. Full API key hanya ditampilkan satu kali dan harus disimpan dengan aman.

Penggunaan

Proses

API Keys

Keamanan

Siap mulai?

Mulai integrasi pertama Anda

Buat API key dari Client Area, lalu kembali ke Quick Start untuk request pertama.

Order FaithServer

Pilih metode pemesanan

Lanjutkan pemesanan melalui metode yang paling sesuai untuk Anda.

Produk yang dipilih