GET /user_uploads/{realm_id_str}/{filename}

Get a temporary URL for access to an uploaded file that doesn't require authentication.

The SIGNED_ACCESS_TOKEN_VALIDITY_IN_SECONDS server setting controls the valid length of time for temporary access, which generally is set to a default of 60 seconds. Consumers of this API are expected to immediately request the URL that it returns, and should not store it in any way.

Changes: New in Zulip 3.0 (feature level 1).

Servers

Path parameters

Name Type Required Description
realm_id_str Integer Yes

The realm ID component of the file's path_id. If the path_id is 1/4e/m2A3MSqFnWRLUf9SaPzQ0Up_/zulip.txt, the realm_id_str would be 1.

filename String Yes

The file path component of the file's path_id (everything after the first /). If the path_id is 1/4e/m2A3MSqFnWRLUf9SaPzQ0Up_/zulip.txt, the filename would be 4e/m2A3MSqFnWRLUf9SaPzQ0Up_/zulip.txt.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.