# paths./api/v1/alerts/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/alerts/.get.parameters[].description
Filter by tag name (can be specified multiple times.)

# paths./api/v1/alerts/.get.parameters[].description
Start date in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/alerts/.get.parameters[].description
End date in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/alerts/alert/{pk}/root-cause/.get.description
Get the details of an alert for a specific location along with any root cause analysis data

# paths./api/v1/auth/.get.description
Provides APIs for generating access tokens

# paths./api/v1/auth/account-usage/.get.description
Download a CSV showing detailed usage info of your current plan.

# paths./api/v1/auth/me/.get.description
Shows the details of the authenticated user

# paths./api/v1/auth/reset-password/.get.description
Sends an email with a reset password link

# paths./api/v1/auth/reset-password/.post.description
Sends an email with a reset password link

# paths./api/v1/auth/subaccounts/.get.description
Lists all subaccounts of this account You may select the active subaccount for any API request by using a HTTP header or query string parameter to specify the subaccount ID as follows:
https://uptime.com/api/v1/dashboard/?subaccount=123
or
curl -H "X-Subaccount: 123" -H "Authorization: token xxxx" https://uptime.com/api/v1/dashboard/

# paths./api/v1/auth/subaccounts/.post.description
Creates a new subaccount

Creates a new subaccount for this account which includes one pack which is deducted from the main account.

# paths./api/v1/auth/subaccounts/{pk}/allocation/.post.description
Transfers packs to subaccount from main account and vice versa

If num is positive packs are transferred from main account to subaccount. If num is negative
packs are deducted from subaccount and added to the main account.

# paths./api/v1/check-tags/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/checks/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/checks/.get.parameters[].description
Filter for checks currently under maintenance.

# paths./api/v1/checks/.get.parameters[].description
Filter by checks that have a maintenance schedule.

# paths./api/v1/checks/.get.parameters[].description
Filter by tag name (can be specified multiple times.)

# paths./api/v1/checks/add-rum/.post.description
Create a new Real User Monitoring (Legacy) check

# paths./api/v1/checks/add-ssl-cert/.post.description
Create a new SSL Certificate check

Warning: `msp_protocol` field is deprecated; use `ssl_config => ssl_cert_protocol` istead.

# paths./api/v1/checks/bulk/escalations/.patch.description
Bulk API: Update escalations for multiple checks

**Sample data (JSON):**

    {
        "pk": [1, 2, 3],
        "fields": {
            "escalations": [{
                "wait_time": 5,
                "num_repeats: 10,
                "contact_groups": ["Default", "Other"]
            }]
        }
    }

# paths./api/v1/checks/bulk/maintenance/.patch.description
Bulk API: Update maintenance settings for multiple checks

**Sample data (JSON):**

    {
        "pk": [1, 2, 3],
        "fields": {
            "state": "SCHEDULED",
            "schedule": [{
                "type": "WEEKLY",
                "from_time": "03:15",
                "to_time": "18:30",
                "weekdays": [6, 0]
            }]
        }
    }

# paths./api/v1/checks/bulk/pause/.patch.description
Bulk API: Pause multiple checks

**Sample data (JSON):**

    {
        "pk": [1, 2, 3]
    }

# paths./api/v1/checks/bulk/resume/.patch.description
Bulk API: Resume multiple checks

**Sample data (JSON):**

    {
        "pk": [1, 2, 3]
    }

# paths./api/v1/checks/bulk/stats/.get.description
Bulk API: Get statistics & response time for multiple checks

# paths./api/v1/checks/bulk/stats/.get.parameters[].description
The first day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/checks/bulk/stats/.get.parameters[].description
The last day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/checks/bulk/stats/.get.parameters[].description
Include alert data for each outage in the period.

# paths./api/v1/checks/bulk/update/.patch.description
Bulk API: Update multiple checks

**Sample data (JSON):**

    {
        "pk": [1, 2, 3],
        "fields": {
            "msp_interval": 10,
            "msp_sensitivity": 3,
            "contact_groups": ["Default", "Other"],
            "locations": ["GBR", "AUT"],
            "tags": ["One", "Two"],
            ...
        }
    }

# paths./api/v1/checks/check-definitions/.get.description
Lists the parameters available for every type of check

# paths./api/v1/checks/locations/.get.description
Lists all locations available for checks

