Pause, resume, re-time or reconfigure a public link.

PATCH

/dashboards/{id}/shares/{share_id}

curl --request PATCH \
  --url https://api.siteqwality.com/dashboards/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/shares/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "paused": true, "expires_at": "2026-04-15T12:00:00Z", "config": { "allowed_times": [ "example" ], "default_time": "example", "theme": "light", "variables": { "additionalProperty": { "locked": true, "allowed": [ "example" ] } } } }'

• Production

Absent fields are kept; expires_at: null removes the expiry.

Authorizations

• bearer_auth

Parameters

Path Parameters

id

required

string format: uuid

Dashboard id

share_id

required

string format: uuid

Link id

Request Body ^required

Media type application/json

Absent fields are kept; expires_at: null removes the expiry.

object

paused

boolean | null

expires_at

string | null format: date-time

config

One of:

null

null

object

object

allowed_times

Presets a viewer may pick, from 15m 1h 4h 1d 2d 7d 30d 90d.

Array<string>

default_time

One of allowed_times.

string

theme

string

Allowed values: light dark auto

variables

object

key

additional properties

How a public viewer may use one variable. A variable the share does not list is locked to the dashboard default.

object

locked

boolean

allowed

The values a viewer may pick; null allows every value (and All when the variable includes it).

array | null

Responses

200

The link

Media type application/json

object

id

required

string format: uuid

url_token

required

The capability in https://app.siteqwality.com/share/d/<token>.

string

config

required

object

allowed_times

Presets a viewer may pick, from 15m 1h 4h 1d 2d 7d 30d 90d.

Array<string>

default_time

One of allowed_times.

string

theme

string

Allowed values: light dark auto

variables

object

key

additional properties

How a public viewer may use one variable. A variable the share does not list is locked to the dashboard default.

object

locked

boolean

allowed

The values a viewer may pick; null allows every value (and All when the variable includes it).

array | null

paused

required

boolean

expires_at

string | null format: date-time

created_by

One of:

null

null

object

The member who made a change.

object

id

required

string format: uuid

name

string | null

email

required

string

created_at

required

string format: date-time

last_accessed_at

string | null format: date-time

access_count

required

integer format: int64

Example

{
  "config": {
    "theme": "light"
  }
}

400

Invalid settings

401

Missing or invalid authentication

403

Locked, the caller cannot edit dashboards, or is a connected app

404

No such dashboard or link

500

Internal server error