api_key_create

Create a new API key for programmatic access to the TrueNAS API. Returns the key — store it securely as it cannot be retrieved later.

SERVERTruenas SOURCEspranab/truenas-mcp

Medium RISK CLASS

Category Write

Parameters 00 required

Recommended Rate-limitedsee the rule below

Registry record Grade F, identity unverified Pull the record →

This record as markdown: /tools/spranab-truenas-mcp/api-key-create.md

WHAT IT DOES

What api_key_create does on Truenas

AI agents use api_key_create to create or update resources in Truenas, usually the action step of a workflow, after the agent has gathered context. Every call changes real data in your Truenas environment.

RISK

Why api_key_create is rated Medium

This tool creates a new credential that grants programmatic access to a TrueNAS system. While technically a 'create' operation (Write category), the consequence is enabling authenticated access to a critical infrastructure system. The high severity reflects that a compromised or misused API key could provide an attacker with broad control over the TrueNAS instance depending on the key's permissions.

From the tool's definition Create a new API key for programmatic access to the TrueNAS API. Returns the key — store it securely as it cannot be retrieved later.

Attacks that exploit this kind of access

RECOMMENDED RULE

The rule that runs api_key_create safely

PolicyLayer is an MCP gateway: it sits between your AI agents and Truenas, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For api_key_create, this is the rule to start with:

api_key_create Rate-limited

api_key_create stays usable, but capped: an agent stuck in a loop can't make hundreds of changes a minute. Everything else on the server is denied unless you say otherwise.

View as policy code

policy.json

{
  "version": "1",
  "default": "deny",
  "tools": {
    "api_key_create": {
      "limits": [
        {
          "counter": "api_key_create_rate",
          "window": "minute",
          "max": 30,
          "scope": "grant"
        }
      ]
    }
  }
}

LIMIT THIS TOOL → Instant setup, no code required.

The button opens the PolicyLayer dashboard: create your workspace, connect Truenas, apply this rule, and every api_key_create call is checked against it from then on.

FAQ

Questions about api_key_create

What does the api_key_create tool do? +

Create a new API key for programmatic access to the TrueNAS API. Returns the key — store it securely as it cannot be retrieved later. It is categorised as a Write tool in the Truenas MCP Server, which means it can create or modify data. Consider rate limits to prevent runaway writes.

How do I enforce a policy on api_key_create? +

Register the Truenas MCP server in PolicyLayer and add a rule for api_key_create: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Truenas. Nothing to install.

What risk level is api_key_create? +

api_key_create is a Write tool with medium risk. Write tools should be rate-limited to prevent accidental bulk modifications.

Can I rate-limit api_key_create? +

Yes. Add a rate_limit block to the api_key_create rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.

How do I block api_key_create completely? +

Set action: deny in the PolicyLayer policy for api_key_create. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.

What MCP server provides api_key_create? +

api_key_create is provided by the Truenas MCP server (spranab/truenas-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

KEEP EXPLORING

More on Truenas, and thousands of servers like it.

This server

All 279 Truenas tools →

Across the catalogue

create_task on 0rca Dojo MCP Server →create-task on Kanban MCP Server →create_package_backup on Android Forensics ADB MCP Server →create_project on Stitch MCP Server → The MCP Attack Database →

Guides

Govern customer-ops agents →Argument validation →Scoped token →