synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
de0601d611240fb583c5311fac52d65e45a3542f
coder/docs/api/files.md
Marcin Tojek e67d131514 docs: audit, deploymentconfig, files, parameters (#5506) 
* docs: audit, deploymentconfig, files, parameters

* Fix: mark as binary

* Fix: show format in docs

* Fix: use .swaggo

* Fix: swagger notice

* Swagger notice
2023-01-03 19:21:10 +01:00

2.3 KiB
Raw Blame History

Files

This page is incomplete, stay tuned.

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
body body object true
» file body binary true File to be uploaded

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 by means of one of the following methods: CoderSessionToken.

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 by means of one of the following methods: CoderSessionToken.