post_updates

Creates, updates, deletes, gets or lists a post_updates resource.

Overview

Name	post_updates
Type	Resource
Id	pagerduty.status_pages.post_updates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The ID of the Post Update.
impacted_services	array	Impacted services represent the status page services affected by a post update, and its impact.
message	string	The message of the Post Update.
notify_subscribers	boolean	Determines if the subscribers should be notified of the Post Update.
post	object	Status Page Post
reported_at	string (date-time)	The date and time the Post Update was reported.
reviewed_status	string	The status of the Post Updates to retrieve. (approved, not_reviewed)
self	string	The path to which the Post Update resource is accessible.
severity	object	Status Page Severity
status	object	Status Page Status
type	string	The type of the object returned by the API - in this case, a Status Page Post Update.
update_frequency_ms	integer	The frequency of the next Post Update in milliseconds.

list

Name	Datatype	Description
id	string	The ID of the Post Update.
impacted_services	array	Impacted services represent the status page services affected by a post update, and its impact.
message	string	The message of the Post Update.
notify_subscribers	boolean	Determines if the subscribers should be notified of the Post Update.
post	object	Status Page Post
reported_at	string (date-time)	The date and time the Post Update was reported.
reviewed_status	string	The status of the Post Updates to retrieve. (approved, not_reviewed)
self	string	The path to which the Post Update resource is accessible.
severity	object	Status Page Severity
status	object	Status Page Status
type	string	The type of the object returned by the API - in this case, a Status Page Post Update.
update_frequency_ms	integer	The frequency of the next Post Update in milliseconds.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, post_id, post_update_id		Get a Post Update for a Post by Post ID and Post Update ID.<br /><br />Scoped OAuth requires: status_pages.read<br />
list	select	id, post_id	reviewed_status	List Post Updates for a Status Page by Status Page ID and Post ID.<br /><br />Scoped OAuth requires: status_pages.read<br />
create	insert	id, post_id, post_update		Create a Post Update for a Post by Post ID.<br /><br />Scoped OAuth requires: status_pages.write<br />
update	update	id, post_id, post_update_id, post_update		Update a Post Update for a Post by Post ID and Post Update ID.<br /><br />Scoped OAuth requires: status_pages.write<br />
delete	delete	id, post_id, post_update_id		Delete a Post Update for a Post by Post ID and Post Update ID.<br /><br />Scoped OAuth requires: status_pages.write<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the resource.
post_id	string	The ID of the Status Page Post.
post_update_id	string	The ID of the Status Page Post Update.
reviewed_status	string	Filter by the reviewed status of the Post Update to retrieve.

SELECT examples

get

Get a Post Update for a Post by Post ID and Post Update ID.<br /><br />Scoped OAuth requires: status_pages.read<br />

SELECT
id,
impacted_services,
message,
notify_subscribers,
post,
reported_at,
reviewed_status,
self,
severity,
status,
type,
update_frequency_ms
FROM pagerduty.status_pages.post_updates
WHERE id = '{{ id }}' -- required
AND post_id = '{{ post_id }}' -- required
AND post_update_id = '{{ post_update_id }}' -- required
;

list

List Post Updates for a Status Page by Status Page ID and Post ID.<br /><br />Scoped OAuth requires: status_pages.read<br />

SELECT
id,
impacted_services,
message,
notify_subscribers,
post,
reported_at,
reviewed_status,
self,
severity,
status,
type,
update_frequency_ms
FROM pagerduty.status_pages.post_updates
WHERE id = '{{ id }}' -- required
AND post_id = '{{ post_id }}' -- required
AND reviewed_status = '{{ reviewed_status }}'
;

INSERT examples

create

Create a Post Update for a Post by Post ID.<br /><br />Scoped OAuth requires: status_pages.write<br />

INSERT INTO pagerduty.status_pages.post_updates (
post_update,
id,
post_id
)
SELECT 
'{{ post_update }}' /* required */,
'{{ id }}',
'{{ post_id }}'
RETURNING
post_update
;

Manifest

# Description fields are for documentation purposes
- name: post_updates
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the post_updates resource.
  - name: post_id
    value: "{{ post_id }}"
    description: Required parameter for the post_updates resource.
  - name: post_update
    description: |
      Attributes for Post Update creation/update
    value:
      self: "{{ self }}"
      post:
        id: "{{ id }}"
        type: "{{ type }}"
      message: "{{ message }}"
      status:
        id: "{{ id }}"
        type: "{{ type }}"
      severity:
        id: "{{ id }}"
        type: "{{ type }}"
      impacted_services:
        - service:
            id: "{{ id }}"
            type: "{{ type }}"
          impact:
            id: "{{ id }}"
            type: "{{ type }}"
      update_frequency_ms: {{ update_frequency_ms }}
      notify_subscribers: {{ notify_subscribers }}
      reported_at: "{{ reported_at }}"
      type: "{{ type }}"

UPDATE examples

update

Update a Post Update for a Post by Post ID and Post Update ID.<br /><br />Scoped OAuth requires: status_pages.write<br />

UPDATE pagerduty.status_pages.post_updates
SET 
post_update = '{{ post_update }}'
WHERE 
id = '{{ id }}' --required
AND post_id = '{{ post_id }}' --required
AND post_update_id = '{{ post_update_id }}' --required
AND post_update = '{{ post_update }}' --required
RETURNING
post_update;

DELETE examples

delete

Delete a Post Update for a Post by Post ID and Post Update ID.<br /><br />Scoped OAuth requires: status_pages.write<br />

DELETE FROM pagerduty.status_pages.post_updates
WHERE id = '{{ id }}' --required
AND post_id = '{{ post_id }}' --required
AND post_update_id = '{{ post_update_id }}' --required
;