# paths./api/v1/checks/{group_id}/checks/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/checks/{group_id}/checks/.get.parameters[].description
Filter for checks currently under maintenance.

# paths./api/v1/checks/{group_id}/checks/.get.parameters[].description
Filter by checks that have a maintenance schedule.

# paths./api/v1/checks/{group_id}/checks/.get.parameters[].description
Filter by tag name (can be specified multiple times.)

# paths./api/v1/checks/{pk}/add-contact-groups/.patch.description
Add additional contacts to a check

**Sample data (application/x-www-form-urlencoded):**

<pre>contact_groups[0]=Default&contact_groups[1]=Other</pre>

<br />
**Sample data (JSON):**

    {"contact_groups": ["Default", "Other"]}

<br />

# paths./api/v1/checks/{pk}/add-locations/.patch.description
Add additional locations to a check

**Sample data (application/x-www-form-urlencoded):**

<pre>locations[0]=GBR&locations[1]=AUT</pre>

<br />
**Sample data (JSON):**

    {"locations": ["GBR", "AUT"]}

<br />

# paths./api/v1/checks/{pk}/add-tags/.patch.description
Add additional tags to a check

**Sample data (application/x-www-form-urlencoded):**

<pre>tags[0]=One&tags[1]=Two</pre>

<br />
**Sample data (JSON):**

    {"tags": ["One", "Two"]}

<br />

# paths./api/v1/checks/{pk}/analysis/.get.description
Shows the real-time analysis data - location status and recent alerts per location

# paths./api/v1/checks/{pk}/current-status/.get.description
Shows the current check state and latest downtime event for a check

# paths./api/v1/checks/{pk}/escalations/.patch.description
Set escalations for a check

**Sample data (JSON):**

    {
        "escalations": [{
            "wait_time": 5,
            "num_repeats": 10
            "contact_groups": ["Default", "Other"]
        }]
    }

<br />

# paths./api/v1/checks/{pk}/maintenance/.patch.description
Set maintenance windows for a check

**Sample data (JSON):**

    # Set under maintenance now
    {
        "state": "SUPPRESSED"
    }

    # Turn off maintenance
    {
        "state": "ACTIVE"
    }

    # Set weekly scheduled maintenance
    {
        "state": "SCHEDULED",
        "schedule": [{
            "type": "WEEKLY",
            "from_time": "03:15",
            "to_time": "18:30",
            "weekdays": [6, 0]
        }]
    }

    # Set monthly scheduled maintenance
    {
        "state": "SCHEDULED",
        "schedule": [{
            "type": "MONTHLY",
            "from_time": "03:15",
            "to_time": "18:30",
            "monthday": 7
        }]
    }

    or

    {
        "state": "SCHEDULED",
        "schedule": [{
            "type": "MONTHLY",
            "from_time": "03:15",
            "to_time": "18:30",
            "monthday_from": 7,
            "monthday_to": 9
        }]
    }

    # Set one-off scheduled maintenance
    {
        "state": "SCHEDULED",
        "schedule": [{
            "type": "ONCE",
            "once_start_date": "2022-10-06T18:30:00Z",
            "once_end_date": "2022-10-07T14:30:00Z"
        }]
    }

# paths./api/v1/checks/{pk}/replace-contact-groups/.patch.description
Replace all contacts on a check

**Sample data (application/x-www-form-urlencoded):**

<pre>contact_groups[0]=Default&contact_groups[1]=Other</pre>

<br />
**Sample data (JSON):**

    {"contact_groups": ["Default", "Other"]}

<br />

# paths./api/v1/checks/{pk}/replace-locations/.patch.description
Replace all locations on a check

**Sample data (application/x-www-form-urlencoded):**

<pre>locations[0]=GBR&locations[1]=AUT</pre>

<br />
**Sample data (JSON):**

    {"locations": ["GBR", "AUT"]}

<br />

# paths./api/v1/checks/{pk}/replace-tags/.patch.description
Replace all tags on a check

**Sample data (application/x-www-form-urlencoded):**

<pre>tags[0]=One&tags[1]=Two</pre>

<br />
**Sample data (JSON):**

    {"tags": ["One", "Two"]}

<br />

# paths./api/v1/checks/{pk}/response-time/.get.description
Returns raw response time data for a check for all locations.

