Sites

A site is a logical grouping of storage and compute for storing Recording data.

Operations

List sites

Request

Retrieve a list of sites.

Security

ApiKey(Required scopes: sites.list)

Payload

// No request payload

Responses

List of sites

Bodyapplication/json

Array [

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
  }
]