The Plan

GET

/plan

Code sample: Shell / cURL

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

The Organization’s Plan: its name, what it allows and what is in use.

Authorizations

• apiToken

Responses

200

The Plan.

Media typeapplication/json

The Organization’s Plan.

object

name

required

string

version

required

The Plan’s version, such as free.v1.

string

limits

required

What the Plan allows of each.

object

projects

required

integer

monitors

required

integer

heartbeats

required

integer

locations

required

Locations one Monitor may be checked from.

integer

used

required

What the Organization has in use of each. locations is the most any Monitor uses.

object

projects

required

integer

monitors

required

integer

heartbeats

required

integer

locations

required

Locations one Monitor may be checked from.

integer

Example ^generated

{
  "name": "example",
  "version": "example",
  "limits": {
    "projects": 1,
    "monitors": 1,
    "heartbeats": 1,
    "locations": 1
  },
  "used": {
    "projects": 1,
    "monitors": 1,
    "heartbeats": 1,
    "locations": 1
  }
}

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

404

No such thing, or not one this token reaches: not_found.

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