# paths./api/v1/checks/{pk}/response-time/.get.parameters[].description
The first day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/checks/{pk}/response-time/.get.parameters[].description
The last day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/checks/{pk}/stats/.get.description
Shows uptime and response time statistics for this check

# paths./api/v1/checks/{pk}/stats/.get.parameters[].description
The first day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/checks/{pk}/stats/.get.parameters[].description
The last day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/checks/{pk}/stats/.get.parameters[].description
Show response time for specified location only.

# paths./api/v1/checks/{pk}/stats/.get.parameters[].description
Include response time datapoints for all locations.

# paths./api/v1/checks/{pk}/stats/.get.parameters[].description
Include alert data for each outage in the period.

# paths./api/v1/checks/{pk}/stats/.get.parameters[].description
Set this paramater to download an XLS containing the stats.

# paths./api/v1/checks/{pk}/stats/.get.parameters[].description
Set this paramater to download a PDF report.

# paths./api/v1/contacts/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/contacts/.get.parameters[].description
Filter by contacts that have on-call schedules defined.

# paths./api/v1/contacts/{pk}/oncall/.patch.description
Set the on-call schedule for a contact.

**Sample data (JSON):**

    # Set always on-call
    {
        "state": "ACTIVE"
    }

    # Set weekly on-call schedule
    {
        "state": "SCHEDULED",
        "schedule": [{
            "type": "WEEKLY",
            "from_time": "03:15",
            "to_time": "18:30",
            "weekdays": [6, 0]
        }]
    }

    # Set monthly schedule
    {
        "state": "SCHEDULED",
        "schedule": [{
            "type": "MONTHLY",
            "from_time": "03:15",
            "to_time": "18:30",
            "monthday": 7
        }]
    }

    or

    {
        "state": "SCHEDULED",
        "schedule": [{
            "type": "MONTHLY",
            "from_time": "03:15",
            "to_time": "18:30",
            "monthday_from": 7,
            "monthday_to": 9
        }]
    }

# paths./api/v1/dashboards/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/dashboards/default/.get.description
Shows the default dashboard defined by the system

# paths./api/v1/dashboards/{pk}/stats/.get.description
Shows the real-time statistics for this dashboard.

# paths./api/v1/integrations/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/integrations/.get.parameters[].description
Filter by whether this integration has stopped due to errors.

# paths./api/v1/integrations/add-jiraservicedesk/.post.description
Create a new Jira Service Desk integration

# paths./api/v1/integrations/add-microsoft-teams/.post.description
Create a new Microsoft Teams integration

# paths./api/v1/integrations/add-wavefront/.post.description
Create a new VMware Aria Operations for Applications integration

# paths./api/v1/integrations/add-webhook/.post.description
Create a new Custom Postback URL (Webhook) integration

# paths./api/v1/integrations/{pk}/.put.description
Update an integration

See the various POST methods for additional fields available for each integration type.

# paths./api/v1/integrations/{pk}/.patch.description
Partially update an integration

See the various POST methods for additional fields available for each integration type.

# paths./api/v1/outages/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/outages/.get.parameters[].description
Filter by tag name (can be specified multiple times.)

# paths./api/v1/outages/.get.parameters[].description
Start date in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/outages/.get.parameters[].description
End date in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/outages/.get.parameters[].description
Whether the outage is ongoing (true) or resolved (false).

# paths./api/v1/probe-servers/.get.description
List all probe servers.

**Deprecation Notice**:

The `ip_address` field is deprecated and will be removed on Sep 1, 2024.
Please use the `ipv4_addresses` field instead.

# paths./api/v1/push-notifications/.get.description
List all registered push notification devices
and the associated contacts that push alerts to them

# paths./api/v1/push-notifications/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/push-notifications/.post.description
Register a new device for push notifications

**NOTE: This API is only available to the Uptime.com mobile app.**
Register your device via the mobile app and it will automatically appear
in the list.

**NOTE 2:** This endpoint will overwrite any existing registered
device with the same UUID, if it exists.

# paths./api/v1/push-notifications/{pk}/.get.description
Get a single registered push notification device

**NOTE** You may identify the object by PK or UUID

# paths./api/v1/push-notifications/{pk}/.put.description
Update the device name and associated contacts for a push notification device

**NOTE** You may identify the object by PK or UUID

