export const metadata = {
title: "Maintenance Windows - OnlineOrNot API Documentation",
description:
"Configure maintenance windows to suppress alerts during planned downtime",
}
## List all maintenance windows {{ tag: 'GET', label: '/v1/maintenance-windows' }}
*Retrieve a paginated list of all maintenance windows*
### 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 a list of maintenance windows|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized - Invalid or missing API token|
|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/maintenance-windows \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/maintenance-windows", {
"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/maintenance-windows")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/maintenance-windows');
$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/maintenance-windows")
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/maintenance-windows"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": [
{
"id": "abc123def456",
"name": "Weekly Maintenance",
"start_date": "09:00",
"duration_minutes": 60,
"timezone": "America/New_York",
"days_of_week": [
"MONDAY",
"WEDNESDAY",
"FRIDAY"
],
"status": "ENABLED"
}
],
"result_info": {
"page": 1,
"per_page": 20,
"count": 1,
"total_count": 1
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Create a new maintenance window {{ tag: 'POST', label: '/v1/maintenance-windows' }}
*Create a new maintenance window with associated checks and heartbeats*
### 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 created maintenance window|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request - Invalid input (e.g., invalid check/heartbeat IDs, empty name)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized - Invalid or missing API token|
|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/maintenance-windows \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"name":"Weekly Server Maintenance","start_date":"03:00","duration_minutes":60,"timezone":"America/New_York","days_of_week":["SUNDAY"]}'
```
```javascript
fetch("https://api.onlineornot.com/v1/maintenance-windows", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"Weekly Server Maintenance\",\"start_date\":\"03:00\",\"duration_minutes\":60,\"timezone\":\"America/New_York\",\"days_of_week\":[\"SUNDAY\"]}"
})
.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, "{\"name\":\"Weekly Server Maintenance\",\"start_date\":\"03:00\",\"duration_minutes\":60,\"timezone\":\"America/New_York\",\"days_of_week\":[\"SUNDAY\"]}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/maintenance-windows")
.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/maintenance-windows');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"Weekly Server Maintenance","start_date":"03:00","duration_minutes":60,"timezone":"America/New_York","days_of_week":["SUNDAY"]}');
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/maintenance-windows")
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 = "{\"name\":\"Weekly Server Maintenance\",\"start_date\":\"03:00\",\"duration_minutes\":60,\"timezone\":\"America/New_York\",\"days_of_week\":[\"SUNDAY\"]}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/maintenance-windows"
payload = {
"name": "Weekly Server Maintenance",
"start_date": "03:00",
"duration_minutes": 60,
"timezone": "America/New_York",
"days_of_week": ["SUNDAY"]
}
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": "abc123def456",
"name": "Weekly Maintenance",
"start_date": "09:00",
"duration_minutes": 60,
"timezone": "America/New_York",
"days_of_week": [
"MONDAY",
"WEDNESDAY",
"FRIDAY"
],
"status": "ENABLED",
"checks": [
"abc123",
"def456"
],
"heartbeats": [
"ghi789"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Get a maintenance window by ID {{ tag: 'GET', label: '/v1/maintenance-windows/{maintenance_window_id}' }}
*Retrieve a maintenance window with associated checks and heartbeats*
### 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 a maintenance window with associated check and heartbeat IDs|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized - Invalid or missing API token|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found - Maintenance window does not exist or belongs to different organization|
|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/maintenance-windows/abc123def456 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/maintenance-windows/abc123def456", {
"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/maintenance-windows/abc123def456")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/maintenance-windows/abc123def456');
$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/maintenance-windows/abc123def456")
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/maintenance-windows/abc123def456"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "abc123def456",
"name": "Weekly Maintenance",
"start_date": "09:00",
"duration_minutes": 60,
"timezone": "America/New_York",
"days_of_week": [
"MONDAY",
"WEDNESDAY",
"FRIDAY"
],
"status": "ENABLED",
"checks": [
"abc123",
"def456"
],
"heartbeats": [
"ghi789"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Update a maintenance window {{ tag: 'PATCH', label: '/v1/maintenance-windows/{maintenance_window_id}' }}
*Update a maintenance window. All fields are optional - only provided fields will be updated. Updating checks or heartbeats replaces existing associations.*
### 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 maintenance window|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request - Invalid input (e.g., invalid check/heartbeat IDs, no fields to update)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized - Invalid or missing API token|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found - Maintenance window does not exist or belongs to different organization|
|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/maintenance-windows/abc123def456 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"name":"Updated Maintenance Window"}'
```
```javascript
fetch("https://api.onlineornot.com/v1/maintenance-windows/abc123def456", {
"method": "PATCH",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"Updated Maintenance Window\"}"
})
.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, "{\"name\":\"Updated Maintenance Window\"}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/maintenance-windows/abc123def456")
.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/maintenance-windows/abc123def456');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"Updated Maintenance Window"}');
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/maintenance-windows/abc123def456")
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 = "{\"name\":\"Updated Maintenance Window\"}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/maintenance-windows/abc123def456"
payload = {"name": "Updated Maintenance Window"}
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": "abc123def456",
"name": "Weekly Maintenance",
"start_date": "09:00",
"duration_minutes": 60,
"timezone": "America/New_York",
"days_of_week": [
"MONDAY",
"WEDNESDAY",
"FRIDAY"
],
"status": "ENABLED",
"checks": [
"abc123",
"def456"
],
"heartbeats": [
"ghi789"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Delete a maintenance window {{ tag: 'DELETE', label: '/v1/maintenance-windows/{maintenance_window_id}' }}
*Delete a maintenance window and all its associations with checks and heartbeats*
### 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 maintenance window ID|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized - Invalid or missing API token|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found - Maintenance window does not exist or belongs to different organization|
|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/maintenance-windows/abc123def456 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/maintenance-windows/abc123def456", {
"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/maintenance-windows/abc123def456")
.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/maintenance-windows/abc123def456');
$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/maintenance-windows/abc123def456")
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/maintenance-windows/abc123def456"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "abc123def456"
},
"success": true,
"errors": [],
"messages": []
}
```
---