Skip to content

feat(events): add doc for missed_database_maintenance #698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EtienneM merged 1 commit into from
Sep 18, 2026
Merged

feat(events): add doc for missed_database_maintenance #698

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion _scalingo_api/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1913,7 +1913,7 @@ Example object:

* **Database Maintenance Completed**

_When:_ A maintenance as completed on your database
_When:_ A maintenance has completed on your database
`type=complete_database_maintenance`

{:.table}
Expand Down Expand Up @@ -1953,6 +1953,48 @@ Example object:

--- row ---

* **Database Maintenance Missed**

_When:_ A maintenance has been postponed to a later window
`type=missed_database_maintenance`

{:.table}
| field | type | description |
| --------------------------- | -------- | -------------------------------------------------- |
| maintenance_id | string | The related maintenance ID |
| addon_name | string | The related addon name |
| maintenance_type | string | The type of maintenance executed |
| maintenance_window_in_hours | integer | The maintenance window duration (in hours) |
| next_maintenance_window | datetime | The beginning date of your next maintenance window |

||| col |||

Example object:

```json
{
"id": "650312574002c001afcdf988",
"created_at": "2023-09-14T14:01:59.916Z",
"type": "missed_database_maintenance",
"app_id": "649e9d0389bca600016ea61b",
"app_name": "sample-go-martini",
"user": {
"username": "johndoe",
"email": "john@doe.com",
"id": "us-0e6d8e46-5cd0-42a4-acba-372b2be605ac"
},
"type_data": {
"addon_name": "Redis",
"maintenance_id": "6503020ba8acb51a3278cf81",
"maintenance_type": "no-op",
"maintenance_window_in_hours": 8,
"next_maintenance_window": "2023-09-14T21:00:00.000Z"
}
}
```

--- row ---

* **Database Backup Succeeded**

_When:_ A database backup has been successfully completed
Expand Down