Locations

GET

/locations

Code sample: Shell / cURL

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

The locations a new Monitor can be checked from now, the least used first. A Monitor’s locations names them by id.

Authorizations

• apiToken

Responses

200

The locations.

Media typeapplication/json

The locations a new Monitor can be checked from now, the least used first.

object

data

required

Array<object>

A place a Monitor can be checked from.

object

id

required

What a Monitor’s locations names, such as de.

string

city

required

string

country

required

The country, as an ISO 3166-1 alpha-2 code.

string | null

next

required

Pass it as cursor for the next page. Null on the last page.

string | null

Example ^generated

{
  "data": [
    {
      "id": "example",
      "city": "example",
      "country": "example"
    }
  ],
  "next": "example"
}

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

403

This token may not do this: forbidden.

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