Information Notices

Information Notices endpoints

Information Notice Updates

These endpoints are the same as Incident Updates endpoints, but it doesn't support the type attribute.

Get the list of information notices of a status page

get

/status_pages/{subdomain}/info_notices

Path parameters

subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

Query parameters

beforestringOptional

Used as a cursor for pagination.

afterstringOptional

Used as a cursor for pagination.

limitintegerOptional

Set the number of information notices to return in the response. This defaults to 20 items, and can be a maximum of 100.

Responses

200

The list of information notices

application/json

403

You lack the necessary permissions to access this resource.

application/json

404

A resource with the provided ID was not found.

application/json

500

Unexpected error.

application/json

get/status_pages/{subdomain}/info_notices

GET /api/v2/status_pages/{subdomain}/info_notices HTTP/1.1
Host: statuspal.io
Accept: */*

{
  "info_notices": [
    {
      "id": 89,
      "inserted_at": "2022-01-01T00:00:00",
      "updated_at": "2022-01-01T00:00:00",
      "title": "We are having issues with the DB connection",
      "featured_from": "2022-01-01T00:00:00",
      "featured_until": "2022-01-01T00:00:00",
      "service_ids": [
        1
      ],
      "updates": [
        {
          "id": 89,
          "inserted_at": "2022-01-01T00:00:00",
          "updated_at": "2022-01-01T00:00:00",
          "posted_at": "2022-01-01T00:00:00",
          "type": "issue",
          "description": "We have detected an issue with our CDN",
          "description_html": "<p>We have detected an issue with our CDN</p>",
          "translations": {
            "en": {
              "description": "English description"
            },
            "es": {
              "description": "Spanish description"
            }
          },
          "subscribers_notified_at": "2022-01-01T00:00:00",
          "tweet": true
        }
      ],
      "url": "https://status.google.com/info_notices/123",
      "translations": {
        "en": {
          "title": "English Title"
        },
        "es": {
          "title": "Spanish Title"
        }
      }
    }
  ],
  "links": {
    "next": "{STATUSPAL_HOST}/api/v2/status_pages/subdomain/info_notices?after=cUrSoR",
    "prev": "text"
  },
  "meta": {
    "total_count": 100
  }
}

Adds a new information notice associated to one or more services

post

/status_pages/{subdomain}/info_notices

Authorizations

AuthorizationstringRequired

Path parameters

subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

Body

Responses

200

The information notice was created

application/json

400

Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.

application/json

401

Authorization information is missing or invalid.

application/json

422

There was a validation error

application/json

500

Unexpected error.

application/json

post/status_pages/{subdomain}/info_notices

POST /api/v2/status_pages/{subdomain}/info_notices HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 493

{
  "info_notice": {
    "title": "We are having issues with the DB connection",
    "featured_from": "2022-01-01T00:00:00",
    "featured_until": "2022-01-01T00:00:00",
    "service_ids": [
      1
    ],
    "updates": [
      {
        "posted_at": "2022-01-01T00:00:00",
        "type": "issue",
        "description": "We have detected an issue with our CDN",
        "translations": {
          "en": {
            "description": "English description"
          },
          "es": {
            "description": "Spanish description"
          }
        },
        "notify": true,
        "tweet": true
      }
    ],
    "translations": {
      "en": {
        "title": "English Title"
      },
      "es": {
        "title": "Spanish Title"
      }
    }
  }
}

{
  "info_notice": {
    "id": 89,
    "inserted_at": "2022-01-01T00:00:00",
    "updated_at": "2022-01-01T00:00:00",
    "title": "We are having issues with the DB connection",
    "featured_from": "2022-01-01T00:00:00",
    "featured_until": "2022-01-01T00:00:00",
    "service_ids": [
      1
    ],
    "updates": [
      {
        "id": 89,
        "inserted_at": "2022-01-01T00:00:00",
        "updated_at": "2022-01-01T00:00:00",
        "posted_at": "2022-01-01T00:00:00",
        "type": "issue",
        "description": "We have detected an issue with our CDN",
        "description_html": "<p>We have detected an issue with our CDN</p>",
        "translations": {
          "en": {
            "description": "English description"
          },
          "es": {
            "description": "Spanish description"
          }
        },
        "subscribers_notified_at": "2022-01-01T00:00:00",
        "tweet": true
      }
    ],
    "url": "https://status.google.com/info_notices/123",
    "translations": {
      "en": {
        "title": "English Title"
      },
      "es": {
        "title": "Spanish Title"
      }
    }
  }
}

Get an information notice

get

/status_pages/{subdomain}/info_notices/{infoNoticeId}

Path parameters

subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

infoNoticeIdintegerRequired

The ID of an information notice

Responses

200

information notice object

application/json

403

You lack the necessary permissions to access this resource.

application/json

404

A resource with the provided ID was not found.

application/json

500

Unexpected error.

application/json

get/status_pages/{subdomain}/info_notices/{infoNoticeId}

GET /api/v2/status_pages/{subdomain}/info_notices/{infoNoticeId} HTTP/1.1
Host: statuspal.io
Accept: */*

