PATCH /projects/{project_reference}/integrations/{name}Change the scope, allowed tools, configuration or execution mode of a project integration by sending only the fields to change, so that an omitted field keeps its stored value; returns the updated project integration. Requires project.integrations.configure.
Servers
[
{
"url": "https://api.veryfront.com"
}
]Authentication
[
{
"bearerAuth": []
},
{
"apiKeyAuth": []
}
]{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT or API Key",
"description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
},
"apiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
}
}Parameters
Parameter contracts
[
{
"schema": {
"$ref": "#/components/schemas/ProjectReference"
},
"required": true,
"description": "Project slug, UUID, or domain that identifies the project.",
"name": "project_reference",
"in": "path"
},
{
"schema": {
"type": "string",
"description": "Integration name, for example \"salesforce\"."
},
"required": true,
"description": "Integration name, for example \"salesforce\".",
"name": "name",
"in": "path"
}
]Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"project",
"user",
"endUser",
"end_user"
],
"description": "Credential scope the integration uses. Omit to keep the stored value. The legacy end_user and endUser inputs are aliases of user; the result returns user."
},
"allowed_tools": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Unprefixed tool IDs the project allows. Null allows all tools. Omit to keep the stored list. Each entry must exist in the catalog of the effective execution mode."
},
"config": {
"type": "object",
"additionalProperties": {},
"description": "Integration-specific configuration that must match config_schema. Omit to keep the stored configuration."
},
"execution_mode": {
"type": "string",
"enum": [
"real",
"mock"
],
"description": "Execution mode, real or mock. Omit to keep the stored value."
}
}
}
}
}
}Responses
200
The updated project integration.
{
"description": "The updated project integration.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"icon": {
"type": "string"
},
"description": {
"type": "string"
},
"auth_type": {
"type": "string",
"enum": [
"oauth2",
"oauth1",
"api-key",
"basic"
]
},
"tool_count": {
"type": "integer",
"minimum": 0
},
"prompt_count": {
"type": "integer",
"minimum": 0
},
"connected_for_project": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": [
"project",
"user"
]
},
"allowed_tools": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"config": {
"type": "object",
"additionalProperties": {}
},
"execution_mode": {
"type": "string",
"enum": [
"real",
"mock"
]
},
"config_schema": {
"type": [
"object",
"null"
],
"properties": {
"version": {
"type": "number",
"enum": [
1
]
},
"fields": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"select"
]
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
}
},
"required": [
"key",
"type",
"label",
"options"
]
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"multiselect"
]
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "array",
"items": {
"type": "string"
}
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
}
},
"required": [
"key",
"type",
"label",
"options"
]
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"boolean"
]
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "boolean"
}
},
"required": [
"key",
"type",
"label"
]
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"number"
]
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "number"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
},
"step": {
"type": "number"
}
},
"required": [
"key",
"type",
"label"
]
}
]
}
}
},
"required": [
"version",
"fields"
],
"description": "The project configuration schema of the integration that config must match, or null when it declares none."
},
"project_connections": {
"type": "object",
"properties": {
"connected": {
"type": "integer",
"minimum": 0
},
"expired": {
"type": "integer",
"minimum": 0
},
"disconnected": {
"type": "integer",
"minimum": 0
}
},
"required": [
"connected",
"expired",
"disconnected"
]
},
"project_user_connections": {
"type": "object",
"properties": {
"connected": {
"type": "integer",
"minimum": 0
},
"expired": {
"type": "integer",
"minimum": 0
},
"disconnected": {
"type": "integer",
"minimum": 0
}
},
"required": [
"connected",
"expired",
"disconnected"
],
"description": "Private connections belonging to the interactive viewer in this project. Zero for API keys and service credentials."
},
"resolution": {
"type": "object",
"properties": {
"catalog_available": {
"type": "boolean"
},
"catalog_state": {
"type": "string",
"enum": [
"available",
"removed"
]
},
"policy": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"absent",
"allowed",
"restricted"
]
},
"scope": {
"type": "string",
"enum": [
"project",
"user"
]
},
"allowed_tools": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"execution_mode": {
"type": "string",
"enum": [
"real",
"mock"
]
}
},
"required": [
"state",
"scope",
"allowed_tools",
"execution_mode"
]
},
"credential_requirement": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"oauth_connection",
"project_credentials",
"none"
]
},
"managed_oauth": {
"type": "boolean"
},
"byo_oauth_app_override": {
"type": "object",
"properties": {
"supported": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"client_id_env_var": {
"type": [
"string",
"null"
]
},
"client_secret_env_var": {
"type": [
"string",
"null"
]
}
},
"required": [
"supported",
"required",
"client_id_env_var",
"client_secret_env_var"
]
},
"mandatory_env_vars": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"mode",
"managed_oauth",
"byo_oauth_app_override",
"mandatory_env_vars"
]
},
"connection_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"ready",
"required",
"not_applicable",
"unknown"
]
},
"scope": {
"type": [
"string",
"null"
],
"enum": [
"project",
"user",
null
]
},
"connected_count": {
"type": [
"integer",
"null"
],
"minimum": 0
}
},
"required": [
"status",
"scope",
"connected_count"
]
}
},
"required": [
"catalog_available",
"catalog_state",
"policy",
"credential_requirement",
"connection_readiness"
]
}
},
"required": [
"configured",
"created_at",
"updated_at",
"name",
"display_name",
"icon",
"description",
"auth_type",
"tool_count",
"prompt_count",
"connected_for_project",
"scope",
"allowed_tools",
"config",
"execution_mode",
"config_schema",
"project_connections",
"project_user_connections",
"resolution"
]
}
}
}
}400
invalid_input: a field is invalid, allowed_tools names a tool outside the catalog of the effective execution mode, or config does not match config_schema. errors lists the fields.
{
"description": "invalid_input: a field is invalid, allowed_tools names a tool outside the catalog of the effective execution mode, or config does not match config_schema. errors lists the fields.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}401
unauthenticated: no valid credential was sent.
{
"description": "unauthenticated: no valid credential was sent.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}403
forbidden: the credential lacks project.integrations.configure.
{
"description": "forbidden: the credential lacks project.integrations.configure.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}404
not_found: the project or the integration does not exist or is not accessible.
{
"description": "not_found: the project or the integration does not exist or is not accessible.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}500
internal: the update failed unexpectedly.
{
"description": "internal: the update failed unexpectedly.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}502
internal: the mock integration service did not return its catalog, which allowed_tools is checked against in mock execution mode.
{
"description": "internal: the mock integration service did not return its catalog, which allowed_tools is checked against in mock execution mode.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}503
internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.
{
"description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}Referenced contracts
components/parameters/ProjectReference
{
"schema": {
"$ref": "#/components/schemas/ProjectReference"
},
"required": true,
"description": "Project slug, UUID, or domain that identifies the project.",
"name": "project_reference",
"in": "path"
}components/schemas/ProjectReference
{
"type": "string"
}components/schemas/Problem
{
"type": "object",
"properties": {
"cause": {
"type": "string",
"enum": [
"schedule_concurrency_forbidden",
"schedule_fire_in_progress",
"schedule_run_limit_reached"
],
"description": "Schedule admission refusal."
},
"idempotency": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"in_progress",
"payload_mismatch",
"outcome_unknown"
]
},
"operation": {
"type": "string",
"minLength": 1
},
"retryable": {
"type": "boolean"
},
"retry_after_seconds": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"expires_at": {
"type": [
"string",
"null"
]
},
"recovery": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"description": {
"type": "string"
},
"resource_url": {
"type": "string"
}
},
"required": [
"available",
"description"
]
}
},
"required": [
"state",
"operation",
"retryable",
"retry_after_seconds",
"expires_at"
],
"description": "Replay status, retry timing, and recovery lookup."
},
"type": {
"type": "string",
"description": "URI reference identifying the problem type",
"example": "https://api.veryfront.com/errors/validation-failed"
},
"title": {
"type": "string",
"description": "Short human-readable summary of the problem",
"example": "Validation Failed"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599,
"description": "HTTP status code",
"example": 400
},
"code": {
"type": "string",
"description": "Stable machine-readable error code",
"example": "RUN_INVALID_INPUT"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence",
"example": "The 'email' field must be a valid email address"
},
"instance": {
"type": "string",
"description": "URI reference identifying the specific occurrence",
"example": "/projects/my-project/members"
},
"slug": {
"type": "string",
"description": "Stable identifier for the problem type",
"example": "validation-failed"
},
"category": {
"type": "string",
"enum": [
"AUTH",
"RESOURCE",
"VALIDATION",
"DATABASE",
"SUBSCRIPTION",
"INTEGRATION",
"INTERNAL"
],
"description": "API error category",
"example": "VALIDATION"
},
"suggestion": {
"type": "string",
"description": "Suggested action to resolve the problem",
"example": "Check the request body and query parameters against the API documentation."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field path that caused the error",
"example": "email"
},
"message": {
"type": "string",
"description": "Error message for this field",
"example": "Invalid email format"
},
"code": {
"type": "string",
"description": "Error code for this field",
"example": "INVALID_FORMAT"
}
},
"required": [
"field",
"message"
]
},
"description": "Detailed field-level errors for validation failures"
}
},
"required": [
"type",
"title",
"status"
]
}Operation contract
{
"operationId": "updateProjectIntegration",
"tags": [
"integrations/Integrations/Project integrations"
],
"summary": "Update project integration",
"description": "Change the scope, allowed tools, configuration or execution mode of a project integration by sending only the fields to change, so that an omitted field keeps its stored value; returns the updated project integration. Requires project.integrations.configure.",
"parameters": [
{
"$ref": "#/components/parameters/ProjectReference"
},
{
"schema": {
"type": "string",
"description": "Integration name, for example \"salesforce\"."
},
"required": true,
"description": "Integration name, for example \"salesforce\".",
"name": "name",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"project",
"user",
"endUser",
"end_user"
],
"description": "Credential scope the integration uses. Omit to keep the stored value. The legacy end_user and endUser inputs are aliases of user; the result returns user."
},
"allowed_tools": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Unprefixed tool IDs the project allows. Null allows all tools. Omit to keep the stored list. Each entry must exist in the catalog of the effective execution mode."
},
"config": {
"type": "object",
"additionalProperties": {},
"description": "Integration-specific configuration that must match config_schema. Omit to keep the stored configuration."
},
"execution_mode": {
"type": "string",
"enum": [
"real",
"mock"
],
"description": "Execution mode, real or mock. Omit to keep the stored value."
}
}
}
}
}
},
"responses": {
"200": {
"description": "The updated project integration.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"icon": {
"type": "string"
},
"description": {
"type": "string"
},
"auth_type": {
"type": "string",
"enum": [
"oauth2",
"oauth1",
"api-key",
"basic"
]
},
"tool_count": {
"type": "integer",
"minimum": 0
},
"prompt_count": {
"type": "integer",
"minimum": 0
},
"connected_for_project": {
"type": "boolean"
},
"scope": {
"type": "string",
"enum": [
"project",
"user"
]
},
"allowed_tools": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"config": {
"type": "object",
"additionalProperties": {}
},
"execution_mode": {
"type": "string",
"enum": [
"real",
"mock"
]
},
"config_schema": {
"type": [
"object",
"null"
],
"properties": {
"version": {
"type": "number",
"enum": [
1
]
},
"fields": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"select"
]
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
}
},
"required": [
"key",
"type",
"label",
"options"
]
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"multiselect"
]
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "array",
"items": {
"type": "string"
}
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
}
},
"required": [
"key",
"type",
"label",
"options"
]
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"boolean"
]
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "boolean"
}
},
"required": [
"key",
"type",
"label"
]
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"number"
]
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "number"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
},
"step": {
"type": "number"
}
},
"required": [
"key",
"type",
"label"
]
}
]
}
}
},
"required": [
"version",
"fields"
],
"description": "The project configuration schema of the integration that config must match, or null when it declares none."
},
"project_connections": {
"type": "object",
"properties": {
"connected": {
"type": "integer",
"minimum": 0
},
"expired": {
"type": "integer",
"minimum": 0
},
"disconnected": {
"type": "integer",
"minimum": 0
}
},
"required": [
"connected",
"expired",
"disconnected"
]
},
"project_user_connections": {
"type": "object",
"properties": {
"connected": {
"type": "integer",
"minimum": 0
},
"expired": {
"type": "integer",
"minimum": 0
},
"disconnected": {
"type": "integer",
"minimum": 0
}
},
"required": [
"connected",
"expired",
"disconnected"
],
"description": "Private connections belonging to the interactive viewer in this project. Zero for API keys and service credentials."
},
"resolution": {
"type": "object",
"properties": {
"catalog_available": {
"type": "boolean"
},
"catalog_state": {
"type": "string",
"enum": [
"available",
"removed"
]
},
"policy": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"absent",
"allowed",
"restricted"
]
},
"scope": {
"type": "string",
"enum": [
"project",
"user"
]
},
"allowed_tools": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"execution_mode": {
"type": "string",
"enum": [
"real",
"mock"
]
}
},
"required": [
"state",
"scope",
"allowed_tools",
"execution_mode"
]
},
"credential_requirement": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"oauth_connection",
"project_credentials",
"none"
]
},
"managed_oauth": {
"type": "boolean"
},
"byo_oauth_app_override": {
"type": "object",
"properties": {
"supported": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"client_id_env_var": {
"type": [
"string",
"null"
]
},
"client_secret_env_var": {
"type": [
"string",
"null"
]
}
},
"required": [
"supported",
"required",
"client_id_env_var",
"client_secret_env_var"
]
},
"mandatory_env_vars": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"mode",
"managed_oauth",
"byo_oauth_app_override",
"mandatory_env_vars"
]
},
"connection_readiness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"ready",
"required",
"not_applicable",
"unknown"
]
},
"scope": {
"type": [
"string",
"null"
],
"enum": [
"project",
"user",
null
]
},
"connected_count": {
"type": [
"integer",
"null"
],
"minimum": 0
}
},
"required": [
"status",
"scope",
"connected_count"
]
}
},
"required": [
"catalog_available",
"catalog_state",
"policy",
"credential_requirement",
"connection_readiness"
]
}
},
"required": [
"configured",
"created_at",
"updated_at",
"name",
"display_name",
"icon",
"description",
"auth_type",
"tool_count",
"prompt_count",
"connected_for_project",
"scope",
"allowed_tools",
"config",
"execution_mode",
"config_schema",
"project_connections",
"project_user_connections",
"resolution"
]
}
}
}
},
"400": {
"description": "invalid_input: a field is invalid, allowed_tools names a tool outside the catalog of the effective execution mode, or config does not match config_schema. errors lists the fields.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"401": {
"description": "unauthenticated: no valid credential was sent.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"403": {
"description": "forbidden: the credential lacks project.integrations.configure.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "not_found: the project or the integration does not exist or is not accessible.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"500": {
"description": "internal: the update failed unexpectedly.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"502": {
"description": "internal: the mock integration service did not return its catalog, which allowed_tools is checked against in mock execution mode.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"503": {
"description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"x-documentation-source-tag": "Project integrations",
"x-canonical-documentation": {
"domain": "integrations",
"resource": "Integrations",
"subgroup": "Project integrations",
"name": "Update project integration",
"description": "Change the scope, allowed tools, configuration or execution mode of a project integration by sending only the fields to change, so that an omitted field keeps its stored value; returns the updated project integration. Requires project.integrations.configure.",
"operationId": "updateProjectIntegration"
},
"x-mint": {
"href": "/cloud/rest/api-reference/integrations-integrations-project-integrations/update-project-integration"
}
}