Integrations
The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
A status page's integrations
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
GET /api/v2/status_pages/{subdomain}/integrations HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"integrations": [
{
"id": 1,
"name": "newrelic",
"user": "123456",
"phone_number": "+1234567890",
"domain": "example.com",
"email_from_address": "notifications@example.com",
"key": "your-api-key",
"relay": "smtp.example.com",
"username": "smtp-user@smtp.example.com",
"port": 25,
"region": "us",
"settings": {
"enabled": true,
"api_key_type": "private"
}
}
]
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The integration created
Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
There was a validation error
Unexpected error.
POST /api/v2/status_pages/{subdomain}/integrations HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 364
{
"integration": {
"name": "newrelic",
"user": "123456",
"phone_number": "+1234567890",
"domain": "example.com",
"email_from_address": "notifications@example.com",
"key": "your-api-key",
"password": "your-password",
"relay": "smtp.example.com",
"username": "smtp-user@smtp.example.com",
"port": 25,
"region": "us",
"settings": {
"__type__": "common",
"enabled": true,
"api_key_type": "private"
}
}
}{
"integration": {
"id": 1,
"name": "newrelic",
"user": "123456",
"phone_number": "+1234567890",
"domain": "example.com",
"email_from_address": "notifications@example.com",
"key": "your-api-key",
"relay": "smtp.example.com",
"username": "smtp-user@smtp.example.com",
"port": 25,
"region": "us",
"settings": {
"enabled": true,
"api_key_type": "private"
}
}
}Get integration against given integration id
The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of integration
The integration details
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
GET /api/v2/status_pages/{subdomain}/integrations/{integrationId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"integration": {
"id": 1,
"name": "newrelic",
"user": "123456",
"phone_number": "+1234567890",
"domain": "example.com",
"email_from_address": "notifications@example.com",
"key": "your-api-key",
"relay": "smtp.example.com",
"username": "smtp-user@smtp.example.com",
"port": 25,
"region": "us",
"settings": {
"enabled": true,
"api_key_type": "private"
}
}
}The ID of integration
The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The integration updated
Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
There was a validation error
Unexpected error.
PUT /api/v2/status_pages/{subdomain}/integrations/{integrationId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 364
{
"integration": {
"name": "newrelic",
"user": "123456",
"phone_number": "+1234567890",
"domain": "example.com",
"email_from_address": "notifications@example.com",
"key": "your-api-key",
"password": "your-password",
"relay": "smtp.example.com",
"username": "smtp-user@smtp.example.com",
"port": 25,
"region": "us",
"settings": {
"__type__": "common",
"enabled": true,
"api_key_type": "private"
}
}
}{
"integration": {
"id": 1,
"name": "newrelic",
"user": "123456",
"phone_number": "+1234567890",
"domain": "example.com",
"email_from_address": "notifications@example.com",
"key": "your-api-key",
"relay": "smtp.example.com",
"username": "smtp-user@smtp.example.com",
"port": 25,
"region": "us",
"settings": {
"enabled": true,
"api_key_type": "private"
}
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of integration
Integration deleted successfully
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
DELETE /api/v2/status_pages/{subdomain}/integrations/{integrationId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated