DocumentationAPI reference

Rust · 0.1.0

Export Memos

GET /api/v1/users/{user}:exportMemos

UserService · UserService_ExportMemos

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Owner-only: the user named in the path must be the authenticated caller. Instance administrator status does not allow acting on another account here.

Save the raw archive

Success returns raw ZIP bytes, including the user's own comments, archived memos and attachment files. Do not call response.json() or expect a HttpBody JSON wrapper. The declared */* media type is underspecified; follow the actual Content-Type. MEMOS_USERNAME below is the current account's username. Store the archive privately, since it can include private content.

curl --fail-with-body \
  -H "Authorization: Bearer $MEMOS_TOKEN" \
  --output memos-export.zip \
  "$MEMOS_URL/api/v1/users/$MEMOS_USERNAME:exportMemos"

Request

ExportMemos writes every memo the user created, with comments, archived memos, and attachment files, as a Memos export file (a ZIP file, see docs/design/memos-export-format.md). Only the user may export their own memos. The body is the archive; content_type is its media type.

GET/api/v1/users/{user}:exportMemos

Parameters

Name / locationType / requirementDescription
user
path
string
Required
The user id.

Request body

No request body is declared.

Responses

200 · OK

*/* · —

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition
{
  "tags": [
    "UserService"
  ],
  "description": "ExportMemos writes every memo the user created, with comments, archived\n memos, and attachment files, as a Memos export file (a ZIP file, see\n docs/design/memos-export-format.md). Only the user may export their own\n memos. The body is the archive; content_type is its media type.",
  "operationId": "UserService_ExportMemos",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "*/*": {}
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}