Update site details

Request

Update the name or retention period for a Site.

Security

ApiKey(Required scopes: sites.update)

Path

idstringrequired

Site ID

Bodyapplication/jsonrequired

namestring

A name for this site

retainRecordingsSecondsnumber

Optionally set a retention period for recordings created at this Edge Site. If set to zero, recordings are retained indefinitely. (only available on Edge Sites)

urlstring

The URL a self-hosted Primary Site exposes for accessing available data. See The self-hosting installation guide for details.

Payload

{
  "name": "string",
  "retainRecordingsSeconds": 0,
  "url": "string"
}

Responses

Updated site

Bodyapplication/json

idstringrequired

Unique identifier for this site

namestringrequired

Name for this site

typestringrequired

The type of the site.

foxglove-hosted: A Foxglove-hosted Primary Site.
self-hosted: A self-hosted Primary Site.
edge: An Edge Site.
byob: A Bring Your Own Storage Site.

Enum:"foxglove-hosted""self-hosted""edge""byob"

urlstring

The REST API endpoint your site deployment exposes (only available for self-hosted Primary Sites).

retainRecordingsSecondsnumber, >= 0

An optional retention period for recordings created at this site. If set to zero, recordings are retained indefinitely. (only available on Edge Sites)

Response

{
  "id": "string",
  "name": "string",
  "type": "foxglove-hosted",
  "url": "string",
  "retainRecordingsSeconds": 0
}