Incidents

Resource

Methods

Incident.updates() → Generator[cachetclient.v1.incidents.Incident, None, None]

Generator[‘Incident’, None, None]: Incident updates for this issue

Incident.update()

Posts the values in the resource to the server.

Example:

# Change an attribute and save the resource
>> resource.value = something
>> updated_resource = resource.update()
Returns:The updated resource from the server
Incident.delete() → None

Deletes the resource from the server

Attributes

Incident.id

unique id of the incident

Type:int
Incident.component_id

Get or set component id for this incident

Type:int
Incident.name

Get or set name/title of the incident

Type:str
Incident.message

Get or set message

Type:str
Incident.notify

Get or set notification flag

Type:bool
Incident.status

Get or set status. See enums

Type:int
Incident.human_status

Human representation of the status

Type:str
Incident.visible

Get or set visibility of the indcinent

Type:bool
Incident.scheduled_at

Scheduled time. This is used for scheduled events like maintenance in Cachet 2.3 were incident status is INCIDENT_SCHEDULED. 2.4 has its own schedule resource and endpoints.

Type:datetime
Incident.created_at

When the issue was created

Type:datetime
Incident.updated_at

Last time the issue was updated

Type:datetime
Incident.deleted_at

When the issue was deleted

Type:datetime

Manager

IncidentManager.create(*, name: str, message: str, status: int, visible: bool = True, component_id: int = None, component_status: int = None, notify: bool = True, created_at: datetime.datetime = None, template: str = None, template_vars: List[str] = None) → cachetclient.v1.incidents.Incident

Create and general issue or issue for a component. component_id and component_status must be supplied when making a component issue.

Keyword Arguments:
 
  • name (str) – Name/title of the issue
  • message (str) – Mesage body for the issue
  • status (int) – Status of the incident (see enums)
  • visible (bool) – Publicly visible incident
  • component_id (int) – The component to update
  • component_status (int) – The status to apply on component
  • notify (bool) – If users should be notified
  • created_at – when the indicent was created
  • template (str) – Slug of template to use
  • template_vars (list) – Variables to the template
Returns:

Incident instance
IncidentManager.update(incident_id: int, name: str = None, message: str = None, status: int = None, visible: bool = None, component_id: int = None, component_status: int = None, notify: bool = True, created_at: datetime.datetime = None, template: str = None, template_vars: List[str] = None, **kwargs) → cachetclient.v1.incidents.Incident

Update an incident.

Parameters:

incident_id (int) – The incident to update
Keyword Arguments:
 
  • name (str) – Name/title of the issue
  • message (str) – Mesage body for the issue
  • status (int) – Status of the incident (see enums)
  • visible (bool) – Publicly visible incident
  • component_id (int) – The component to update
  • component_status (int) – The status to apply on component
  • notify (bool) – If users should be notified
  • created_at – when the indicent was created
  • template (str) – Slug of template to use
  • template_vars (list) – Variables to the template
Returns:

Updated incident Instance
IncidentManager.list(page: int = 1, per_page: int = 1) → Generator[cachetclient.v1.incidents.Incident, None, None]

List all incidents paginated

Keyword Arguments:
 
  • page (int) – Page to start on
  • per_page (int) – Entires per page
Returns:

Generator of :py:data:`Incident`s
IncidentManager.get(incident_id: int) → cachetclient.v1.incidents.Incident

Get a single incident

Parameters:incident_id (int) – The incident id to get
Returns:Incident instance
Raises:requests.exception.HttpError – if incident do not exist
IncidentManager.count() → int

Count the number of incidents

Returns:Total number of incidents
Return type:int
IncidentManager.delete(incident_id: int) → None

Delete an incident

Parameters:incident_id (int) – The incident id