Update environment

veryfront__update_environment

Requires project.environments.manage.

Access

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

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug
environment_idstringYesEnvironment ID Format: uuid.
namestringNoNew environment name
protectedbooleanNoWhether the environment is protected
variablesobject[]NoAtomic variable upserts in this environment. Existing keys retain their IDs; omitted keys remain unchanged and returned values are masked. A non-empty list also requires project.env_vars.write.

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__update_environment",
    "arguments": {
      "environment_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}

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. Format: uuid.
namestringYesHuman-readable name for the returned record.
project_idstringYesProject identifier associated with this result.
protectedbooleanYes
domainsstring[]YesCustom domains attached to the environment.
environment_variablesobject[]No

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "environment_id": {
      "type": "string",
      "format": "uuid",
      "description": "Environment ID"
    },
    "name": {
      "type": "string",
      "description": "New environment name"
    },
    "protected": {
      "type": "boolean",
      "description": "Whether the environment is protected"
    },
    "variables": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1,
            "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
            "description": "Provide the key."
          },
          "value": {
            "type": "string",
            "description": "Provide the value."
          }
        },
        "required": [
          "key",
          "value"
        ],
        "additionalProperties": false,
        "description": "One variable item supplied to the tool."
      },
      "description": "Atomic variable upserts in this environment. Existing keys retain their IDs; omitted keys remain unchanged and returned values are masked. A non-empty list also requires project.env_vars.write."
    }
  },
  "required": [
    "environment_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the update_environment tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the returned record."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the returned record."
    },
    "project_id": {
      "$ref": "#/properties/id",
      "description": "Project identifier associated with this result."
    },
    "protected": {
      "type": "boolean"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Custom domains attached to the environment."
    },
    "environment_variables": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the returned record."
          },
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string",
            "const": "********"
          },
          "has_value": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "key",
          "value",
          "has_value"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "name",
    "project_id",
    "protected",
    "domains"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the update_environment tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}