# Form fields

> Every field in the up4 forms: what it does, what the form preselects and which guide explains it.

Source: https://upfour.io/docs/reference/form-fields

Every field under the label the app shows, what it does and what the form preselects. The API field names are in the Per API box of each guide.

## Monitors

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Name | The name shown in lists and alerts. | – | [Watch a website](https://upfour.io/docs/watch-a-website.md) |
| Monitor type | The kind of check: a website, a port, a DNS record or a ping. | – | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#check-types) |
| URL to watch | The address up4 requests. A missing https:// is added for you. | – | [Watch a website](https://upfour.io/docs/watch-a-website.md) |
| Check every | How often up4 checks. Shorter intervals notice an outage sooner and cost more. | 3 minutes in the app; 1 minute through the API | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#intervals) |
| Regions | The regions the checks run from. With several regions, up4 compares them before it alerts. | – | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#regions) |
| Counts as down when | What counts as up: a successful answer, an exact status code, or a word that must or must not appear. | Any 2xx answer | [Check page content](https://upfour.io/docs/check-page-content.md) |
| Text to look for | The word or phrase to look for in the page. Capitals are ignored while Ignore case is on. | – | [Check page content](https://upfour.io/docs/check-page-content.md) |
| Expected status code | The status code the page must answer with, for example for a redirect you want to keep. | – | [Check page content](https://upfour.io/docs/check-page-content.md) |
| HTTP method | The method up4 sends with every check. A keyword check cannot use HEAD, because HEAD returns no page. | GET in the app; HEAD through the API when no method is sent | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#http-checks) |
| Request timeout | How long up4 waits for an answer before the check counts as failed. | 30 seconds, at most 1 minute | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#timeouts) |
| Request body | Data sent with POST, PUT and PATCH checks, up to 8 KB. | – | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#http-checks) |
| Follow redirects | Whether up4 follows redirects to the final page. Off, the redirect itself is the answer. | On | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#http-checks) |
| Keep cookies when redirecting | Keeps cookies set during a redirect chain, for sites that set a cookie before they show the page. | Off | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#http-checks) |
| Verify the TLS certificate | Whether up4 rejects an expired, untrusted or mismatched certificate. Turn it off only for a test server. | On | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#tls-certificates) |
| Certificate expiry warning | Warns you this many days before the certificate expires. Off by default. | Off | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#tls-certificates) |
| Domain expiry warning | Warns you this many days before the domain registration expires. Off by default. | Off | [Checks and regions](https://upfour.io/docs/how/checks-and-regions#tls-certificates) |
| When should we alert you? | Right away alerts once checks confirm an outage. The quiet option skips short blips. | Right away | [When you get alerted](https://upfour.io/docs/how/when-you-get-alerted.md) |
| Alert plan | An alert plan pages people step by step until someone acknowledges, on top of the channels. | – | [Build an alert plan](https://upfour.io/docs/build-an-alert-plan.md) |
| Recovery period | How long the monitor must stay healthy before the outage counts as over. | 60 seconds in the form | [When you get alerted](https://upfour.io/docs/how/when-you-get-alerted.md) |
| Incident screenshots | Takes a screenshot of the page when an incident opens. Counts against a monthly allowance. | – | [Handle an incident](https://upfour.io/docs/handle-an-incident.md) |
| Host | The server up4 connects to. | – | [Check a server, port or DNS record](https://upfour.io/docs/check-server-port-dns.md) |
| Port | The port up4 connects to, from 1 to 65535. | – | [Check a server, port or DNS record](https://upfour.io/docs/check-server-port-dns.md) |
| DNS server | The DNS server up4 asks. Empty uses a public one. | – | [Check a server, port or DNS record](https://upfour.io/docs/check-server-port-dns.md) |
| Record type | The record type to look up: A, AAAA, CNAME, MX, NS or TXT. | A | [Check a server, port or DNS record](https://upfour.io/docs/check-server-port-dns.md) |
| Expected answer | A value the answer must contain. Empty only checks that the name resolves. | – | [Check a server, port or DNS record](https://upfour.io/docs/check-server-port-dns.md) |
| Extra confirmation time | seconds; 0 means no extra wait | 0, no extra wait | – |
| Ignore case | On by default: capitalization is ignored. | – | [Check page content](https://upfour.io/docs/check-page-content.md) |
| Headers | Sent with every check. Up to 20 headers; values are stored encrypted. | – | [Check page content](https://upfour.io/docs/check-page-content.md) |
| Username | User name for basic authentication. | – | [Check page content](https://upfour.io/docs/check-page-content.md) |
| Password | Password for basic authentication. Stored encrypted and never returned. | – | [Check page content](https://upfour.io/docs/check-page-content.md) |
| Proxy | Send the check through your proxy. The port goes into the proxy port field. | – | [Check page content](https://upfour.io/docs/check-page-content.md) |
| IP version | Applies to ping monitors only. | – | [Check a server, port or DNS record](https://upfour.io/docs/check-server-port-dns.md) |
| Domain to look up | The domain name up4 looks up. | – | [Check a server, port or DNS record](https://upfour.io/docs/check-server-port-dns.md) |
| Host name or IP address | For a ping monitor the host or IP address goes into the address field. | – | [Check a server, port or DNS record](https://upfour.io/docs/check-server-port-dns.md) |

## Alerting

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Name | – | – | – |
| Type | email, sms, voice, webhook, slack, telegram, msteams, discord, pagerduty, zapier, datadog, newrelic, jira, grafana, ntfy or pushover | – | – |
| Email address | – | – | – |
| Webhook URL | – | – | – |
| Signing secret | – | – | – |
| Slack Webhook URL | Slack, Microsoft Teams, Discord, Zapier and Grafana use this key for their URL | – | – |
| Bot Token | – | – | – |
| Chat ID | – | – | – |
| Routing Key | – | – | – |
| Send every notice on its own | – | – | – |
| Alert plan name | – | – | – |
| Wait for | seconds; from step 2 on at least 60 | – | – |
| Who should we alert? | a list of alert channel ids | – | – |
| How urgent is this alert? | high, voice, sms or low | – | – |
| Reminders after the last step | 0 to 8 | – | – |
| Name | – | – | – |
| Team members | user ids in rotation order | – | – |
| Rotation frequency | daily, weekly or custom | – | – |
| Handoff time | – | – | – |
| Handoff day | – | – | – |
| Timezone | – | – | – |
| Who covers | – | – | – |
| From | – | – | – |
| Until | – | – | – |
| Reason (optional) | – | – | – |

## Clients

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Client name | – | – | – |
| Primary domain | – | – | – |
| Starter template | – | – | – |
| Communication language | – | – | – |
| Let this client sign in | – | – | – |
| Pause their monitors and scheduled jobs | query parameter, true to pause | – | – |
| Portal view | – | – | – |
| Incidents | – | – | – |
| Reports | – | – | – |
| Service levels | – | – | – |
| Response time | – | – | – |
| Incident analytics | – | – | – |
| Downtime evidence | – | – | – |
| Report downloads | – | – | – |

## Scheduled jobs

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Name | – | – | – |
| Expect a check-in every | Whole seconds; the form turns seconds, minutes, hours or days into seconds. | – | – |
| with a grace period of | Whole seconds, zero or more. | – | – |
| Group | – | – | – |
| Client | – | – | – |
| Metadata | – | – | – |

## Incidents

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Brief description | – | – | – |
| In-depth description | – | – | – |
| Affected monitor (optional) | – | – | – |
| Severity | critical, warning or info | – | – |
| Post an update | – | – | – |
| Escalate to a specific person | the request also needs an Idempotency-Key header | – | – |
| Incident screenshots | a setting of the monitor, not of the incident | – | – |

## Maintenance windows

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| From | HH:MM, in the window's time zone. | – | – |
| Until | – | – | – |
| Timezone | An IANA zone such as Europe/Berlin. | – | – |
| On these days | Three-letter day codes; an empty list means every day. | – | – |
| Title | Send the entry as a maintenance update with status scheduled. | – | – |
| Start date | One timestamp; the app joins start date and start time. | – | – |
| End date | One timestamp; the app joins end date and end time. | – | – |
| Repeat | none, weekly or monthly. | – | – |
| During the window | none keeps checking, pause_checks pauses the affected monitors. | – | – |
| Affected components | – | – | – |
| Notify subscribers | – | – | – |

## Playbooks

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Title | – | – | – |
| Description | – | – | – |
| Owner | – | – | – |
| Steps | a list of steps, each with a title and a description | – | – |
| Linked monitors | – | – | – |

## Reports

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Name | – | – | – |
| Report | – | – | – |
| Scope to client (optional) | – | – | – |
| Format | – | – | – |
| Recipients | – | – | – |
| Cadence | – | – | – |
| Day of month | – | – | – |
| Send at (hour) | – | – | – |
| Timezone | – | – | – |
| Report language | – | – | – |

## Status pages

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Company name | – | – | – |
| Public page slug | – | – | – |
| Structure | sections with their resources, in display order | – | – |
| Layout | an object with layout, ground and header colours | – | – |
| Announcement | – | – | – |
| How many days to display? | – | – | – |
| Default language | – | – | – |
| Reply-to address for status e-mails | – | – | – |
| Password | – | – | – |
| Custom CSS | – | – | – |
| Publish status page | a page created through the API starts unpublished unless you send true | – | – |

## Teams and members

| Field | What it does | Default | More |
| --- | --- | --- | --- |
| Email address | – | – | – |
| Role | – | – | – |
| Team | – | – | – |
| Team name | – | – | – |

A dash means the form preselects nothing, or the guide describes the value. Defaults are those of the form in the app; the API can differ where a row says so.
