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": "Est eum.",
              "description": "program",
              "severity": "warning",
              "name": "capacitor",
              "external_id": "d747386f-f2fa-453d-9b4b-d409d9352fa5"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "dad91131-cb7d-4932-8736-75988f06d048",
              "acknowledged": false,
              "created_at": "2018-04-12T18:00:58+00:00",
              "description": "program",
              "external_id": "d747386f-f2fa-453d-9b4b-d409d9352fa5",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Est eum.",
              "name": "capacitor",
              "resource": "https://api.engineyard.com/database-servers/ae51c5ab-4183-44c9-b208-daf416a46ae1",
              "severity": "warning",
              "updated_at": "2018-04-12T18:00:58+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/0f90cc0b-fab4-4fd8-8a8c-340769f546e7",
              "environment": null
            }
          }
            
          








Create a server alert

POST /servers/:server_id/alerts

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
            "alert": {
              "message": "Facilis nobis aut tempora.",
              "description": "navigate",
              "severity": "warning",
              "name": "monitor",
              "external_id": "0c1aee9e-176e-46c5-9137-bff19c857d07"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "6f523b30-5369-4a5d-b8b1-12011344eb4e",
              "acknowledged": false,
              "created_at": "2018-04-12T18:00:52+00:00",
              "description": "navigate",
              "external_id": "0c1aee9e-176e-46c5-9137-bff19c857d07",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Facilis nobis aut tempora.",
              "name": "monitor",
              "resource": "https://api.engineyard.com/servers/27",
              "severity": "warning",
              "updated_at": "2018-04-12T18:00:52+00:00",
              "type": "server",
              "account": "https://api.engineyard.com/accounts/9ffc398b-0d31-4743-802a-5b01c6dc89e6",
              "environment": "https://api.engineyard.com/environments/84"
            }
          }
            
          








Get a alert

GET /alerts/:alert

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "6eac5b15-0d37-47f7-97a3-9ee16b6d2327",
              "acknowledged": false,
              "created_at": "2018-04-12T18:01:51+00:00",
              "description": "Voluptas ea vitae.",
              "external_id": "0cd5c60866b9ca61c9ba1a1328aec4a5",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Et non fugiat.",
              "name": "1b04d6bedcd9955c",
              "resource": "https://api.engineyard.com/database-servers/7c42df52-88fa-4618-86cc-439754fb0b9a",
              "severity": "warning",
              "updated_at": "2018-04-12T18:01:51+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/7bf8c576-0e93-4cdd-9e25-c6924f3c52e5",
              "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

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alerts": [
              {
                "id": "797296b5-f8dd-46df-bf8d-4e1a9830c974",
                "acknowledged": false,
                "created_at": "2018-04-12T18:01:06+00:00",
                "description": "Praesentium minima est sed omnis.",
                "external_id": "b3bf5ddc10c64a1a87f02669cb6fe8f6",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Ut.",
                "name": "f91fc566dd88b652",
                "resource": "https://api.engineyard.com/servers/28",
                "severity": "critical",
                "updated_at": "2018-04-12T18:01:06+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/602332c7-26c4-4467-8bb2-8fddcca8d134",
                "environment": "https://api.engineyard.com/environments/85"
              },
              {
                "id": "aba1b522-8641-4cc9-b34c-8027b653d8da",
                "acknowledged": false,
                "created_at": "2018-04-12T18:01:06+00:00",
                "description": "Quia.",
                "external_id": "c42b47afc9df1dac60520c19928ddd23",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Ut soluta iste.",
                "name": "94e7f3142dc714bc",
                "resource": "https://api.engineyard.com/servers/28",
                "severity": "warning",
                "updated_at": "2018-04-12T18:01:06+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/602332c7-26c4-4467-8bb2-8fddcca8d134",
                "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

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alerts": [
              {
                "id": "d3f79997-00bc-40c4-95f2-9eb24e740a99",
                "acknowledged": false,
                "created_at": "2018-04-12T18:01:36+00:00",
                "description": "Ratione est dicta labore.",
                "external_id": "8e99659d26405b90412059bbb1e7eb6e",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Et minima.",
                "name": "0f5a6a37998288f6",
                "resource": "https://api.engineyard.com/servers/30",
                "severity": "warning",
                "updated_at": "2018-04-12T18:01:36+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/e7714ae3-2634-470d-ad63-7b935a7dad6a",
                "environment": "https://api.engineyard.com/environments/87"
              },
              {
                "id": "e1f47c60-ec0a-4277-81b2-2aa6b3842650",
                "acknowledged": false,
                "created_at": "2018-04-12T18:01:36+00:00",
                "description": "Aut a odio maiores omnis.",
                "external_id": "2a0f75ccd5b968b504b1be59b68ddb37",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Et perferendis.",
                "name": "2577ded79cd97f7f",
                "resource": "https://api.engineyard.com/servers/30",
                "severity": "warning",
                "updated_at": "2018-04-12T18:01:36+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/e7714ae3-2634-470d-ad63-7b935a7dad6a",
                "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

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alerts": [
              {
                "id": "6d1885da-beb9-42fc-a7f3-e71c6cab71bd",
                "acknowledged": false,
                "created_at": "2018-04-12T18:01:20+00:00",
                "description": "Dolore veritatis sit occaecati et nihil.",
                "external_id": "a7e785e70edaa955d618430bffd5a7d9",
                "started_at": null,
                "finished_at": "2018-04-12T18:01:20+00:00",
                "ignored": false,
                "message": "Facilis non eligendi dolor illo officia.",
                "name": "759a41da2cf50290",
                "resource": "https://api.engineyard.com/servers/29",
                "severity": "warning",
                "updated_at": "2018-04-12T18:01:20+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/63eeec6a-0178-4a07-9c06-11f3d0a863be",
                "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": "2018-04-12T18:01:03+00:00",
              "acknowledged": true,
              "message": "Qui at vero minima est ab omnis.",
              "started_at": "2018-04-12T18:01:03+00:00"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "5b868d89-5866-4c8a-ba6d-3a1a8c9486a6",
              "acknowledged": true,
              "created_at": "2018-04-12T18:01:03+00:00",
              "description": "Rem.",
              "external_id": "4f5852c8c5f494ee483d50e2b4417018",
              "started_at": "2018-04-12T18:01:03+00:00",
              "finished_at": "2018-04-12T18:01:03+00:00",
              "ignored": false,
              "message": "Qui at vero minima est ab omnis.",
              "name": "6c2247b1292a27f0",
              "resource": "https://api.engineyard.com/database-servers/5b6ec73a-eeed-4629-a301-8193e2fd8f39",
              "severity": "warning",
              "updated_at": "2018-04-12T18:01:03+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/b938c6be-a4af-4b0a-9dab-2042683a76a3",
              "environment": null
            }
          }