> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cloudraker.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server. # Archive a file POST /api/projects/{projectId}/files/{fileId}/archive Soft-archives a file (recoverable). Requires `project:manage` on the project. Reference: https://docs.cloudraker.com/api/raker-one-api/files/post-projects-by-project-id-files-by-file-id-archive ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: RakerOne API version: 1.0.0 paths: /projects/{projectId}/files/{fileId}/archive: post: operationId: post-projects-by-project-id-files-by-file-id-archive summary: Archive a file description: >- Soft-archives a file (recoverable). Requires `project:manage` on the project. tags: - subpackage_files parameters: - name: projectId in: path required: true schema: type: string - name: fileId in: path required: true schema: type: string - name: Authorization in: header description: >- WorkOS session JWT or an organization API key, sent as `Authorization: Bearer `. required: true schema: type: string responses: '200': description: The archived file. content: application/json: schema: $ref: '#/components/schemas/FileResponse' '401': description: Unauthorized — missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden — the caller lacks the required permission. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' servers: - url: /api description: Current origin - url: https://app.raker.one/api description: Production components: schemas: File: type: object properties: _id: type: string projectId: type: string filename: type: string mimeType: type: string sizeBytes: type: number format: double r2Key: type: string thumbnailR2Key: type: - string - 'null' uploadedBy: type: string uploadedAt: type: string usedInRunIds: type: array items: type: string uploadedInRunId: type: - string - 'null' derivedFromFileId: type: - string - 'null' folderId: type: - string - 'null' tags: type: array items: type: string archivedAt: type: - string - 'null' required: - _id - projectId - filename - mimeType - sizeBytes - r2Key - thumbnailR2Key - uploadedBy - uploadedAt - usedInRunIds - uploadedInRunId - derivedFromFileId - tags - archivedAt title: File FileResponse: type: object properties: file: $ref: '#/components/schemas/File' required: - file title: FileResponse ErrorResponse: type: object properties: error: type: string description: Machine-readable error code (e.g. `invalid_body`, `not_found`). issues: type: array items: description: Any type description: Schema-validation issues, present when `error` is `invalid_body`. required: - error description: Standard API error response. title: ErrorResponse securitySchemes: bearerAuth: type: http scheme: bearer description: >- WorkOS session JWT or an organization API key, sent as `Authorization: Bearer `. ``` ## Examples **Request** ```json {} ``` **Response** ```json { "file": { "_id": "a3f1c9d2-4b7e-4f3a-9d2e-8b7c6f1a2d3e", "projectId": "proj_9876543210", "filename": "design_specifications_v2.pdf", "mimeType": "application/pdf", "sizeBytes": 245760, "r2Key": "files/proj_9876543210/a3f1c9d2-4b7e-4f3a-9d2e-8b7c6f1a2d3e.pdf", "thumbnailR2Key": null, "uploadedBy": "user_1234567890", "uploadedAt": "2024-05-20T15:45:00Z", "usedInRunIds": [ "run_20240520_001" ], "uploadedInRunId": "run_20240519_007", "derivedFromFileId": null, "tags": [ "specifications", "design", "v2" ], "archivedAt": "2024-06-01T10:00:00Z", "folderId": "folder_4567891230" } } ``` **SDK Code** ```python import requests url = "https://api/projects/projectId/files/fileId/archive" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api/projects/projectId/files/fileId/archive'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api/projects/projectId/files/fileId/archive" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api/projects/projectId/files/fileId/archive") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api/projects/projectId/files/fileId/archive") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://api/projects/projectId/files/fileId/archive', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api/projects/projectId/files/fileId/archive"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api/projects/projectId/files/fileId/archive")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```