File service v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
A sample API
Base URLs:
Default
get__
GET /
Get file from the home directory
Example responses
403 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 403 | Forbidden | none | Inline |
| 404 | Not Found | none | Inline |
| 500 | Internal Server Error | none | Inline |
Response Schema
Status Code 403
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
Status Code 404
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
Status Code 500
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | any | false | none | none |
post__
POST /
Upload a file at a given path
Body parameter
Example responses
200 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 403 | Forbidden | none | Inline |
| 500 | Internal Server Error | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
Status Code 403
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
Status Code 500
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
delete__
DELETE /
Remove a given file wich is present in home directory
Body parameter
{
"myFilename": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | false | none |
| » myFilename | body | string | true | none |
Example responses
200 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 400 | Bad Request | none | Inline |
| 403 | Forbidden | none | Inline |
| 404 | Not Found | none | Inline |
| 500 | Internal Server Error | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
Status Code 400
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
Status Code 403
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
Status Code 404
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | string | false | none | none |
Status Code 500
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » code | integer | false | none | none |
| » data | strin | false | none | none |
get__directory_list
GET /directory/list
List files in a given directory
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| directoryName | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| default | Default | Default response | None |