Interface UriLink

A URI link as returned by the shard (public view, no token).

interface UriLink {
    action: UriLinkAction;
    createdAt: string;
    createdByKeyId: string;
    expiresAt: string;
    id: string;
    lastUsedAt: string;
    maxUses: number;
    name: string;
    revokedAt: string;
    target: UriLinkTarget;
    useCount: number;
}

Properties

action createdAt createdByKeyId expiresAt id lastUsedAt maxUses name revokedAt target useCount

Properties

action

action: UriLinkAction

Action the link performs when resolved.

createdAt

createdAt: string

ISO timestamp when the link was created.

createdByKeyId

createdByKeyId: string

Identifier of the API key that created the link.

expiresAt

expiresAt: string

ISO timestamp when the link expires.

id

id: string

Unique identifier of the link.

lastUsedAt

lastUsedAt: string

ISO timestamp when the link was last used.

maxUses

maxUses: number

Maximum number of times the link can be used.

name

name: string

Human-readable name for the link.

revokedAt

revokedAt: string

ISO timestamp when the link was revoked.

target

target: UriLinkTarget

Target configuration for the action.

useCount

useCount: number

Number of times the link has been used.

Settings

Member Visibility

On This Page

Properties