# paths./api/v1/push-notifications/{pk}/.patch.description
Partially update the device name or associated contacts for a push notification device

**NOTE** You may identify the object by PK or UUID

# paths./api/v1/push-notifications/{pk}/.delete.description
Delete a registered push notification device

**NOTE** You may identify the object by PK or UUID

# paths./api/v1/scheduled-reports/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/sla-reports/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/sla-reports/{pk}/stats/.get.description
Generates the report for the specified time period

# paths./api/v1/sla-reports/{pk}/stats/.get.parameters[].description
The first day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/sla-reports/{pk}/stats/.get.parameters[].description
The last day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# paths./api/v1/sla-reports/{pk}/stats/.get.parameters[].description
The output format of the report: [json, pdf, xls]

# paths./api/v1/sla-reports/{sla_report_id}/groups/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/sla-reports/{sla_report_id}/groups/{pk}/.delete.description
Delete a reporting group from sla report

# paths./api/v1/statuspages/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/statuspages/{pk}/history/.get.parameters[].description
Start date in ISO 8601 (YYYY-MM-DD) format.

# paths./api/v1/statuspages/{pk}/history/.get.parameters[].description
End date in ISO 8601 (YYYY-MM-DD) format.

# paths./api/v1/statuspages/{statuspage_id}/components/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/statuspages/{statuspage_id}/components/.get.parameters[].description
Filter by whether this component belongs to group with this ID

# paths./api/v1/statuspages/{statuspage_id}/components/.get.parameters[].description
Filter by whether this component is a group

# paths./api/v1/statuspages/{statuspage_id}/components/{pk}/.patch.description
Partially update a status page component

# paths./api/v1/statuspages/{statuspage_id}/incidents/.get.description
List all status page incidents or maintenance windows

# paths./api/v1/statuspages/{statuspage_id}/incidents/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/statuspages/{statuspage_id}/incidents/.get.parameters[].description
Start date in ISO 8601 (YYYY-MM-DD) format.

# paths./api/v1/statuspages/{statuspage_id}/incidents/.get.parameters[].description
Start date in ISO 8601 (YYYY-MM-DD) format.

# paths./api/v1/statuspages/{statuspage_id}/incidents/.post.description
Create a new status page incident or maintenance window

# paths./api/v1/statuspages/{statuspage_id}/incidents/{pk}/.get.description
Get a single status page incident or maintenance window

# paths./api/v1/statuspages/{statuspage_id}/incidents/{pk}/.put.description
Update a single status page incident or maintenance window

# paths./api/v1/statuspages/{statuspage_id}/incidents/{pk}/.patch.description
Partially update a single status page incident or maintenance window

# paths./api/v1/statuspages/{statuspage_id}/incidents/{pk}/.delete.description
Delete a single status page incident or maintenance window

# paths./api/v1/statuspages/{statuspage_id}/metrics/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/statuspages/{statuspage_id}/metrics/.get.parameters[].description
Filter by whether this metric is visible to Status Page visitors

# paths./api/v1/statuspages/{statuspage_id}/subscribers/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/statuspages/{statuspage_id}/users/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/statuspages/{statuspage_id}/users/.get.parameters[].description
Filter by whether this user can view the status page or not.

# paths./api/v1/statuspages/{statuspage_id}/users/{pk}/.patch.description
Partially update a status page external user

# paths./api/v1/users/.get.parameters[].description
A page number within the paginated result set.

# paths./api/v1/users/.get.parameters[].description
Filter by users that have access to this subaccount ID.

# paths./api/v1/users/.get.parameters[].description
Filter by whether the API is enabled for this user.

# paths./api/v1/users/.get.parameters[].description
Filter by whether invoices are sent to this user.

# components.schemas.CheckContactGroups.properties.contact_groups.description
An array of contact group names or IDs to set on this check

# components.schemas.CheckEscalations.properties.escalations.items.properties.num_repeats.description
Number of times to repeat the escalation. '0' means no repeats.

# components.schemas.CheckEscalations.properties.escalations.description
A list of escalations to set on this check; see example above.

# components.schemas.CheckLocations.properties.locations.description
An array of location names to add to this check

# components.schemas.CheckMaintenance.properties.state.description
Current state of the check; ACTIVE (alerts sent normally), SUPPRESSED (under maintenance), SCHEDULED (maintenance windows as defined in the schedule)

