mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:45:56 +00:00
e67d131514
* docs: audit, deploymentconfig, files, parameters * Fix: mark as binary * Fix: show format in docs * Fix: use .swaggo * Fix: swagger notice * Swagger notice
76 lines
2.3 KiB
Markdown
76 lines
2.3 KiB
Markdown
# Files
|
|
|
|
> This page is incomplete, stay tuned.
|
|
|
|
## Upload file
|
|
|
|
### Code samples
|
|
|
|
```shell
|
|
# 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
|
|
|
|
```yaml
|
|
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
|
|
|
|
```json
|
|
{
|
|
"hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd"
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------------------------ |
|
|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.UploadResponse](schemas.md#codersdkuploadresponse) |
|
|
|
|
To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
|
|
|
|
## Get file by ID
|
|
|
|
### Code samples
|
|
|
|
```shell
|
|
# 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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
|
|
|
|
To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
|