Create a public data export

POST https://chat.hcics.simtech.uni-stuttgart.de/api/v1/export/realm

Create a public data export of the organization.

Changes: New in Zulip 2.1.

Usage examples

#!/usr/bin/env python

import zulip

# The user for this zuliprc file must be an organization administrator
client = zulip.Client(config_file="~/zuliprc-admin")

# Create a public data export of the organization.
result = client.call_endpoint(url="/export/realm", method="POST")
print(result)

curl -sSX POST https://chat.hcics.simtech.uni-stuttgart.de/api/v1/export/realm \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

• id: integer

  The ID of the public data export created.

  Changes: New in Zulip 7.0 (feature level 182).

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "id": 1,
    "msg": "",
    "result": "success"
}

An example JSON error response for when the public data export exceeds the maximum allowed data export size.

{
    "code": "BAD_REQUEST",
    "msg": "Please request a manual export from zulip-admin@example.com.",
    "result": "error"
}