Links API Link Parameters

Name

A nice name for the link.
Max length 64. Optional.

Description

Additional information.
Max length 256. Optional.

Source

The short link.
Min length 1, max length 32. Required.

Target

The short link target. It is not necessary to include the protocol.
Min length 1, max length 256. Required.

Secure

The HTTP protocol to use, false for HTTP or true for HTTPS.
Optional. Defaults to HTTPS

Permanent

Specifies if the link should declared as permanent (true), response code 301, or temporary (false), response code 302.
Optional. Defaults to temporary, response code 302.

Active

A link may be specified and remain inactive (false) until set otherwise.
Optional. Defaults to active (true).

Expire

A date and time may be supplied after which the short link will no longer be available.
Optional. Defaults to indefinite.