Ferrix Systems
Developers

The Ferrix API and MCP server

Read your account and run routine actions from scripts or from an AI assistant. The REST API lives at /api/v1 and the MCP server at /api/mcp. Both use the same API keys and the same permissions.

What they are

The API is a set of JSON endpoints for your own account: services, billing, support tickets, the catalog and more. The MCP server offers the same operations as tools that an AI assistant such as Claude Code or claude.ai can call. Every request acts as the person who made the key or approved the connection, and sees only that account.

Connect an AI assistant

Scopes are the same permissions your role has in the portal, such as viewing services or managing support tickets. A key never exceeds the role of the person who owns it, and it shrinks the moment that role does. An administrator can hold keys only for their own account, and those keys always wait for the administrator's own approval on money and site or server changes. Keys always expire, and you can revoke one at any time.

claude.ai can connect by signing in to Ferrix, with no key. Every other tool, including Claude Code, Codex and Cursor, uses a personal API key.

  1. Pick your tool

    Pick your tool

    The steps below change to match your choice.

  2. Create a key

    Sign in, open Account, then Developer, and select Create key. The key starts with fxk_ and is shown once.

  3. Paste this in your terminal

    Run it once, in any folder.

    claude mcp add --transport http ferrix https://<portal>/api/mcp --header "Authorization: Bearer fxk_YOUR_KEY"

    Replace fxk_YOUR_KEY with your own key before you run this.

    When it worked: Claude Code says it added the server. Type /mcp inside Claude Code and ferrix shows as connected.

  4. Check it works

    Ask your assistant: Run whoami on Ferrix

    When it worked: It answers with your account email and the permissions your key holds.

If something goes wrong

  • 401 or invalid key: the key was mistyped, expired or revoked. Create a new key and paste the new command.
  • API is off: the account owner has not turned it on. Ask the owner.
  • An action waits for approval: anything that spends money, and anything that can damage a live site or server (removing or installing a WordPress plugin or theme, switching PHP, restoring a restore point, deleting WordPress users, changing a custom domain, a Docker Stack or a Minecraft modpack), waits until you approve it in the portal, under Account, Developer.
  • Too many requests (429): wait a minute, then try again. Each key can make 120 requests per minute.

Use the REST API

Replace <portal> with the address you use to sign in.

curl https://<portal>/api/v1/me \
  -H "Authorization: Bearer fxk_..."

Call whoami first. It tells the assistant which account it is in and which permissions the key holds.

Limits and errors

Each key can make 120 requests per minute. Over that, the API answers 429 and says how many seconds to wait. Errors always use one shape, with a stable code and a sentence for a person. Validation errors add a list of the fields at fault.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key lacks the \"billing_view\" permission."
  }
}

What the API can never do

These stay in the portal, whatever scopes a key holds.

  • Set or reveal passwords or other secrets. New WordPress users get WordPress's own set-password email.
  • Run raw wp-cli commands or upload ZIP files.
  • Delete services, open consoles or enter card details.
  • Change account security (password, two-factor, email), manage API keys, invite team members or change roles.
  • Do anything an administrator can do.

Some actions always wait for your approval in the portal: anything that spends money, and anything that can damage a live WordPress site, such as removing or installing a plugin or theme, switching PHP, restoring a restore point or deleting a WordPress user. Approval for money can be skipped on your own personal key. Approval for site changes cannot.

Reference

The OpenAPI 3.1 document at /api/v1/openapi.json lists every endpoint, its parameters, the scope it needs and its response. It is generated from the code the API runs on and needs no key to read.