mirror of
https://github.com/mattermost/mattermost.git
synced 2026-05-28 04:35:04 -04:00
55496c07c1
* Update API docs * Coderabbit comments * Address feedback * Address feedback * Coderabbit feedback
126 lines
3.3 KiB
YAML
126 lines
3.3 KiB
YAML
"/api/v4/exports":
|
|
get:
|
|
tags:
|
|
- exports
|
|
summary: List export files
|
|
description: >
|
|
Lists all available export files.
|
|
|
|
__Minimum server version__: 5.33
|
|
|
|
##### Permissions
|
|
|
|
Must have `manage_system` permissions.
|
|
operationId: ListExports
|
|
responses:
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"/api/v4/exports/{export_name}":
|
|
get:
|
|
tags:
|
|
- exports
|
|
summary: Download an export file
|
|
description: |
|
|
Downloads an export file.
|
|
|
|
|
|
__Minimum server version__: 5.33
|
|
|
|
##### Permissions
|
|
|
|
Must have `manage_system` permissions.
|
|
operationId: DownloadExport
|
|
parameters:
|
|
- name: export_name
|
|
in: path
|
|
description: The name of the export file to download
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
delete:
|
|
tags:
|
|
- exports
|
|
summary: Delete an export file
|
|
description: |
|
|
Deletes an export file.
|
|
|
|
|
|
__Minimum server version__: 5.33
|
|
|
|
##### Permissions
|
|
|
|
Must have `manage_system` permissions.
|
|
operationId: DeleteExport
|
|
parameters:
|
|
- name: export_name
|
|
in: path
|
|
description: The name of the export file to delete
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"/api/v4/exports/{export_name}/presign-url":
|
|
post:
|
|
tags:
|
|
- exports
|
|
summary: Create a presigned URL for export download
|
|
description: |
|
|
Creates a presigned URL for downloading an export file.
|
|
|
|
__Minimum server version__: 5.33
|
|
|
|
##### Permissions
|
|
Must have `manage_system` permission.
|
|
operationId: PresignExport
|
|
parameters:
|
|
- name: export_name
|
|
in: path
|
|
description: The name of the export file
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Presigned URL created successfully
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
url:
|
|
type: string
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|