Create a signed file URL
Return a URL at the access endpoint of the sandbox that downloads (GET) or uploads (PUT) one file without other credentials, for at most 15 minutes. A GET URL with format downloads the tree at path as an archive instead, like GET files/archive without exclude. GET needs read access, PUT and user need write access. A change to the access of the caller or to the shares of the sandbox ends the URL. A PUT URL uploads once.
Authorization
apiKey API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.
In: header
Path Parameters
Sandbox ID (ULID)
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Seconds until the URL expires
int641 <= value <= 900300GET only: download the tree at path as an archive in this format, like GET files/archive, instead of one file
Value in
- "tar"
- "tar.gz"
GET downloads (HEAD works too), PUT uploads once
Value in
- "GET"
- "PUT"
Path in the sandbox: absolute, or relative to the sandbox working directory
1 <= lengthGuest user to run as, by name or uid; defaults to the image user. Needs write access to the sandbox
^[a-z_][a-z0-9_-]{0,31}$|^[0-9]{1,10}$Response Body
application/json
application/problem+json
curl -X POST "https://example.com/v1/sandboxes/string/files/signed-url" \ -H "Content-Type: application/json" \ -d '{ "method": "GET", "path": "string" }'{ "expires_at": "2019-08-24T14:15:22Z", "method": "string", "single_use": true, "url": "string"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}Create a scoped access token POST
Return a bearer token for the access endpoint of the sandbox. It allows the given actions on this sandbox only, for 15 minutes, and only while the caller keeps its access: a change to the roles or the API keys of the caller ends it. Use it where access_credentials of the sandbox does not list the credential that you hold, for example from the console. Needs read access to the sandbox.
Delete a file or directory DELETE
Delete the entry at `path`. - A non-empty directory needs `recursive=true`, else 409 `directory_not_empty`. - A recursive delete removes a directory symlink and never follows it. - Runs in the sandbox as the image user, or as `user` when set. Setting `user` needs write access to the sandbox. - Served at the access endpoint of the sandbox (`access_endpoint` of `GET /v1/sandboxes/{sandboxId}`), not at the API host. - A paused sandbox returns 409, unless `resume=true`. A sandbox that started before its files server existed returns 409 `sandbox_update_required` until it restarts. - A refused operation returns its code as the problem type. - A path that starts with `~` or `~/` names the home directory of the user that the operation runs as. `~name` returns 422.