export const metadata = {
title: "Status Page Scheduled Maintenance - OnlineOrNot API Documentation",
description:
"Schedule and manage planned maintenance windows on status pages",
}
## Schedule maintenance for a status page {{ tag: 'POST', label: '/v1/status_pages/{status_page_id}/scheduled_maintenance' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Returns the newly created scheduled maintenance|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request - validation error|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request POST \
--url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"title":"Database upgrade","description":"Upgrading to PostgreSQL 16","start_date":"2024-03-01T02:00:00.000Z","duration_minutes":60,"components_affected":["comp_abc123","comp_def456"],"notifications":{"an_hour_before":false,"at_start":true,"at_end":true}}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"title\":\"Database upgrade\",\"description\":\"Upgrading to PostgreSQL 16\",\"start_date\":\"2024-03-01T02:00:00.000Z\",\"duration_minutes\":60,\"components_affected\":[\"comp_abc123\",\"comp_def456\"],\"notifications\":{\"an_hour_before\":false,\"at_start\":true,\"at_end\":true}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"title\":\"Database upgrade\",\"description\":\"Upgrading to PostgreSQL 16\",\"start_date\":\"2024-03-01T02:00:00.000Z\",\"duration_minutes\":60,\"components_affected\":[\"comp_abc123\",\"comp_def456\"],\"notifications\":{\"an_hour_before\":false,\"at_start\":true,\"at_end\":true}}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"title":"Database upgrade","description":"Upgrading to PostgreSQL 16","start_date":"2024-03-01T02:00:00.000Z","duration_minutes":60,"components_affected":["comp_abc123","comp_def456"],"notifications":{"an_hour_before":false,"at_start":true,"at_end":true}}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
request.body = "{\"title\":\"Database upgrade\",\"description\":\"Upgrading to PostgreSQL 16\",\"start_date\":\"2024-03-01T02:00:00.000Z\",\"duration_minutes\":60,\"components_affected\":[\"comp_abc123\",\"comp_def456\"],\"notifications\":{\"an_hour_before\":false,\"at_start\":true,\"at_end\":true}}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance"
payload = {
"title": "Database upgrade",
"description": "Upgrading to PostgreSQL 16",
"start_date": "2024-03-01T02:00:00.000Z",
"duration_minutes": 60,
"components_affected": ["comp_abc123", "comp_def456"],
"notifications": {
"an_hour_before": False,
"at_start": True,
"at_end": True
}
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"title": "API is inaccessible",
"impact": "MAJOR_OUTAGE",
"started": "2021-01-01T00:00:00.000Z",
"ended": "2021-02-01T00:00:00.000Z",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-02-01T00:00:00.000Z",
"start_date": "2021-01-01T00:00:00.000Z",
"duration_minutes": 60,
"notifications": {
"an_hour_before": false,
"at_start": true,
"at_end": true
},
"components": [
{
"id": "comp123",
"name": "API Server"
}
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Retrieve a scheduled maintenance {{ tag: 'GET', label: '/v1/status_pages/{status_page_id}/scheduled_maintenance/{scheduled_maintenance_id}' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns the scheduled maintenance|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request GET \
--url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"title": "API is inaccessible",
"impact": "MAJOR_OUTAGE",
"started": "2021-01-01T00:00:00.000Z",
"ended": "2021-02-01T00:00:00.000Z",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-02-01T00:00:00.000Z",
"start_date": "2021-01-01T00:00:00.000Z",
"duration_minutes": 60,
"notifications": {
"an_hour_before": false,
"at_start": true,
"at_end": true
},
"components": [
{
"id": "comp123",
"name": "API Server"
}
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Update a scheduled maintenance (only before it has started) {{ tag: 'PATCH', label: '/v1/status_pages/{status_page_id}/scheduled_maintenance/{scheduled_maintenance_id}' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns the updated scheduled maintenance|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request - cannot update after maintenance has started|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request PATCH \
--url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"title":"Database upgrade v2","start_date":"2024-03-02T02:00:00.000Z","duration_minutes":120}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4", {
"method": "PATCH",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"title\":\"Database upgrade v2\",\"start_date\":\"2024-03-02T02:00:00.000Z\",\"duration_minutes\":120}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"title\":\"Database upgrade v2\",\"start_date\":\"2024-03-02T02:00:00.000Z\",\"duration_minutes\":120}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4")
.patch(body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"title":"Database upgrade v2","start_date":"2024-03-02T02:00:00.000Z","duration_minutes":120}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
request.body = "{\"title\":\"Database upgrade v2\",\"start_date\":\"2024-03-02T02:00:00.000Z\",\"duration_minutes\":120}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4"
payload = {
"title": "Database upgrade v2",
"start_date": "2024-03-02T02:00:00.000Z",
"duration_minutes": 120
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("PATCH", url, json=payload, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"title": "API is inaccessible",
"impact": "MAJOR_OUTAGE",
"started": "2021-01-01T00:00:00.000Z",
"ended": "2021-02-01T00:00:00.000Z",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-02-01T00:00:00.000Z",
"start_date": "2021-01-01T00:00:00.000Z",
"duration_minutes": 60,
"notifications": {
"an_hour_before": false,
"at_start": true,
"at_end": true
},
"components": [
{
"id": "comp123",
"name": "API Server"
}
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Delete a scheduled maintenance {{ tag: 'DELETE', label: '/v1/status_pages/{status_page_id}/scheduled_maintenance/{scheduled_maintenance_id}' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns the deleted scheduled maintenance's ID|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request DELETE \
--url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4", {
"method": "DELETE",
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4")
.delete(null)
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4/scheduled_maintenance/sm1b2c3d4"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "sm1b2c3d4"
},
"success": true,
"errors": [],
"messages": []
}
```
---