# components.schemas.CheckMaintenance.properties.schedule.description
The schedule entries for maintenance windows; see example above.

# components.schemas.CheckStats.properties.start_date.description
The first day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# components.schemas.CheckStats.properties.end_date.description
The last day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# components.schemas.CheckStats.properties.location.description
Show response time for specified location only.

# components.schemas.CheckStats.properties.locations_response_times.description
Include response time datapoints for all locations.

# components.schemas.CheckStats.properties.include_alerts.description
Include alert data for each outage in the period.

# components.schemas.CheckStats.properties.download.description
Set this paramater to download an XLS containing the stats.

# components.schemas.CheckStats.properties.pdf.description
Set this paramater to download a PDF report.

# components.schemas.CheckTag.properties.color_hex.description
The CSS color code of the tag, eg. #334455

# components.schemas.CheckTags.properties.tags.description
An array of tags names or IDs to set on this check

# components.schemas.Checks.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.Checks.properties.locations.description
Array of locations associated with this check

# components.schemas.Checks.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksAPI.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksAPI.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksAPI.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksBLACKLIST.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksBLACKLIST.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksBLACKLIST.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksBulkStats.properties.start_date.description
The first day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# components.schemas.ChecksBulkStats.properties.end_date.description
The last day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# components.schemas.ChecksBulkStats.properties.include_alerts.description
Include alert data for each outage in the period.

# components.schemas.ChecksBulkUpdate.properties.fields.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksBulkUpdate.properties.fields.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksBulkUpdate.properties.fields.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksBulkUpdateEscalations.properties.fields.properties.escalations.items.properties.num_repeats.description
Number of times to repeat the escalation. '0' means no repeats.

# components.schemas.ChecksBulkUpdateEscalations.properties.fields.properties.escalations.description
A list of escalations to set on this check; see example above.

# components.schemas.ChecksBulkUpdateMaintenance.properties.fields.properties.state.description
Current state of the check; ACTIVE (alerts sent normally), SUPPRESSED (under maintenance), SCHEDULED (maintenance windows as defined in the schedule)

# components.schemas.ChecksBulkUpdateMaintenance.properties.fields.properties.schedule.description
The schedule entries for maintenance windows; see example above.

# components.schemas.ChecksDNS.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksDNS.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksDNS.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksGROUP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksGROUP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksGROUP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksGROUP.properties.groupcheckconfig.properties.group_check_tags.description
Include checks with one or more of the selected tags

# components.schemas.ChecksHEARTBEAT.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksHEARTBEAT.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksHEARTBEAT.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksHTTP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksHTTP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksHTTP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksICMP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksICMP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksICMP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksIMAP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksIMAP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksIMAP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksMALWARE.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksMALWARE.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksMALWARE.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksNTP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksNTP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksNTP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksPAGESPEED.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksPAGESPEED.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksPAGESPEED.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksPOP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksPOP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksPOP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksRUM.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksRUM.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksRUM.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksRUM2.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksRUM2.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksRUM2.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksSMTP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksSMTP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksSMTP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksSSH.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksSSH.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksSSH.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksSSL_CERT.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksSSL_CERT.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksSSL_CERT.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksSSL_CERT.properties.sslconfig.properties.ssl_cert_first_element_only.description
Check only the first certificate in the chain

# components.schemas.ChecksSSL_CERT.properties.sslconfig.properties.ssl_cert_match.description
Additional names to match in certificate

# components.schemas.ChecksSSL_CERT.properties.sslconfig.properties.ssl_ignore_authority_warnings.description
Ignore authority warnings (check expiration only)

# components.schemas.ChecksSSL_CERT.properties.sslconfig.properties.ssl_ignore_sct.description
Do not check for signed certificate timestamps (SCT)

# components.schemas.ChecksTCP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksTCP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksTCP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksTRANSACTION.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksTRANSACTION.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksTRANSACTION.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksUDP.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksUDP.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksUDP.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksWEBHOOK.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksWEBHOOK.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksWEBHOOK.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ChecksWHOIS.properties.contact_groups.description
Array of contact names or IDs associated with this check

