Create a Site

Request

Create a new site.

Security

ApiKey(Required scopes: sites.create)

Bodyapplication/jsonrequired

namestringrequired

A name for this site

typestringrequired

The type of site to create.

Enum:"self-hosted""edge"

retainRecordingsSecondsnumber, >= 0

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

Payload

{
  "name": "string",
  "type": "self-hosted",
  "retainRecordingsSeconds": 0
}

Responses

The new 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
}