Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
      1. Status pages API
      2. Status page groups
      3. Status page sections
      4. Status page resources
        1. List status page resources GET
        2. Get status page resource GET
        3. Create status page resource POST
        4. Update status page resource PATCH
        5. Remove status page resource DELETE
      5. Status page subscribers
      6. Status page reports
      7. Status page report updates
    7. Metadata
    8. Integrations
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Create status page resource

Returns a newly created status page resource.

POST https://incidents.betterstack.com/api/v2/status-pages/{status_page_id}/resources

URL parameters

status_page_id
required string

The ID of your status page

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
string

application/json

Body parameters

status_page_section_id
integer

The ID of the section which should contain this resource. When omitted, defaults to the first section on the status page.

widget_type
string

What widget to display for this resource. Available values:

  • plain - Only display status.
  • history - Display historical status.
  • intraday_history - Display detailed historical status.
  • response_times - Add a response times chart. Only for Monitor or LogsChart.
  • intraday_response_times - Display detailed historical status with a response times chart. Only for Monitor or LogsChart.
  • chart_only - Shows just the chart. Only for LogsChart.

Defaults to history, or response_times for a LogsChart. This takes preference over history when both parameters are present.

resource_id
string

The ID of the resource you are adding. Leave it out when resource_type is ManuallyTrackedItem, and Better Stack creates the item for you, or when you send catalog_reference.

resource_type
required string

The type of the resource you are adding. Available values: ManuallyTrackedItem, Monitor, MonitorGroup, Heartbeat, HeartbeatGroup, WebhookIntegration, EmailIntegration, IncomingWebhook, AmazonSnsIntegration, ResourceGroup, LogsChart, CatalogReference. A ThirdPartyService can only be added in the status page editor.

catalog_reference
object

The catalog value this resource shows, as a JSON object with key and value fields. Use it with resource_type CatalogReference instead of resource_id, and Better Stack finds or creates the catalog reference for you. value is a string or an object naming a catalog item, such as {"type": "Team", "name": "Platform"}, in the same shape as a value of mark_as_down_metadata_rule.

public_name
required string

The resource name displayed publicly on your status page.

explanation
string

A detailed text displayed as a help icon.

position
integer

The position of this resource in its section, indexed from zero. If you don't specify a position, we add the resource to the end of the section.

mark_as_down_for
string

How the resource status is affected when an incident occurs. Possible values: any_incident, no_incident, incident_matching_metadata. Defaults to any_incident.

mark_as_down_metadata_rule
object

A rule to match incident metadata. Required when mark_as_down_for is incident_matching_metadata. The rule is a JSON object with a key, the metadata key to match, and values, a non-empty array: an incident whose metadata has any of the values marks the resource down. Each value is either:

  • A string, or an object {"type": "String", "value": "critical"}, for a text value.
  • An object naming a catalog item by type and item_id, such as {"type": "Policy", "item_id": 12345}. type is one of User, Team, Policy, Schedule, Endpoint, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, PagerDutyWebhook, or Source. Instead of item_id, you can name a User by email, and any other type except Endpoint, SlackIntegration and ZapierWebhook by name.
mark_as_degraded_for
string

How the resource status is affected when an incident occurs. Possible values: any_incident, no_incident, incident_matching_metadata. Defaults to no_incident.

mark_as_degraded_metadata_rule
object

A rule to match incident metadata, in the same shape as mark_as_down_metadata_rule. Required when mark_as_degraded_for is incident_matching_metadata.

fixed_position
boolean

If true, the resource is saved at exactly position and the other resources keep their positions. Defaults to false.

history
boolean

Deprecated, use widget_type instead. true sets widget_type to history and false to plain. Ignored when you also send widget_type.

201

Response body

{
  "data": {
    "id": "12345",
    "type": "status_page_resource",
    "attributes": {
      "status_page_section_id": 456789,
      "resource_id": 112233,
      "resource_type": "Monitor",
      "history": true,
      "widget_type": "history",
      "public_name": "https://uptime.betterstack.com/",
      "explanation": "",
      "position": 0,
      "mark_as_down_for": "incident_matching_metadata",
      "mark_as_down_metadata_rule": {
        "key": "Escalation policy",
        "values": [
          {
            "type": "Policy",
            "item_id": 12345,
            "name": "Primary Policy"
          }
        ]
      },
      "mark_as_degraded_for": "any_incident",
      "catalog_reference": null,
      "availability": 0.99963,
      "status": "operational",
      "status_history": [
        {
          "day": "2022-01-01",
          "status": "operational",
          "downtime_duration": 0,
          "maintenance_duration": 0
        },
        {
          "day": "2022-01-02",
          "status": "downtime",
          "downtime_duration": 120.0,
          "maintenance_duration": 0
        }
      ]
    }
  }
}

Example cURL

Example With metadata rules Catalog reference 
curl --request POST \
  --url https://incidents.betterstack.com/api/v2/status-pages/123456789/resources \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  	"resource_id": "112233",
  	"resource_type": "Monitor",
  	"public_name": "The best monitor",
  	"explanation": "Hide easter eggs here",
  	"position": 0
  }'
curl --request POST \
  --url https://incidents.betterstack.com/api/v2/status-pages/123456789/resources \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
	  "resource_id": "112233",
  	"resource_type": "Monitor",
  	"public_name": "The best monitor",
  	"mark_as_down_for": "incident_matching_metadata",
  	"mark_as_down_metadata_rule": {
      "key": "Severity",
      "values": [{ "value": "critical" }, { "value": "high" }]
    },
  	"mark_as_degraded_for": "incident_matching_metadata",
  	"mark_as_degraded_metadata_rule": {
      "key": "Assigned User",
      "values": [
          { "type": "User", "email": "john.doe@example.com" },
          { "type": "User", "item_id": 12345 }
      ]
    }
  }'
curl --request POST \
  --url https://incidents.betterstack.com/api/v2/status-pages/123456789/resources \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  	"resource_type": "CatalogReference",
  	"public_name": "Payments",
  	"catalog_reference": {
      "key": "Service",
      "value": "payments"
    }
  }'


Previous article

Get status page resource

Next article

Update status page resource