# components.schemas.ChecksWHOIS.properties.locations.description
Array of locations associated with this check

# components.schemas.ChecksWHOIS.properties.tags.description
Array of tag names or IDs associated with this check

# components.schemas.ContactGroup.properties.sms_list.description
Array of cellphone numbers for SMS alerts (valid international phone number starting with +)

# components.schemas.ContactGroup.properties.email_list.description
Array of email addresses to receive alerts

# components.schemas.ContactGroup.properties.phonecall_list.description
Array of cellphone numbers for voice call alerts (valid international phone number starting with +)

# components.schemas.ContactGroup.properties.integrations.description
Array of integration names or IDs associated with this contact

# components.schemas.ContactGroup.properties.push_notification_profiles.description
Array of integration names or IDs associated with this contact

# components.schemas.ContactGroup.properties.oncall_schedule.description
The on-call hours schedule for this contact

# components.schemas.ContactGroupOnCallSchedule.properties.state.description
Whether to use an on-call schedule. Either ACTIVE (always on call) or SCHEDULED (use defined schedule).

# components.schemas.ContactGroupOnCallSchedule.properties.schedule.description
The schedule entries for when the contact is on-call; see example above.

# components.schemas.Dashboard.properties.services_tags.description
Include checks with one or more of the selected tags

# components.schemas.Dashboard.properties.is_pinned.description
Whether this dashboard is pinned to the sidebar

# components.schemas.Dashboard.properties.metrics_show_section.description
Show/hide the Summary Metrics section at the top of this dashboard

# components.schemas.Dashboard.properties.metrics_for_all_checks.description
Include metrics from all checks, not just the selected checks

# components.schemas.Dashboard.properties.services_show_section.description
Show/hide the check cards from this dashboard

# components.schemas.Dashboard.properties.services_num_to_show.description
Number of check cards to show in the Checks section

# components.schemas.Dashboard.properties.services_include_up.description
Include/exclude checks which are currently up

# components.schemas.Dashboard.properties.services_include_down.description
Include/exclude checks which are currently down

# components.schemas.Dashboard.properties.services_include_paused.description
Include/exclude checks which are currently paused

# components.schemas.Dashboard.properties.services_include_maintenance.description
Include/exclude checks which are manually marked for maintenance

# components.schemas.Dashboard.properties.services_primary_sort.description
The primary value for ordering the checks

# components.schemas.Dashboard.properties.services_secondary_sort.description
The secondary value for ordering the checks, if the primary value is the same

# components.schemas.Dashboard.properties.services_show_uptime.description
Show the 24h uptime percentage on each check card

# components.schemas.Dashboard.properties.services_show_response_time.description
Show the response time graph or metric on each check card

# components.schemas.Dashboard.properties.alerts_show_section.description
Show/hide the Latest Alerts section from this dashboard

# components.schemas.Dashboard.properties.alerts_for_all_checks.description
Show/hide alerts globally across all checks, rather than only for checks selected in the Checks tab

# components.schemas.Dashboard.properties.alerts_include_ignored.description
Include/exclude alerts marked as "ignored" in the alerts listing

# components.schemas.Dashboard.properties.alerts_include_resolved.description
Include/exclude alerts that are no longer down in the alerts listing

# components.schemas.Dashboard.properties.alerts_num_to_show.description
Number of alerts to show in the Latest Alerts section

# components.schemas.Incident.properties.name.description
The name of incident, eg. a problem or resolution

# components.schemas.Incident.properties.notify_subscribers.description
Send notifications to subscribers of this Status Page

# components.schemas.Integration.properties.name.description
Your preferred name for this integration.

# components.schemas.Integration.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationCachet.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationCachet.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationCachet.properties.component.description
Component to update with availability status.

# components.schemas.IntegrationCachet.properties.metric.description
Metric to update with response time data.

# components.schemas.IntegrationDatadog.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationDatadog.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationDiscord.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationDiscord.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationGeckoboard.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationGeckoboard.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationJiraservicedesk.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationJiraservicedesk.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationJiraservicedesk.properties.api_email.description
Email of the user whose API token is being used.

# components.schemas.IntegrationJiraservicedesk.properties.api_token.description
API Token created for the user, or the user's password (self-hosted only).

