Files
Upload file
Code samples
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/files \
-H 'Accept: application/json' \
-H 'Content-Type: application/x-tar' \
-H 'Coder-Session-Token: API_KEY'
POST /files
Body parameter
file: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Content-Type | header | string | true | Content-Type must be application/x-tar or application/zip |
body | body | object | true | |
» file | body | binary | true | File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems). |
Example responses
201 Response
{
"hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | codersdk.UploadResponse |
To perform this operation, you must be authenticated. Learn more.
Get file by ID
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/files/{fileID} \
-H 'Coder-Session-Token: API_KEY'
GET /files/{fileID}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
fileID | path | string(uuid) | true | File ID |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK |
To perform this operation, you must be authenticated. Learn more.
See an opportunity to improve our docs? Make an edit.
On this page