{
  "info_notice": {
    "id": 89,
    "inserted_at": "2022-01-01T00:00:00",
    "updated_at": "2022-01-01T00:00:00",
    "title": "We are having issues with the DB connection",
    "featured_from": "2022-01-01T00:00:00",
    "featured_until": "2022-01-01T00:00:00",
    "service_ids": [
      1
    ],
    "updates": [
      {
        "id": 89,
        "inserted_at": "2022-01-01T00:00:00",
        "updated_at": "2022-01-01T00:00:00",
        "posted_at": "2022-01-01T00:00:00",
        "type": "issue",
        "description": "We have detected an issue with our CDN",
        "description_html": "<p>We have detected an issue with our CDN</p>",
        "translations": {
          "en": {
            "description": "English description"
          },
          "es": {
            "description": "Spanish description"
          }
        },
        "subscribers_notified_at": "2022-01-01T00:00:00",
        "tweet": true
      }
    ],
    "url": "https://status.google.com/info_notices/123",
    "translations": {
      "en": {
        "title": "English Title"
      },
      "es": {
        "title": "Spanish Title"
      }
    }
  }
}

Updates existing information notice

put

/status_pages/{subdomain}/info_notices/{infoNoticeId}

Authorizations

AuthorizationstringRequired

Path parameters

infoNoticeIdintegerRequired

The ID of an information notice

subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

Body

Responses

200

The information notice was updated

application/json

400

Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.

application/json

401

Authorization information is missing or invalid.

application/json

403

You lack the necessary permissions to access this resource.

application/json

404

A resource with the provided ID was not found.

application/json

422

There was a validation error

application/json

500

Unexpected error.

application/json

put/status_pages/{subdomain}/info_notices/{infoNoticeId}

PUT /api/v2/status_pages/{subdomain}/info_notices/{infoNoticeId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 493

{
  "info_notice": {
    "title": "We are having issues with the DB connection",
    "featured_from": "2022-01-01T00:00:00",
    "featured_until": "2022-01-01T00:00:00",
    "service_ids": [
      1
    ],
    "updates": [
      {
        "posted_at": "2022-01-01T00:00:00",
        "type": "issue",
        "description": "We have detected an issue with our CDN",
        "translations": {
          "en": {
            "description": "English description"
          },
          "es": {
            "description": "Spanish description"
          }
        },
        "notify": true,
        "tweet": true
      }
    ],
    "translations": {
      "en": {
        "title": "English Title"
      },
      "es": {
        "title": "Spanish Title"
      }
    }
  }
}

{
  "info_notice": {
    "id": 89,
    "inserted_at": "2022-01-01T00:00:00",
    "updated_at": "2022-01-01T00:00:00",
    "title": "We are having issues with the DB connection",
    "featured_from": "2022-01-01T00:00:00",
    "featured_until": "2022-01-01T00:00:00",
    "service_ids": [
      1
    ],
    "updates": [
      {
        "id": 89,
        "inserted_at": "2022-01-01T00:00:00",
        "updated_at": "2022-01-01T00:00:00",
        "posted_at": "2022-01-01T00:00:00",
        "type": "issue",
        "description": "We have detected an issue with our CDN",
        "description_html": "<p>We have detected an issue with our CDN</p>",
        "translations": {
          "en": {
            "description": "English description"
          },
          "es": {
            "description": "Spanish description"
          }
        },
        "subscribers_notified_at": "2022-01-01T00:00:00",
        "tweet": true
      }
    ],
    "url": "https://status.google.com/info_notices/123",
    "translations": {
      "en": {
        "title": "English Title"
      },
      "es": {
        "title": "Spanish Title"
      }
    }
  }
}

Deletes information notice permanently

delete

/status_pages/{subdomain}/info_notices/{infoNoticeId}

Authorizations

AuthorizationstringRequired

Path parameters

subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

infoNoticeIdintegerRequired

The ID of an information notice

Responses

200

Information notice deleted successfully

401

Authorization information is missing or invalid.

application/json

403

You lack the necessary permissions to access this resource.

application/json

404

A resource with the provided ID was not found.

application/json

500

Unexpected error.

application/json

delete/status_pages/{subdomain}/info_notices/{infoNoticeId}

DELETE /api/v2/status_pages/{subdomain}/info_notices/{infoNoticeId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*

No content