# components.schemas.IntegrationJiraservicedesk.properties.jira_subdomain.description
The domain your company uses to access Jira, e.g. "https://your-domain.atlassian.net"

# components.schemas.IntegrationJiraservicedesk.properties.project_key.description
The project key of your Service Desk project, shown on the Project Settings > Details page. E.g. "SMPSRVDESK"

# components.schemas.IntegrationJiraservicedesk.properties.labels.description
A comma separated list of labels attached to each incident created. The "Uptime.com" label any associated check tags are always set.

# components.schemas.IntegrationJiraservicedesk.properties.custom_field_id_account_name.description
An optional ID for a custom text field that should receive the account name.

# components.schemas.IntegrationJiraservicedesk.properties.custom_field_id_check_name.description
An optional ID for a custom text field that should receive the check name.

# components.schemas.IntegrationJiraservicedesk.properties.custom_field_id_check_url.description
An optional ID for a custom text field that should receive the check URL.

# components.schemas.IntegrationJiraservicedesk.properties.custom_fields_json.description
Advanced configuration for custom fields using JSON format. See example values.

  {
    "customfield_10000": "this is a text field",
    "customfield_20000": "this is a multi-line text field. big text.",
    "customfield_30000": "2011-07-13T15:25:00",
    "customfield_40000": {
      "value": "this is a select list value"
    },
    "customfield_50000": {
      "name": "this is a group picker value"
    },
    "customfield_60000": [
      {"value": "this is a multi select list value #1"},
      {"value": "this is a multi select list value #2"}
    ],
  }

# components.schemas.IntegrationKlipfolio.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationKlipfolio.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationLibrato.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationLibrato.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationLibrato.properties.email.description
Email address which you registered with at Librato

# components.schemas.IntegrationLogz.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationLogz.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationLogz.properties.listener_url.description
The Listener domain name that logs and metrics are sent to.

# components.schemas.IntegrationMicrosoft_Teams.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationMicrosoft_Teams.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationOpsgenie.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationOpsgenie.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationOpsgenie.properties.api_endpoint.description
Listed on the Integrations / Configured Integrations page in OpsGenie.

# components.schemas.IntegrationOpsgenie.properties.api_key.description
Listed on the Integrations / Configured Integrations page in OpsGenie.

# components.schemas.IntegrationOpsgenie.properties.teams.description
A comma separated list of team names which will be responsible for the alert.

# components.schemas.IntegrationOpsgenie.properties.tags.description
A comma separated list of labels attached to the alert. You may overwrite the quiet hours setting for urgent alerts by adding the OverwriteQuietHours tag.

# components.schemas.IntegrationOpsgenie.properties.autoresolve.description
Automatically resolve incident once the check is back up.

# components.schemas.IntegrationPagerduty.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationPagerduty.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationPagerduty.properties.service_key.description
Listed on the Service's details page, Integrations tab.

# components.schemas.IntegrationPagerduty.properties.autoresolve.description
Automatically resolve this incident once the check is back up.

# components.schemas.IntegrationPushbullet.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationPushbullet.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationPushbullet.properties.email.description
The email used in creating your Pushbullet account.

# components.schemas.IntegrationPushover.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationPushover.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationPushover.properties.user.description
This may be your user key or a group key.

# components.schemas.IntegrationPushover.properties.priority.description
Priorities higher then normal will override recipient's quiet hours.

# components.schemas.IntegrationSlack.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationSlack.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationStatus.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationStatus.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationStatus.properties.component.description
Component to update with availability status. Listed in the Infrastructure / Modify Component / API section.

# components.schemas.IntegrationStatus.properties.container.description
Container to update with availability status. Listed in the Infrastructure / Modify Component / API section.

# components.schemas.IntegrationStatus.properties.metric.description
Metric to update with response time data. Listed on the Metrics / Modify Metric page when setting Data Source to Custom.

# components.schemas.IntegrationStatuspage.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationStatuspage.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationStatuspage.properties.api_key.description
Listed on the Manage Account / API page.

# components.schemas.IntegrationStatuspage.properties.page.description
Listed on the Manage Account / API page.

# components.schemas.IntegrationStatuspage.properties.component.description
Component to update with availability status, see instructions below.

# components.schemas.IntegrationStatuspage.properties.metric.description
Metric to update with response time data. Listed in Public Metrics / Edit Metric / Advanced Options.

