Write file

http
PUT /projects/{project_reference}/files/{file_path}

Create a file or replace its content. Requires project.files.write.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "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

NameLocationRequiredDescription
project_referencepathYes
file_pathpathYes
refqueryNo
branchqueryNo
branch_idqueryNo

Parameter contracts

json
[
  {
    "schema": {
      "type": "string",
      "description": "Project slug, UUID, or domain"
    },
    "required": true,
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": "string",
      "description": "File path (URL-encoded, for example, pages%2Findex.mdx)."
    },
    "required": true,
    "name": "file_path",
    "in": "path"
  },
  {
    "schema": {
      "type": "string",
      "description": "Mutable content to address: main or branch:<name-or-id>. Omit for main. Release and environment selectors return 400. Supplied aliases must name the same content.",
      "example": "branch:feature-x"
    },
    "required": false,
    "name": "ref",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "description": "Branch name or ID; legacy alias for ref=branch:<value>. Supplied aliases must agree."
    },
    "required": false,
    "name": "branch",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "format": "uuid",
      "description": "Branch UUID; legacy alias for ref=branch:<uuid>. Supplied aliases must agree."
    },
    "required": false,
    "name": "branch_id",
    "in": "query"
  }
]

Request body

json
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string",
            "description": "Replacement textual content in main or the selected branch, stored as a new immutable version. Source-file MIME type is not writable."
          },
          "expected_checksum": {
            "type": "string",
            "description": "Expected current checksum when updating an existing file; ignored on creation. Omission disables this guard."
          },
          "expected_version_id": {
            "type": "string",
            "description": "Expected current version ID when updating an existing file; ignored on creation. Omission disables this guard."
          },
          "metadata": {
            "type": "object",
            "additionalProperties": {},
            "description": "Optional durable file-version metadata for source provenance; service-owned visibility keys are rejected."
          },
          "expected_absent": {
            "type": "boolean",
            "description": "True requires absence atomically when creating; an existing file returns 409. False or omission retains upsert behavior."
          }
        },
        "required": [
          "content"
        ],
        "additionalProperties": false
      }
    }
  }
}

Responses

200

File updated successfully

json
{
  "description": "File updated successfully",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Path-derived file identifier."
          },
          "file_id": {
            "type": "string",
            "description": "Alias for id; canonical file identifier committed by this write."
          },
          "path": {
            "type": "string",
            "description": "Normalized stored file path."
          },
          "content": {
            "type": "string",
            "description": "Text supplied by this write request."
          },
          "size": {
            "type": "number",
            "description": "Size of the file content encoded as UTF-8, in bytes."
          },
          "updated_at": {
            "type": "string",
            "description": "Response timestamp for the successful update."
          },
          "version_id": {
            "type": "string",
            "description": "Version ID the write produced."
          },
          "type": {
            "type": "string",
            "enum": [
              "page",
              "function",
              "component",
              "file"
            ],
            "description": "File kind: page, function, component or file."
          },
          "size_bytes": {
            "type": "number",
            "description": "Size of the content encoded as UTF-8, in bytes."
          },
          "checksum": {
            "type": [
              "string",
              "null"
            ],
            "description": "SHA-256 content hash, or null when unavailable."
          }
        },
        "required": [
          "id",
          "file_id",
          "path",
          "content",
          "size",
          "updated_at"
        ]
      }
    }
  }
}

201

File created successfully

json
{
  "description": "File created successfully",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Path-derived file identifier."
          },
          "file_id": {
            "type": "string",
            "description": "Alias for id; canonical file identifier committed by this write."
          },
          "path": {
            "type": "string",
            "description": "Normalized stored file path."
          },
          "content": {
            "type": "string",
            "description": "Text supplied by this write request."
          },
          "size": {
            "type": "number",
            "description": "Size of the file content encoded as UTF-8, in bytes."
          },
          "created_at": {
            "type": "string",
            "description": "Response timestamp for successful creation."
          },
          "updated_at": {
            "type": "string",
            "description": "Same instant as created_at."
          },
          "version_id": {
            "type": "string",
            "description": "Version ID the write produced."
          },
          "type": {
            "type": "string",
            "enum": [
              "page",
              "function",
              "component",
              "file"
            ],
            "description": "File kind: page, function, component or file."
          },
          "size_bytes": {
            "type": "number",
            "description": "Size of the content encoded as UTF-8, in bytes."
          },
          "checksum": {
            "type": [
              "string",
              "null"
            ],
            "description": "SHA-256 content hash, or null when unavailable."
          }
        },
        "required": [
          "id",
          "file_id",
          "path",
          "content",
          "size",
          "created_at"
        ]
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

403

Forbidden

