Production Developer API

Build integration with FaithServer API

Use the API to access active services, perform available actions, and retrieve product catalogs according to your integration needs.

Start from Quick Start Download PDF documentation

EnvironmentProduction

Base URLhttps://api.faithserver.com/api/v1

AuthenticationBearer token

Document version2026.06.25

API keys can only access active services registered in the key owner's account.

Documentation navigation

Find it faster

Look in the documentation

Search for endpoints, features, or parameters

All endpoints are displayed.

Quick Start

Start your first integration

These four steps take you from key creation to the first action without using the service's internal ID.

1
Generate API Key
Open the Client Area, go to the API Keys menu, then create a new key.
2
List Server
Run GET /servers to see active services.
3
Get the Service ID
Use the field id as a Public Service ID.
4
Run an action
Select the endpoint according to the product and field allowed_actions.

API KeyGET /serversService IDAllowed ActionJob / Response

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

Authentication

Send API key via header

Every request must use a Bearer token in the Authorization header. Do not send keys via query strings, form bodies, or parameters api_key.

Base URLhttps://api.faithserver.com/api/v1

HeaderAuthorization: Bearer <API_KEY>

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

const response = await fetch("https://api.faithserver.com/api/v1/servers", {
  headers: {
    Authorization: "Bearer fs_live_xxxxxxxxxxxxxxxxx"
  }
});

const data = await response.json();

$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

Manage access from the Client Area

The full API key is only displayed once. Store it safely and revoke it immediately if the key is lost or leaked.

Generate API Key

Create a new key for the API Gateway.

Whitelist IPs

Limit key use to certain IP addresses. If empty, the key can be used from any IP.

Edit API Key

Change the key name and whitelist the IP.

Revoke API Key

Deactivate the key so it can no longer be used.

Service API Access

View active services that are synchronized from the Client Area.

Fundamental concepts

Concepts that need to be understood

Public Service ID

Fields id from GET /servers. Do not use invoice IDs, IP addresses, or third-party panel IDs.

Active services

API keys only reach active services on the same account.

allowed_actions

List of actions that are actually available for the service.

Jobs & logs

Jobs helps monitor the process; logs record actions and can mask sensitive fields.

Temporary console URL

The console URL contains a temporary token and must be maintained like a credential.

Product capabilities

Features vary by product, region, status, and server configuration.

Destructive actions

Reinstall deletes data. Make sure backup is available before running it.

Product selector

Select the products you want to integrate

Use the following navigation to navigate to the appropriate capability and endpoint.

Endpoint documentation

Common Endpoints

Use this section to find active services, read status, and monitor logs and jobs.

Active service
Public Service ID
Allowed actions
Logs & jobs

GET/serversDisplays all active servers connected with the API key.

Product scopeAll services are active

Request body

Not required.

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", "console"]
    }
  ]
}

GET/servers/{service_id}Displays brief server details based on Public Service ID.

Product scopeAll services are active

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/statusCheck server status directly from the service system.

Product scopeProducts that support statusAction / permissionstatus

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/overviewDisplays a summary of servers, regions, IP addresses, packages, and capabilities.

Product scopeProducts that support overviewAction / permissionoverview

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/actionsDisplays action logs per server.

Product scopeAll services are active

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/logsDisplays all API logs.

Product scopeAPI key owner account

Request body

Not required.

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

GET/jobsDisplays a list of jobs.

Product scopeAPI key owner account

Request body

Not required.

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

GET/jobs/{job_id}Displays specific job details.

Product scopeAPI key owner account

Path parameters

job_idRequired: The job ID returned by the associated action.

Request body

Not required.

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

