Get attachment public URL

GET

/api/v1/attachments/{attachmentId}/url

const url = 'https://localhost:10001/api/v1/attachments/1/url';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://localhost:10001/api/v1/attachments/1/url \
  --header 'Authorization: <Authorization>'

Generate a time-limited public URL for the attachment file

Authorizations

BearerAuth

Parameters

Path Parameters

attachmentId

required

integer

Attachment ID

Query Parameters

expiration

integer

Expiration in minutes (default: 60)

Responses

200

Signed URL and its expiration window

application/json

A time-limited signed URL for an attachment, and how long it stays valid

object

expiresIn

Rendered as ” minutes”, not a number

string

url

string

Example

{
  "expiresIn": "60 minutes"
}

400

Bad request - Invalid attachment ID or expiration time

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

401

Unauthorized - Missing or invalid token

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

404

Attachment not found

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

500

Internal server error

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}