histories

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

Overview

Name	histories
Type	Resource
Id	ovh.notification.histories

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the notification
attachments	array	Attachments linked to this notification
categories	array	Categories of the notification
contacts	array	Contact attempts made for this notification
created_at	string (date-time)	Date at which the notification was sent (wire: createdAt)
html	string	HTML text of the notification
priority	string	Priority of the notification (HIGH, LOW, MEDIUM)
summary	string	Summary of the notification
tags	object	Tags of the notification
text	string	Raw text of the notification
title	string	Title of the notification

list

Notification sent to this account

Name	Datatype	Description
id	string (uuid)	Unique identifier of the notification
attachments	array	Attachments linked to this notification
categories	array	Categories of the notification
contacts	array	Contact attempts made for this notification
created_at	string (date-time)	Date at which the notification was sent (wire: createdAt)
html	string	HTML text of the notification
priority	string	Priority of the notification (HIGH, LOW, MEDIUM)
summary	string	Summary of the notification
tags	object	Tags of the notification
text	string	Raw text of the notification
title	string	Title of the notification

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	notification_id		Retrieve information about a notification sent to you
list	select		x_pagination_cursor, x_pagination_size, category, created_after, created_before, priority, sort_created_at, tags, title_contains, with_summary	Retrieve every notification sent to you

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
notification_id	string (uuid)	Notification ID (wire: notificationId)
category	array	Select notifications belonging to one of these categories
created_after	string (date-time)	Select notifications created after this date (wire: createdAfter)
created_before	string (date-time)	Select notifications created before this date (wire: createdBefore)
priority	array	Select notifications matching one of these priorities
sort_created_at	string	Sort by createdAt field. Defaults to DESC. (wire: sortCreatedAt)
tags	object	Filter notifications using tag filters
title_contains	string	Select notifications which title contains this text (wire: titleContains)
with_summary	boolean	Add summary field to response (wire: withSummary)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Retrieve information about a notification sent to you

SELECT
id,
attachments,
categories,
contacts,
created_at,
html,
priority,
summary,
tags,
text,
title
FROM ovh.notification.histories
WHERE notification_id = '{{ notification_id }}' -- required
;

list

Retrieve every notification sent to you

SELECT
id,
attachments,
categories,
contacts,
created_at,
html,
priority,
summary,
tags,
text,
title
FROM ovh.notification.histories
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND category = '{{ category }}'
AND created_after = '{{ created_after }}'
AND created_before = '{{ created_before }}'
AND priority = '{{ priority }}'
AND sort_created_at = '{{ sort_created_at }}'
AND tags = '{{ tags }}'
AND title_contains = '{{ title_contains }}'
AND with_summary = '{{ with_summary }}'
;