{
  "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

Retrieve product variants for websites, panels, or external integrations without changing catalog data.

Premium VPS
Flexible Dedicated
Global Dedicated
Catalog filters

GET/product/variants/premiumvpsShowing available Premium VPS Multi-region variants.

Product scopePremium VPS Multi-region catalogue

Query parameters

region: Optional. Regions such as SG, JP, UK, or NL.
location: Optional. Location code such as SIN-11 or AMS-01.
refresh: Optional. Use refresh=1 to fetch the latest data from the cache/API gateway.

Request body

Not required.

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

{
  "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/variantsDisplays the Flexible Dedicated Server variant of the dynamic auction catalog.

Product scopeFlexible Dedicated Server catalog

Query parameters

min_ram: Optional. Minimum RAM in GB. Default 64.
disk_type: Optional. Storage such as NVMe, SSD, or HDD.
q: Optional. Search for CPU, storage, or description.

Request body

Not required.

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

{
  "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/variantsFeatures the Global Dedicated Server variant.

Product scopeGlobal Dedicated Server catalog

Query parameters

min_ram: Optional. Minimum RAM in GB.
location: Optional. Location/datacenter such as FRA-01 or AMS-01.
account: Optional. Account/region catalog such as de, nl, or sg.
limit: Optional. Limit the amount of response data.
offset: Optional. Offset pagination.

Request body

Not required.

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

{
  "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

Manage power, console, rescue, reinstall, password, credentials, and traffic according to allowed_actions.

Power actions
VNC console
Rescue mode
Reinstall & traffic

POST/servers/{service_id}/startTurning on the server.

Product scopePremium VPS Multi-regionAction / permissionstart

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/stopPower off the server.

Product scopePremium VPS Multi-regionAction / permissionstop

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/rebootReboot the server.

Product scopePremium VPS Multi-regionAction / permissionreboot

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/consoleCreate a temporary VNC console URL.

Product scopePremium VPS Multi-regionAction / permissionconsole

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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_response": {
    "url": "https://console.example/vnc.html?token=temporary_token",
    "expires_in": 600
  }
}

GET/servers/{service_id}/rescue/statusCheck rescue mode status.

Product scopePremium VPS Multi-regionAction / permissionrescue

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/rescue/enableActivate rescue mode.

Product scopePremium VPS Multi-regionAction / permissionrescue

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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/disableDisable rescue mode.

Product scopePremium VPS Multi-regionAction / permissionrescue

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/imagesDisplays Linux and Windows images for reinstallation.

Product scopePremium VPS Multi-regionAction / permissionreinstall

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/reinstallRun a reinstall of Linux or Windows.

Product scopePremium VPS Multi-regionAction / permissionreinstall

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

imageId / imageRequired: The image ID of the /images endpoint.
password: Optional for Windows; if empty, an Administrator password is generated automatically.

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 if the service supports it.

Product scopePremium VPS Multi-regionAction / permissionreset-password

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/credentialsDisplays a list of credentials.

Product scopePremium VPS Multi-regionAction / permissioncredentials

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/credentials/{type}/{username}Displays credential details.

Product scopePremium VPS Multi-regionAction / permissioncredentials

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.
typeRequired: The type of credential the service returns.
usernameRequired: The username credential you want to read.

Request body

Not required.

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

GET/servers/{service_id}/trafficDisplays traffic or bandwidth usage.

Product scopePremium VPS Multi-regionAction / permissiontraffic

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Query parameters

period: Optional. Example period=month.

Request body

Not required.

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

Endpoint documentation

Budget VPS

Use osid to reinstall Budget VPS and always grab the latest template from endpoint images.

Power actions
VNC console
OS templates
IP, monitor & tasks

POST/servers/{service_id}/startTurning on the server.

Product scopeBudget VPSAction / permissionstart

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/stopPower off the server.

Product scopeBudget VPSAction / permissionstop

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/rebootReboot the server.

Product scopeBudget VPSAction / permissionreboot

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/consoleCreate a temporary VNC console URL.

Product scopeBudget VPSAction / permissionconsole

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/rescue/statusCheck rescue mode status.

Product scopeBudget VPSAction / permissionrescue

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/rescue/enableActivate rescue mode if available.

Product scopeBudget VPSAction / permissionrescue

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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/disableDisable rescue mode if available.

Product scopeBudget VPSAction / permissionrescue

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/imagesDisplays OS templates and latest OSID values.

Product scopeBudget VPSAction / permissionreinstall

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/reinstallReinstall Budget VPS using osid.

Product scopeBudget VPSAction / permissionreinstall

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

osidRequired: The numeric ID of the /images endpoint.
passwordRequired: New password for the selected template.

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-passwordSet a custom password if the service supports it.

Product scopeBudget VPSAction / permissionreset-password

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

passwordRequired: New 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_111/reset-password

GET/servers/{service_id}/ipsDisplays a list of IP addresses on the server.

Product scopeBudget VPSAction / permissionips

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/monitorDisplays available basic monitoring.

Product scopeBudget VPSAction / permissionmonitor

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/trafficDisplays traffic or bandwidth usage.

Product scopeBudget VPSAction / permissiontraffic

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Query parameters

month: Optional. Months are in YYYYMM format, for example 202605.

Request body

Not required.

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

GET/servers/{service_id}/tasksDisplays the most recent task or action if supported.

Product scopeBudget VPSAction / permissiontasks

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

Endpoint documentation

Flexible Dedicated Server

Dedicated servers do not have start/stop like VPS. Use hardware reboot or Wake On LAN if available.

Status & overview
Hardware reboot
Wake On LAN
Linux/Windows reinstall

GET/servers/{service_id}/statusCheck the status of the dedicated server.

Product scopeFlexible Dedicated ServerAction / permissionstatus

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/overviewDisplays the dedicated server summary.

Product scopeFlexible Dedicated ServerAction / permissionoverview

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/rebootPerform a hardware reboot.

Product scopeFlexible Dedicated ServerAction / permissionreboot

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/wolPerforms Wake On LAN if available.

Product scopeFlexible Dedicated ServerAction / permissionwol

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

GET/servers/{service_id}/imagesDisplays a Linux or Windows reinstall image.

Product scopeFlexible Dedicated ServerAction / permissionreinstall

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

Not required.

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

POST/servers/{service_id}/reinstallRun a reinstall of Linux or Windows according to the image.

Product scopeFlexible Dedicated ServerAction / permissionreinstall

Path parameters

service_idRequired: Public Service ID from the id field in GET /servers.

Request body

imageRequired: Must. Use the id of the /images endpoint.
password: Used as an Administrator password for Windows.
hostname: Optional for 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_111/reinstall

Error reference

Understand the cause before trying again

The reference document does not specify an HTTP status for the following error, so this page does not add one.

Missing API Key

Reason: The Authorization header was not sent, the Bearer format is incorrect, or the key was sent via query/body.

How to fix: Send the API key via the Authorization header in Bearer format.

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

Invalid API Key

Reason: The API key is invalid or has been disabled.

How to fix: Check the key used or generate a new key after the old key has been revived.

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

IP Not Allowed

Reason: The whitelist is active and requests come from unregistered IPs.

How to fix: Add the application IP to the whitelist key or use an IP that is already registered.

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

Server Not Found

Reason: Service ID is incorrect, the server does not belong to the account, or the service is not active/not yet synchronized.

How to fix: Re-fetch the Public Service ID from GET /servers and make sure the service is active.

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

Action Not Allowed

Reason: The action is not available for the product, the service is not active, or the action is not in allowed_actions.

How to fix: Check allowed_actions and then select the actions available for that service.

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

Feature Unavailable

Reason: The service system does not provide the requested feature when the request is processed.

How to fix: Check capability and allowed_actions; try again only after confirming the service condition.

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

Security guidelines

Protect sensitive keys and actions

Treat API keys, generated passwords, credentials, and console URLs as secrets.

Don't share API keys, credentials, generated passwords, or console URLs.
Don't put API keys into the frontend or public repository; save it as an environment variable in the server-side application.
Use an IP allowlist when the application architecture permits it.
Revoke the leaked key then generate a new API key.
Send the API key only via the Authorization header, not the query string or request body.
Use the Gateway's Public Service ID, not the invoice ID, IP address, or third-party panel ID.
The console URL contains a temporary token and should be treated as sensitive information.
Reinstall deletes data; backup of unmanaged services is the user's responsibility.

Offline reference

FaithServer API Documentation - Client Reference

Version 2026.06.25 · 22 pages · Actual PDF

Download PDF

Product FAQs

API Developer FAQ

Find important information before selecting and using a service.

8 questions

Authentication

Create an API key via the Client Area, then send the key as a Bearer token in the Authorization header. The full API key is only displayed once and must be stored securely.

Use

Process

API Keys

Security

Ready to start?

Start your first integration

Create an API key from the Client Area, then return to Quick Start for the first request.

Open Client Area See Quick Start

USD prices are converted at a fixed rate of IDR 19,000 per US$1. The final billing currency and amount are shown during checkout.