Create API key

veryfront__create_api_key

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can read or manage credentials.

Arguments

FieldTypeRequiredDescription and constraints
namestringYesName for the API key
project_referencestringNoProject ID or slug. Creating a project-scoped key requires project.api_keys.manage. Omit for a user-level key; a project-scoped API-key caller retains its enforced project when this field is omitted.
expires_atstringNoExpiration date in ISO 8601 format

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__create_api_key",
    "arguments": {
      "name": "example"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
idstringYesUnique identifier for the returned record.
project_idstring or nullYesProject identifier associated with this result.
user_idstringYes
namestringYesHuman-readable name for the returned record.
keystringYesSecret API key, returned only once. Do not echo, log or paste it into chat; write it straight to a secret store or environment variable.
key_prefixstringYes
expires_atstring or nullYes
created_atstringYesCreation timestamp in ISO 8601 format.
scopesstring[]YesList of scopes associated with this tool result.
scopestringYesWhether the key is bound to one project (project) or applies to the account (account). Values: "account", "project".

Full schemas

json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for the API key"
    },
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug. Creating a project-scoped key requires project.api_keys.manage. Omit for a user-level key; a project-scoped API-key caller retains its enforced project when this field is omitted."
    },
    "expires_at": {
      "type": "string",
      "description": "Expiration date in ISO 8601 format"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "description": "Arguments for the create_api_key tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "project_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Project identifier associated with this result."
    },
    "user_id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the returned record."
    },
    "key": {
      "type": "string",
      "description": "Secret API key, returned only once. Do not echo, log or paste it into chat; write it straight to a secret store or environment variable."
    },
    "key_prefix": {
      "type": "string"
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of scopes associated with this tool result."
    },
    "scope": {
      "type": "string",
      "enum": [
        "account",
        "project"
      ],
      "description": "Whether the key is bound to one project (project) or applies to the account (account)."
    }
  },
  "required": [
    "id",
    "project_id",
    "user_id",
    "name",
    "key",
    "key_prefix",
    "expires_at",
    "created_at",
    "scopes",
    "scope"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the create_api_key tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}