Alerts API


Create a database server alert

POST /database-servers/:database_server_id/alerts

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
            "alert": {
              "message": "Iste sunt non qui et quasi.",
              "description": "hack",
              "severity": "warning",
              "name": "firewall",
              "external_id": "a6608744-22b1-4b5a-8676-ee8334354744"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "cd28a5ca-decd-4f7d-bcb9-27cb17a2a460",
              "acknowledged": false,
              "created_at": "2017-10-10T15:48:52+00:00",
              "description": "hack",
              "external_id": "a6608744-22b1-4b5a-8676-ee8334354744",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Iste sunt non qui et quasi.",
              "name": "firewall",
              "resource": "https://api.engineyard.com/database-servers/4841a72a-5faf-41b6-96fa-be7728f801e8",
              "severity": "warning",
              "updated_at": "2017-10-10T15:48:52+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/3322741e-8a10-42a2-a807-61a3c4db1941",
              "environment": null
            }
          }
            
          








Create a server alert

POST /servers/:server_id/alerts

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
            "alert": {
              "message": "Accusamus dolorum aspernatur doloremque voluptas qui.",
              "description": "calculate",
              "severity": "warning",
              "name": "transmitter",
              "external_id": "12a02807-9840-4584-9425-1bce30111e3b"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "1eb7b121-a205-4783-9a3a-baccacaef416",
              "acknowledged": false,
              "created_at": "2017-10-10T15:48:47+00:00",
              "description": "calculate",
              "external_id": "12a02807-9840-4584-9425-1bce30111e3b",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Accusamus dolorum aspernatur doloremque voluptas qui.",
              "name": "transmitter",
              "resource": "https://api.engineyard.com/servers/27",
              "severity": "warning",
              "updated_at": "2017-10-10T15:48:47+00:00",
              "type": "server",
              "account": "https://api.engineyard.com/accounts/9f80b250-dc2e-4413-9270-8b9b6afb6722",
              "environment": "https://api.engineyard.com/environments/84"
            }
          }
            
          








Get a alert

GET /alerts/:alert

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "453d7835-799d-4841-85d9-4e64efc47733",
              "acknowledged": false,
              "created_at": "2017-10-10T15:49:45+00:00",
              "description": "Voluptatem rerum tempora et perferendis.",
              "external_id": "9ee6a30424ae361112de35e3af845ea9",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Vero et.",
              "name": "b55cc1c7fc511a96",
              "resource": "https://api.engineyard.com/database-servers/67151ece-c3fe-491b-b956-9c7f68049360",
              "severity": "warning",
              "updated_at": "2017-10-10T15:49:45+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/fbabc0c7-7686-428a-b9ec-bf3b1651e06e",
              "environment": null
            }
          }
            
          








List alerts

GET /alerts

Parameters

external_id
required: false
Filter by infrastructure ID (i.e., 'RdsDatabaseConnectionWarning')
environment
required: false
Filter by alerts on servers connected to a specific environment
database_service
required: false
Filter by database service
server
required: false
Filter by server
type
required: false
Filter by type (i.e., 'server' or 'database_server')
severity
required: false
Filter by severity
name
required: false
Filter by name
finished_at
required: false
Filter by whether or not the alert is finished
unacknowledged
required: false
Filter by alerts that have not been acknowledged by a support engineer, regardless of its finished state

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alerts": [
              {
                "id": "36843e60-0207-4c6e-a751-97b12dc842df",
                "acknowledged": false,
                "created_at": "2017-10-10T15:48:59+00:00",
                "description": "Doloribus quia est.",
                "external_id": "049a308792a4a576aa93f37d44beba5b",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Repellendus repellat.",
                "name": "f89b37b90e333e52",
                "resource": "https://api.engineyard.com/servers/28",
                "severity": "warning",
                "updated_at": "2017-10-10T15:48:59+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/0aced034-b5b8-40a0-8058-08b54279c776",
                "environment": "https://api.engineyard.com/environments/85"
              },
              {
                "id": "6240c81a-53a1-4bef-9c97-730e9f2e25d3",
                "acknowledged": false,
                "created_at": "2017-10-10T15:48:59+00:00",
                "description": "Recusandae dolorem sed ea.",
                "external_id": "4386f7b1aa3f5c0b7761e79e2da07f12",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Incidunt possimus repellat qui.",
                "name": "7c608b4577f78050",
                "resource": "https://api.engineyard.com/servers/28",
                "severity": "warning",
                "updated_at": "2017-10-10T15:48:59+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/0aced034-b5b8-40a0-8058-08b54279c776",
                "environment": "https://api.engineyard.com/environments/85"
              }
            ]
          }
            
          








