Update API key - Veryfront

veryfront__update_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

Field	Type	Required	Description and constraints
`name`	`string`	No	New name for the API key
`expires_at`	`string or null`	No	New expiration date (null to remove)
`api_key_id`	`string`	Yes	API key ID

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.

request.json

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

Result

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

Field	Type	Required	Description and constraints
`id`	`string`	Yes	Unique identifier for the returned record.
`project_id`	`string or null`	Yes	Project identifier associated with this result.
`user_id`	`string`	Yes
`name`	`string`	Yes	Human-readable name for the returned record.
`key_prefix`	`string`	Yes
`last_used_at`	`string or null`	Yes
`expires_at`	`string or null`	Yes
`created_at`	`string`	Yes	Creation timestamp in ISO 8601 format.
`updated_at`	`string`	Yes	Last update timestamp in ISO 8601 format.
`status`	`string`	Yes	Whether the key can authenticate. A revoked key stays listed with status revoked. Values: `"active"`, `"expired"`, `"revoked"`.
`revoked_at`	`string or null`	Yes	When the key was revoked; null while it is not revoked.
`scopes`	`string[]`	Yes	List of scopes associated with this tool result.
`scope`	`string`	Yes	Whether the key is bound to one project (project) or applies to the account (account). Values: `"account"`, `"project"`.

Full schemas

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "New name for the API key"
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "New expiration date (null to remove)"
    },
    "api_key_id": {
      "type": "string",
      "description": "API key ID"
    }
  },
  "required": [
    "api_key_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the update_api_key tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "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_prefix": {
      "type": "string"
    },
    "last_used_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    },
    "updated_at": {
      "type": "string",
      "description": "Last update timestamp in ISO 8601 format."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "expired",
        "revoked"
      ],
      "description": "Whether the key can authenticate. A revoked key stays listed with status revoked."
    },
    "revoked_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the key was revoked; null while it is not revoked."
    },
    "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_prefix",
    "last_used_at",
    "expires_at",
    "created_at",
    "updated_at",
    "status",
    "revoked_at",
    "scopes",
    "scope"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the update_api_key tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}