v4

OpenAPI 3.1.02026-08-012402353.8 MB

Create a File Link

post/file_links

Request body

expires_atstring date-time

The time at which the File Link will expire. The default is 1 hour from the time of the request. The maximum is 1 day from the time of the request.

file_idstring required

The File to create a File Link for.

Example request

{
  "file_id": "file_makxrc67oh9l6sg7w9yc"
}

Response

File Link

created_atstring date-time required

The ISO 8601 time at which the File Link was created.

expires_atstring date-time required

The ISO 8601 time at which the File Link will expire.

file_idstring required

The identifier of the File the File Link points to.

idstring required

The File Link identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

type'file_link' required

A constant representing the object's type. For this resource it will always be file_link.

unauthenticated_urlstring required

A URL where the File can be downloaded. The URL will expire after the expires_at time. This URL is unauthenticated and can be used to download the File without an Increase API key.

Example response

{
  "created_at": "2020-01-31T23:59:59Z",
  "expires_at": "2020-01-31T23:59:59Z",
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "file_link_roapsuicj7kp1lzyus04",
  "idempotency_key": null,
  "type": "file_link",
  "unauthenticated_url": "https://example.com/file.pdf"
}