List alerts by environment

GET /environments/:environment/alerts

Parameters

external_id
required: false
Filter by infrastructure ID (i.e., 'RdsDatabaseConnectionWarning')
database_service
required: false
Filter by database service
severity
required: false
Filter by severity
type
required: false
Filter by type (i.e., 'server' or 'database_server')
name
required: false
Filter by name

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alerts": [
              {
                "id": "126ba50c-7c2b-4131-ba0d-82a47712f79b",
                "acknowledged": false,
                "created_at": "2017-10-10T15:49:29+00:00",
                "description": "Nulla illo aliquam magni.",
                "external_id": "ff9acba53eb58508ba565d7d72ce260b",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Maiores sint consequuntur.",
                "name": "7daaa26140046872",
                "resource": "https://api.engineyard.com/servers/30",
                "severity": "warning",
                "updated_at": "2017-10-10T15:49:29+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/e0044ca4-d4dc-49e1-94e4-dcbba101ff63",
                "environment": "https://api.engineyard.com/environments/87"
              },
              {
                "id": "3a8626f8-c5a5-42ed-b9bd-3f0082e3a2d6",
                "acknowledged": false,
                "created_at": "2017-10-10T15:49:29+00:00",
                "description": "Provident ad.",
                "external_id": "00192b07aea1638e06ab8cd4a765eef0",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Tempora voluptatibus voluptas.",
                "name": "4755855b9fe81df4",
                "resource": "https://api.engineyard.com/servers/30",
                "severity": "critical",
                "updated_at": "2017-10-10T15:49:29+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/e0044ca4-d4dc-49e1-94e4-dcbba101ff63",
                "environment": "https://api.engineyard.com/environments/87"
              }
            ]
          }
            
          








List alerts that are finished but not acknowledged

GET /alerts

Parameters

external_id
required: false
Filter by infrastructure ID (i.e., 'RdsDatabaseConnectionWarning')
environment
required: false
Filter by alerts on servers connected to a specific environment
database_service
required: false
Filter by database service
server
required: false
Filter by server
type
required: false
Filter by type (i.e., 'server' or 'database_server')
severity
required: false
Filter by severity
name
required: false
Filter by name
finished_at
required: false
Filter by whether or not the alert is finished
unacknowledged
required: false
Filter by alerts that have not been acknowledged by a support engineer, regardless of its finished state

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alerts": [
              {
                "id": "3ba99446-ccda-4be0-abce-2816853b2f1b",
                "acknowledged": false,
                "created_at": "2017-10-10T15:49:14+00:00",
                "description": "Autem eum quaerat pariatur.",
                "external_id": "a17f4d635ab86f29b718c997824713ed",
                "started_at": null,
                "finished_at": "2017-10-10T15:49:14+00:00",
                "ignored": false,
                "message": "Eligendi.",
                "name": "af7ebb6d636b0528",
                "resource": "https://api.engineyard.com/servers/29",
                "severity": "critical",
                "updated_at": "2017-10-10T15:49:14+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/6ef4092a-8d23-472f-8c7e-a98c9c6f1d8c",
                "environment": "https://api.engineyard.com/environments/86"
              }
            ]
          }
            
          








Update a alert

PUT /alerts/:alert_id

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
            "alert": {
              "finished_at": "2017-10-10T15:48:57+00:00",
              "acknowledged": true,
              "message": "Nostrum nobis consequatur et beatae quis cupiditate.",
              "started_at": "2017-10-10T15:48:57+00:00"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "6ff47987-f831-466d-beac-31eaf7679aad",
              "acknowledged": true,
              "created_at": "2017-10-10T15:48:56+00:00",
              "description": "Molestias numquam et molestiae laborum.",
              "external_id": "0b3229590d51294f761835818fa72473",
              "started_at": "2017-10-10T15:48:57+00:00",
              "finished_at": "2017-10-10T15:48:57+00:00",
              "ignored": false,
              "message": "Nostrum nobis consequatur et beatae quis cupiditate.",
              "name": "1afc65302c6af8a5",
              "resource": "https://api.engineyard.com/database-servers/04323bce-aeb4-4bc7-af02-82becd2db597",
              "severity": "critical",
              "updated_at": "2017-10-10T15:48:57+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/2aac4368-4aa7-4d02-be4f-36f915b031c1",
              "environment": null
            }
          }