json
{
  "description": "Forbidden",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Not found

json
{
  "description": "Not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

409

Conflict

json
{
  "description": "Conflict",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/schemas/Problem

json
{
  "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

json
{
  "operationId": "writeFile",
  "tags": [
    "projects/Files/Files"
  ],
  "summary": "Write file",
  "description": "Create a file or replace its content. Requires project.files.write.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "description": "Project slug, UUID, or domain"
      },
      "required": true,
      "name": "project_reference",
      "in": "path"
    },
    {
      "schema": {
        "type": "string",
        "description": "File path (URL-encoded, for example, pages%2Findex.mdx)."
      },
      "required": true,
      "name": "file_path",
      "in": "path"
    },
    {
      "schema": {
        "type": "string",
        "description": "Mutable content to address: main or branch:<name-or-id>. Omit for main. Release and environment selectors return 400. Supplied aliases must name the same content.",
        "example": "branch:feature-x"
      },
      "required": false,
      "name": "ref",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "description": "Branch name or ID; legacy alias for ref=branch:<value>. Supplied aliases must agree."
      },
      "required": false,
      "name": "branch",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "format": "uuid",
        "description": "Branch UUID; legacy alias for ref=branch:<uuid>. Supplied aliases must agree."
      },
      "required": false,
      "name": "branch_id",
      "in": "query"
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "content": {
              "type": "string",
              "description": "Replacement textual content in main or the selected branch, stored as a new immutable version. Source-file MIME type is not writable."
            },
            "expected_checksum": {
              "type": "string",
              "description": "Expected current checksum when updating an existing file; ignored on creation. Omission disables this guard."
            },
            "expected_version_id": {
              "type": "string",
              "description": "Expected current version ID when updating an existing file; ignored on creation. Omission disables this guard."
            },
            "metadata": {
              "type": "object",
              "additionalProperties": {},
              "description": "Optional durable file-version metadata for source provenance; service-owned visibility keys are rejected."
            },
            "expected_absent": {
              "type": "boolean",
              "description": "True requires absence atomically when creating; an existing file returns 409. False or omission retains upsert behavior."
            }
          },
          "required": [
            "content"
          ],
          "additionalProperties": false
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "File updated successfully",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Path-derived file identifier."
              },
              "file_id": {
                "type": "string",
                "description": "Alias for id; canonical file identifier committed by this write."
              },
              "path": {
                "type": "string",
                "description": "Normalized stored file path."
              },
              "content": {
                "type": "string",
                "description": "Text supplied by this write request."
              },
              "size": {
                "type": "number",
                "description": "Size of the file content encoded as UTF-8, in bytes."
              },
              "updated_at": {
                "type": "string",
                "description": "Response timestamp for the successful update."
              },
              "version_id": {
                "type": "string",
                "description": "Version ID the write produced."
              },
              "type": {
                "type": "string",
                "enum": [
                  "page",
                  "function",
                  "component",
                  "file"
                ],
                "description": "File kind: page, function, component or file."
              },
              "size_bytes": {
                "type": "number",
                "description": "Size of the content encoded as UTF-8, in bytes."
              },
              "checksum": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "SHA-256 content hash, or null when unavailable."
              }
            },
            "required": [
              "id",
              "file_id",
              "path",
              "content",
              "size",
              "updated_at"
            ]
          }
        }
      }
    },
    "201": {
      "description": "File created successfully",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Path-derived file identifier."
              },
              "file_id": {
                "type": "string",
                "description": "Alias for id; canonical file identifier committed by this write."
              },
              "path": {
                "type": "string",
                "description": "Normalized stored file path."
              },
              "content": {
                "type": "string",
                "description": "Text supplied by this write request."
              },
              "size": {
                "type": "number",
                "description": "Size of the file content encoded as UTF-8, in bytes."
              },
              "created_at": {
                "type": "string",
                "description": "Response timestamp for successful creation."
              },
              "updated_at": {
                "type": "string",
                "description": "Same instant as created_at."
              },
              "version_id": {
                "type": "string",
                "description": "Version ID the write produced."
              },
              "type": {
                "type": "string",
                "enum": [
                  "page",
                  "function",
                  "component",
                  "file"
                ],
                "description": "File kind: page, function, component or file."
              },
              "size_bytes": {
                "type": "number",
                "description": "Size of the content encoded as UTF-8, in bytes."
              },
              "checksum": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "SHA-256 content hash, or null when unavailable."
              }
            },
            "required": [
              "id",
              "file_id",
              "path",
              "content",
              "size",
              "created_at"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "409": {
      "description": "Conflict",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project Files",
  "x-canonical-documentation": {
    "domain": "projects",
    "resource": "Files",
    "subgroup": "Files",
    "name": "Write file",
    "description": "Create a file or replace its content. Requires project.files.write.",
    "operationId": "writeFile"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/projects-files-files/write-file"
  }
}