Documentation | Sites › Update Site Details

API Reference

Sites

sites

Methods

List Sites -> Array<

Site

get/sites

Retrieve a list of sites.

Create A Site ->

Site

post/sites

Create a new site.

Get Site Details ->

Site

get/sites/{id}

Get details for a specific site.

Update Site Details ->

Site

patch/sites/{id}

Update the name or retention period for a Site.

path Parameters

id: string

Response fields

Site

Request example

curl https://api.foxglove.dev/v1/sites/$ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FOXGLOVE_API_KEY" \
    -d '{}'

200Example

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

Delete A Site -> { id }

delete/sites/{id}

Delete a site.

NOTE: Site deletion is permanent and cannot be undone. Any recordings stored at this site will no longer be available through Foxglove.

For edge and self-hosted sites, you should shut down your deployment before deleting the site through the API.

If the site type is self-hosted, the contents of your inbox and lake buckets will not be affected by this action, and should be cleaned up separately after deleting the site.

If the site type is edge, any files in edge storage will not be affected by this action.

Domain types

Site = { id, name, type, 2 more... }

Sites

Inbox Notification Tokens

sites.inbox_notification_tokens

Methods

List Inbox Notification Tokens -> Array<

InboxNotificationToken

get/site-inbox-notification-tokens

List inbox notification tokens

Create A Site Inbox Notification Token ->

InboxNotificationToken

post/site-inbox-notification-tokens

This endpoint returns a token which can be used to authenticate push notifications from your inbox bucket to the Foxglove API. This token should be used as a query argument to the /endpoints/inbox-notifications route of this domain, eg.

https://api.foxglove.dev/endpoints/inbox-notifications?token=<token>

See the Primary Site Installation documentation for more details.

Delete An Inbox Notification Token -> { id }

delete/site-inbox-notification-tokens/{id}

Delete an inbox notification token

Domain types

InboxNotificationToken = { id, createdAt, orgId, 1 more... }

An inbox notification token identifies a site to the inbox-notifications endpoint.

Sites

Tokens

sites.tokens

Methods

List Site Tokens -> Array<

SiteToken

get/site-tokens

List site tokens

Create A Site Token ->

SiteToken

post/site-tokens

Create a site token

Delete A Site Token -> { success }

delete/site-tokens/{id}

Delete a site token

Domain types

SiteToken = { id, createdAt, siteId }

A SiteToken resource provides site controllers with authentication to the api.