Skip to content

Client area API

Managed from: Client area. 7 answers, updated 21 November 2026.

API reference: every route, with curl examples

Essentials 2

What can I do with the client area API?

Manage your services from your own tools: an internal dashboard, a script, your monitoring or your deployment pipeline. The API lists your services, reads their status and IP addresses, starts, restarts or stops a server, reinstalls a VPS or a dedicated server, returns your invoices and orders game servers or VPS paid with your balance.

In the client area

My ProfileSecurityAPI keysOpen
  1. Create a key in Client areaMy ProfileSecurityAPI keys, with only the scopes your tool needs.

  2. Check it with a first call (see the question "How do I make a first API call?").

  3. Connect your tool using the API reference: every route has its curl example and its response.

The full API reference: panel.helloserv.fr/api/docs

Can I resell servers ordered through the API?

Yes. Your tool orders game servers or VPS with your account balance, at the same price as in the client area, then manages them through the API for your own customers. You set your own prices.

In the client area

My ProfileSecurityAPI keysOpen
  1. Create a key for your shop only, with the Ordering and Power scopes, restricted to your server's IP addresses.

  2. When a customer buys from you, your tool places the order, then gives them the server's IP address and status read from the API.

  3. Keep your balance topped up: an order your balance does not cover is refused, and nothing is created.

Guides 5

How do I create an API key?

You create a key in your client area once two-factor authentication is on for your account. It is shown only once: copy it right away and keep it secret, like a password.

In the client area

My ProfileSecurityAPI keysOpen
  1. Turn on two-factor authentication on your account (authenticator app or passkey): it is required to create a key.

  2. Client areaMy ProfileSecurity, API keys button (also in your account menu, top right).

  3. Name the key, tick only the scopes it needs (Read always, Power, Reinstall, Ordering), add the allowed IP addresses if you want, then Create the key and confirm your identity.

  4. Copy the key right away: it will never be shown again. Send it in the Authorization: Bearer header of every request.

Common errors

  • Key lost or published by mistake: revoke it on the same page, it is refused at once, then create another one.
  • Key refused (401) after a password reset: for your security, keys created in the previous 7 days are revoked along with the other recent additions to the account. Create a new one.
  • Error 403 insufficient_scope: the key does not have the scope required (Power, Reinstall or Ordering). Create a key with that scope.
  • Error 403 ip_not_allowed: the call comes from an address that is not in the key's list. Add it with Edit allowed addresses, under the key.
  • Error 429: at most 120 requests per minute per key, 6 actions per minute on the same service, 10 orders per day per key.

The full documentation, with curl examples: panel.helloserv.fr/api/docs

How do I make a first API call?

The API answers at https://panel.helloserv.fr/api/v1, in JSON. Send your key in the Authorization header of every request.

In the client area

My ProfileSecurityAPI keysOpen
  1. In a terminal, keep the key in a variable, then call the account route: it returns your account, your balance and the key's scopes.

    terminal
    export HELLOSERV_KEY="hsk_your_key"curl https://panel.helloserv.fr/api/v1/account \  -H "Authorization: Bearer $HELLOSERV_KEY"
  2. List your running services: each one comes with its number, its type and its status.

    terminal
    curl "https://panel.helloserv.fr/api/v1/services?status=active" \  -H "Authorization: Bearer $HELLOSERV_KEY"
  3. Restart a server with its number (key with the Power scope).

    terminal
    curl -X POST https://panel.helloserv.fr/api/v1/services/1234/power \  -H "Authorization: Bearer $HELLOSERV_KEY" -H "Content-Type: application/json" \  -d '{"action": "restart"}'

Common errors

  • Error 401 missing_key or invalid_key: the header is missing, the key was copied wrong or it has been revoked.
  • Error 404 service_not_found: the number does not match any service on your account.
How do I restrict an API key to certain IP addresses?

Give the key the list of addresses or ranges your calls come from, up to 20, in IPv4 or IPv6. A call from anywhere else is refused, even with the right key.

In the client area

My ProfileSecurityAPI keysOpen
  1. Client areaMy ProfileSecurityAPI keys.

  2. When you create a key, fill in Allowed IP addresses: one address or range per line, for example 203.0.113.10 or 2001:db8::/48. Your current address is shown under the field.

  3. For an existing key: Edit allowed addresses, under the key, then Save. Your identity is checked again.

Common errors

  • Error 403 ip_not_allowed: the call comes from an address that is not in the list. It shows in Latest calls, on the same page: add the address if it is really yours.
  • A server that also goes out over IPv6: add its IPv6 address as well as its IPv4.
How do I order a game server or a VPS through the API?

First ask for the exact price with a dry run, then place the order. The invoice is paid with your balance and the server is delivered like an order placed in the client area.

In the client area

My ProfileSecurityAPI keysOpen
  1. Create a key with the Ordering scope (never ticked by default) and top up your balance from the client area.

  2. Read the catalog: GET /catalog gives the products, GET /catalog/{type} their offers and their prices for your account.

  3. Ask for the exact price without ordering anything, with "dry_run": true.

    terminal
    curl -X POST https://panel.helloserv.fr/api/v1/orders \  -H "Authorization: Bearer $HELLOSERV_KEY" -H "Content-Type: application/json" \  -d '{"type": "vpsintel", "offer_id": 3, "period": "monthly", "os": "debian12", "dry_run": true}'
  4. Place the order: the same request without dry_run, with an Idempotency-Key header that changes for every order. If the request is sent twice, the order is placed only once.

  5. Follow the service with GET /services/{id}: it goes from pending to active once delivered.

Common errors

  • Error 402 insufficient_balance: your balance does not cover the order, nothing is ordered.
  • Error 422 country_required: fill in your country in your profile, it sets the VAT.
  • Error 429 order_limit_reached: 10 orders per day with the same key.
  • Error 400 unknown_field: a misspelt field is refused, it never turns into an order.
How do I see an API key's calls and revoke it?

The keys page shows when each key was last used and the latest calls received, refusals included. A revoked key is refused at once.

In the client area

My ProfileSecurityAPI keysOpen
  1. Client areaMy ProfileSecurityAPI keys.

  2. Under each key: its creation date, its last use with the IP address it came from and its number of calls over 24 hours.

  3. Latest calls, at the bottom of the page: the calls received with your keys, newest first.

  4. To cut a key off: Revoke, under the key, then confirm. Tools that use it lose access.

Can't find it? Open a ticket from your client area. Terms and conditions: helloserv.fr/en/legal