Host install tokens

Download schema

Tokens the agent's installer uses to register servers as hosts of the team. One token can register a whole fleet until it expires after 7 days or is revoked; hosts that registered keep reporting either way.

List install tokens

GET

https://api.spectate.net/v1

/host-install-tokens

Returns the tokens that can still register hosts, newest first. Expired tokens aren't listed.

List install tokens › query Parameters

page

integer

Page number, from 1.

Default: 1

per_page

integer

Tokens per page, 1 to 100.

Default: 25

List install tokens › Responses

Paginated set of HostInstallToken

current_page

integer · min: 1 · required

HostInstallToken[] · required

first_page_url

string | null · required

from

integer | null · min: 1 · required

last_page_url

string | null · required

last_page

integer · min: 1 · required

object[] · required

Generated paginator links.

next_page_url

string | null · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

prev_page_url

string | null · required

to

integer | null · min: 1 · required

Number of the last item in the slice.

total

integer · min: 0 · required

Total number of items being paginated.

Create an install token

POST

https://api.spectate.net/v1

/host-install-tokens

The token is valid for 7 days. Give it to the agent's installer; Hosts → Add host in the dashboard shows the full command for each platform.

Create an install token › Responses

The new install token.

An install token: agents use it to register hosts with the team. Any number of hosts can use one token until it expires or is revoked.

HostInstallToken

id

string · uuid · required

Install token ID

token

string · required

The token to give the agent's installer (--token)

Example: hct_0b7c…

expires_at

string | null · date-time · required

When the token stops registering new hosts. Hosts that registered keep reporting

created_at

string · date-time · required

When the token was created

Revoke an install token

DELETE

https://api.spectate.net/v1

/host-install-tokens/{token}

No new hosts can register with it. Hosts that registered with it keep reporting.

Revoke an install token › path Parameters

token

string · uuid · required

Install token ID.

Revoke an install token › Responses

No content

No data returned

Hosts Metric conditions