The token that asks

GET

/token

Code sample: Shell / cURL

curl --request GET \
  --url https://api.uup.dev/v1/token \
  --header 'Authorization: Bearer <token>'

This token’s name, kind, what it reaches and when it stops working.

Authorizations

• apiToken

Responses

200

This token.

Media typeapplication/json

The API token that made this request.

object

id

required

The token’s identifier, tok_….

string

name

required

string

kind

required

read_only reads and changes nothing; full also makes changes.

string

Allowed values: read_only full

organizationId

required

The Organization that holds it, org_….

string

projectId

required

The one Project it reaches, or null for every Project.

string | null

createdAt

required

When it was made.

string format: date-time

expiresAt

required

When it stops working, or null for never.

string | null format: date-time

Example

{
  "kind": "read_only"
}

401

No working API token: unauthenticated.

Media typeapplication/json

A refusal.

object

error

required

object

code

required

What was refused, stable across releases. New codes may be added, so handle a code you do not know as its status says.

string

Allowed values: invalid_request bad_identifier unauthenticated forbidden not_found not_entitled rate_limited interval_below_floor timeout_below_floor url_missing check_not_applicable port_blocked target_cap_reached too_few_locations location_unavailable uptime_always_on monitor_busy monitor_suspended project_suspended validation_required validation_unavailable validation_rate_limited validation_expired validation_mismatch validation_failed default_rule_is_fixed name_taken paid_needs_email paid_rule_sends_nothing webhook_url_refused address_refused event_type_not_on_monitor too_many_webhooks url_taken

message

required

What to do, in the dashboard’s words. It may change, so never branch on it.

string

field

The field at fault, on a 400 invalid_request.

string

kind

On a 402 not_entitled: what the Plan allows no more of.

string

Allowed values: project monitor heartbeat location

plan

On a 402: the Plan’s name.

string

limit

On a 402: what the Plan allows. On a 422 target_cap_reached: the cap’s figure.

integer

used

On a 402: what is in use, or for locations, how many were asked.

integer

cap

On a 422 target_cap_reached: which cap the Monitor would pass.

string

key

On a 422 target_cap_reached: the site the cap counts, by its host.

string

location

On a 422 target_cap_reached: the location the cap was reached from.

string

current

On a 422 target_cap_reached: what the cap counts now, before this Monitor.

integer

rules

On a 409 paid_needs_email: the names of the saved rules it would break.

Array<string>

eventTypes

On a 400 event_type_not_on_monitor: the events this Monitor never sends.

Array<string>

Example

{
  "error": {
    "code": "invalid_request",
    "kind": "project"
  }
}

429

Too many requests: rate_limited. Retry-After says when to try again.

Media typeapplication/json

A refusal.

object

error

required

object

code

required

What was refused, stable across releases. New codes may be added, so handle a code you do not know as its status says.

string

Allowed values: invalid_request bad_identifier unauthenticated forbidden not_found not_entitled rate_limited interval_below_floor timeout_below_floor url_missing check_not_applicable port_blocked target_cap_reached too_few_locations location_unavailable uptime_always_on monitor_busy monitor_suspended project_suspended validation_required validation_unavailable validation_rate_limited validation_expired validation_mismatch validation_failed default_rule_is_fixed name_taken paid_needs_email paid_rule_sends_nothing webhook_url_refused address_refused event_type_not_on_monitor too_many_webhooks url_taken

message

required

What to do, in the dashboard’s words. It may change, so never branch on it.

string

field

The field at fault, on a 400 invalid_request.

string

kind

On a 402 not_entitled: what the Plan allows no more of.

string

Allowed values: project monitor heartbeat location

plan

On a 402: the Plan’s name.

string

limit

On a 402: what the Plan allows. On a 422 target_cap_reached: the cap’s figure.

integer

used

On a 402: what is in use, or for locations, how many were asked.

integer

cap

On a 422 target_cap_reached: which cap the Monitor would pass.

string

key

On a 422 target_cap_reached: the site the cap counts, by its host.

string

location

On a 422 target_cap_reached: the location the cap was reached from.

string

current

On a 422 target_cap_reached: what the cap counts now, before this Monitor.

integer

rules

On a 409 paid_needs_email: the names of the saved rules it would break.

Array<string>

eventTypes

On a 400 event_type_not_on_monitor: the events this Monitor never sends.

Array<string>

Example

{
  "error": {
    "code": "invalid_request",
    "kind": "project"
  }
}