# components.schemas.IntegrationTwitter.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationTwitter.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationVictorops.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationVictorops.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationVictorops.properties.routing_key.description
Routing key determines to which team alerts and incidents will be routed.

# components.schemas.IntegrationWavefront.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationWavefront.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationWavefront.properties.wavefront_url.description
Root URL of your VMware Aria Operations for Applications service, eg. https://longboard.wavefront.com.

# components.schemas.IntegrationWavefront.properties.csp_url.description
Root URL of your VMware CSP service, for authentication, e.g. https://console.cloud.vmware.com. Leave blank to use a legacy API token.

# components.schemas.IntegrationWavefront.properties.csp_app_id.description
If you're using a Server to Server OAuth App for authentication, provide the OAuth App ID here. Otherwise, leave blank.

# components.schemas.IntegrationWavefront.properties.api_token.description
If you're using a legacy API token or a CSP API Token, enter it here. If you're using a Server to Server OAuth App, enter your OAuth App Secret here.

# components.schemas.IntegrationWebhook.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationWebhook.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationWebhook.properties.postback_url.description
The URL you would like the alert details sent by HTTP POST.

# components.schemas.IntegrationWebhook.properties.headers.description
Optional custom HTTP headers in "Name: Value" format.

# components.schemas.IntegrationWebhook.properties.use_legacy_payload.description
Maintain compatibility with legacy handlers.

# components.schemas.IntegrationZapier.properties.name.description
Your preferred name for this integration.

# components.schemas.IntegrationZapier.properties.contact_groups.description
Array of contact names or IDs this integration is assigned to

# components.schemas.IntegrationZapier.properties.webhook_url.description
The Webhook URL for triggering the alert in Zapier.

# components.schemas.PasswordReset.properties.email.description
Email address to send password recovery link.

# components.schemas.PushNotificationProfile.properties.contact_groups.description
Array of contact names or IDs to this push notification will receive alerts for.

# components.schemas.PushNotificationProfileCreate.properties.contact_groups.description
Array of contact names or IDs to this push notification will receive alerts for.

# components.schemas.ResponseTime.properties.start_date.description
The first day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# components.schemas.ResponseTime.properties.end_date.description
The last day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# components.schemas.SLAReport.properties.services_tags.description
Include checks with one or more of the selected tags

# components.schemas.SLAReportStats.properties.start_date.description
The first day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# components.schemas.SLAReportStats.properties.end_date.description
The last day to show statistics for in ISO 8601 (YYYY-MM-DDTHH:MM:SSZ) format.

# components.schemas.SLAReportStats.properties.output.description
The output format of the report: [json, pdf, xls]

# components.schemas.ScheduledReport.properties.sla_report.description
Select an SLA report to send on this schedule

# components.schemas.ScheduledReport.properties.recipient_users.description
Select the users that should receive this report

# components.schemas.ScheduledReport.properties.at_time.description
Reports will be sent at this time (local time)

# components.schemas.ScheduledReport.properties.recipient_emails.description
Additional emails that will receive this report

# components.schemas.StatusPageCurrentStatus.properties.active_incidents.items.properties.name.description
The name of incident, eg. a problem or resolution

# components.schemas.StatusPageCurrentStatus.properties.active_incidents.items.properties.notify_subscribers.description
Send notifications to subscribers of this Status Page

# components.schemas.StatusPageCurrentStatus.properties.upcoming_maintenance.items.properties.name.description
The name of incident, eg. a problem or resolution

# components.schemas.StatusPageCurrentStatus.properties.upcoming_maintenance.items.properties.notify_subscribers.description
Send notifications to subscribers of this Status Page

# components.schemas.StatusPageHistory.properties.past_incidents.items.properties.name.description
The name of incident, eg. a problem or resolution

# components.schemas.StatusPageHistory.properties.past_incidents.items.properties.notify_subscribers.description
Send notifications to subscribers of this Status Page

# components.schemas.User.properties.email.description
The user's email address, used as their username

# components.schemas.User.properties.is_active.description
Whether this user account is active or disabled

# components.schemas.User.properties.notify_paid_invoices.description
Whether this user should receive new invoices

# components.schemas.User.properties.assigned_subaccounts.description
Which subaccounts this user may access, or empty for All Subaccounts.