Alerts | Core API

Alerts API

Create a database server alert
Create a server alert
Get a alert
List alerts
List alerts by environment
List alerts that are finished but not acknowledged
Update a alert

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": "Nisi.",
              "description": "input",
              "severity": "warning",
              "name": "port",
              "external_id": "568acc53-50fd-4cea-ac6a-a17e33cedadc"
            }
          }

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8

            
          {
            "alert": {
              "id": "51f44e9a-5c39-4bdd-ac0e-b52de5cac75b",
              "acknowledged": false,
              "created_at": "2018-05-29T10:54:41+00:00",
              "description": "input",
              "external_id": "568acc53-50fd-4cea-ac6a-a17e33cedadc",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Nisi.",
              "name": "port",
              "resource": "https://api.engineyard.com/database-servers/64862526-bd6c-42e9-a714-e234011c9fa6",
              "severity": "warning",
              "updated_at": "2018-05-29T10:54:41+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/d87b8a35-06ca-473a-b1a4-bfbe968d8199",
              "environment": null
            }
          }

Create a server alert

POST /servers/:server_id/alerts

Request

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

            
          {
            "alert": {
              "message": "Sunt dolorem.",
              "description": "input",
              "severity": "warning",
              "name": "capacitor",
              "external_id": "5ea0869a-b8e2-44c0-b08b-3067011a3482"
            }
          }

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8

            
          {
            "alert": {
              "id": "4aae1577-536b-4e46-81fe-86c79a0ef016",
              "acknowledged": false,
              "created_at": "2018-05-29T10:54:36+00:00",
              "description": "input",
              "external_id": "5ea0869a-b8e2-44c0-b08b-3067011a3482",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Sunt dolorem.",
              "name": "capacitor",
              "resource": "https://api.engineyard.com/servers/27",
              "severity": "warning",
              "updated_at": "2018-05-29T10:54:36+00:00",
              "type": "server",
              "account": "https://api.engineyard.com/accounts/8f7ac0d9-9c25-4929-997b-2c397f41779a",
              "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": "157d2444-c7df-4387-927b-7328de4bdcf9",
              "acknowledged": false,
              "created_at": "2018-05-29T10:55:33+00:00",
              "description": "Est reiciendis.",
              "external_id": "3054e024ca261a9b4c051bea8cb17e5f",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Non.",
              "name": "ad0b1263fd5b6d93",
              "resource": "https://api.engineyard.com/database-servers/dbf897e1-3580-4303-a01e-8ec1a8cbaa5d",
              "severity": "warning",
              "updated_at": "2018-05-29T10:55:33+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/3b0d584e-1cb4-41c9-a636-2c522755b55b",
              "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": "4be5cd04-4b54-4657-983b-b7304399cbdb",
                "acknowledged": false,
                "created_at": "2018-05-29T10:54:49+00:00",
                "description": "Eos consequatur et vel.",
                "external_id": "597bdb8531c37ff4b43b6065413ad83e",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Eos.",
                "name": "cf1d3c851952acef",
                "resource": "https://api.engineyard.com/servers/28",
                "severity": "warning",
                "updated_at": "2018-05-29T10:54:49+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/3416acbb-4c8e-473f-beec-28a652c7ba6c",
                "environment": "https://api.engineyard.com/environments/85"
              },
              {
                "id": "80bd9eb2-4d9b-4aa1-834b-71f53e801867",
                "acknowledged": false,
                "created_at": "2018-05-29T10:54:49+00:00",
                "description": "Dolorem nihil.",
                "external_id": "ac7c0efd6a15383059e8482e0af94a14",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Dolorum.",
                "name": "73dce2d2b8b0192c",
                "resource": "https://api.engineyard.com/servers/28",
                "severity": "critical",
                "updated_at": "2018-05-29T10:54:49+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/3416acbb-4c8e-473f-beec-28a652c7ba6c",
                "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": "b26a52ce-1af4-4b0c-8c26-dfe3a2bd25c9",
                "acknowledged": false,
                "created_at": "2018-05-29T10:55:19+00:00",
                "description": "Nihil magnam a.",
                "external_id": "3eca9c23e6b7c3e964f9e7bb06896738",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Cupiditate odio quae.",
                "name": "6b94a10db4f92c95",
                "resource": "https://api.engineyard.com/servers/30",
                "severity": "critical",
                "updated_at": "2018-05-29T10:55:19+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/3ae36d45-91d5-4f20-bdc2-c14bc40784ac",
                "environment": "https://api.engineyard.com/environments/87"
              },
              {
                "id": "fc8f28f1-d994-4abf-82a0-0f36132d5cfb",
                "acknowledged": false,
                "created_at": "2018-05-29T10:55:19+00:00",
                "description": "Delectus blanditiis.",
                "external_id": "a4147215a8e5ab21ba52f025852b0d7c",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Aliquam.",
                "name": "951ad0f6772cafa1",
                "resource": "https://api.engineyard.com/servers/30",
                "severity": "warning",
                "updated_at": "2018-05-29T10:55:19+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/3ae36d45-91d5-4f20-bdc2-c14bc40784ac",
                "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": "65c06da1-131a-4749-957a-e6e629825c87",
                "acknowledged": false,
                "created_at": "2018-05-29T10:55:04+00:00",
                "description": "Occaecati facilis dignissimos rem.",
                "external_id": "1a615d5922ad093869cae56e79d0f944",
                "started_at": null,
                "finished_at": "2018-05-29T10:55:04+00:00",
                "ignored": false,
                "message": "Quae qui.",
                "name": "8f273f75cfda542c",
                "resource": "https://api.engineyard.com/servers/29",
                "severity": "critical",
                "updated_at": "2018-05-29T10:55:04+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/14826957-fe0a-4076-b103-e35a4f0197b4",
                "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-05-29T10:54:46+00:00",
              "acknowledged": true,
              "message": "Fugit officiis quia aut omnis.",
              "started_at": "2018-05-29T10:54:46+00:00"
            }
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "alert": {
              "id": "a7f1a794-ba81-4018-a35f-48bb3b1938c8",
              "acknowledged": true,
              "created_at": "2018-05-29T10:54:46+00:00",
              "description": "Distinctio et enim ea perspiciatis et.",
              "external_id": "17209a1a2a53f68197d89d48da3e71a7",
              "started_at": "2018-05-29T10:54:46+00:00",
              "finished_at": "2018-05-29T10:54:46+00:00",
              "ignored": false,
              "message": "Fugit officiis quia aut omnis.",
              "name": "b3e8b2faa360e65c",
              "resource": "https://api.engineyard.com/database-servers/123a583d-51ba-4c56-a92e-6f3d25c25de2",
              "severity": "critical",
              "updated_at": "2018-05-29T10:54:46+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/f2a5f2de-a0be-403d-91a0-6dd707a86227",
              "environment": null
            }
          }