Files

Move/Rename file

Move or rename a file within the repository and commit the change.

patch/api/repos/{namespace}/{repo_name}/file/{resource}

Request

Path parameters

namespacestring required

Namespace of the repository

repo_namestring required

Name of the repository

resourcestring required

Path to the source file (including branch)

Request body

emailstring nullable
messagestring nullable
namestring nullable
new_pathstring required

Example request

{
  "email": "bessie@oxen.ai",
  "message": "Renamed file to new location",
  "name": "bessie",
  "new_path": "new/path/to/file.txt"
}

Response

File moved/renamed successfully

oxen_versionstring nullable
statusstring required
status_messagestring required

Example response

{
  "commit": {
    "author": "ox",
    "email": "ox@example.com",
    "id": "a1b2c3d4e5f67890abcdef1234567890",
    "message": "Refactor data loading pipeline.",
    "parent_ids": [
      "f1e2d3c4b5a67890fedcba9876543210"
    ],
    "timestamp": "2025-01-01T10:00:00Z"
  },
  "status": "success",
  "status_message": "resource_found"
}

Changes

No recorded changes to this operation across all 1 revision of this API.