Alerts API


Update a alert

PUT /alerts/:alert_id

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
            "alert": {
              "finished_at": "2017-02-22T17:02:33+00:00",
              "acknowledged": true,
              "message": "Explicabo blanditiis odio quibusdam molestiae numquam.",
              "started_at": "2017-02-22T17:02:33+00:00"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "9de3e96f-f942-4499-8a60-c97b2474c01c",
              "acknowledged": true,
              "created_at": "2017-02-22T17:02:33+00:00",
              "description": "Rem quia.",
              "external_id": "1e78c6306438f653f7b7a2815907c398",
              "started_at": "2017-02-22T17:02:33+00:00",
              "finished_at": "2017-02-22T17:02:33+00:00",
              "ignored": false,
              "message": "Explicabo blanditiis odio quibusdam molestiae numquam.",
              "name": "34955af2b24a939f",
              "resource": "https://api.engineyard.com/database-servers/93003b40-6867-4d28-865c-639cc3e1f7f2",
              "severity": "warning",
              "updated_at": "2017-02-22T17:02:33+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/4c4e1549-a4c6-4149-8d61-3e41e16df119",
              "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": "16bbf233-d432-46dc-b320-cbed1fec3f2d",
                "acknowledged": false,
                "created_at": "2017-02-22T17:02:41+00:00",
                "description": "Molestiae enim porro placeat consequuntur.",
                "external_id": "3c393f5a488c047cc4c21484fa1bcb8d",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Aut sed earum.",
                "name": "733931c987f15650",
                "resource": "https://api.engineyard.com/servers/2",
                "severity": "critical",
                "updated_at": "2017-02-22T17:02:41+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/70ef0aa1-6b87-40fc-b70b-8f41ac9ca329",
                "environment": "https://api.engineyard.com/environments/2"
              },
              {
                "id": "788e5bfd-650c-4ec8-bf98-528a22053463",
                "acknowledged": false,
                "created_at": "2017-02-22T17:02:41+00:00",
                "description": "Quaerat eum.",
                "external_id": "403fd95e8501f68049978e7bdb30b58c",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Nostrum qui earum vel.",
                "name": "769bf6ae20a23d40",
                "resource": "https://api.engineyard.com/servers/2",
                "severity": "warning",
                "updated_at": "2017-02-22T17:02:41+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/70ef0aa1-6b87-40fc-b70b-8f41ac9ca329",
                "environment": "https://api.engineyard.com/environments/2"
              }
            ]
          }
            
          








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": "9b6504fe-3a5e-4ddd-aa69-c23d1778f108",
                "acknowledged": false,
                "created_at": "2017-02-22T17:03:21+00:00",
                "description": "Qui eveniet.",
                "external_id": "d54919f2f5aac5ed6922ad4a5d03bca2",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Eius voluptas.",
                "name": "5c4b7092eca641cf",
                "resource": "https://api.engineyard.com/servers/4",
                "severity": "critical",
                "updated_at": "2017-02-22T17:03:21+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/53a6905b-d460-4d65-9fae-4f79f959b548",
                "environment": "https://api.engineyard.com/environments/4"
              },
              {
                "id": "02215818-e38e-4b1d-b2e2-0ca876d2f178",
                "acknowledged": false,
                "created_at": "2017-02-22T17:03:21+00:00",
                "description": "Sunt ut in.",
                "external_id": "994ee2dee3395ae5329b106cfb945183",
                "started_at": null,
                "finished_at": null,
                "ignored": false,
                "message": "Voluptatem repellat sint dolore et dolores.",
                "name": "d9a879a181874858",
                "resource": "https://api.engineyard.com/servers/4",
                "severity": "critical",
                "updated_at": "2017-02-22T17:03:21+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/53a6905b-d460-4d65-9fae-4f79f959b548",
                "environment": "https://api.engineyard.com/environments/4"
              }
            ]
          }
            
          








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": "db3ac5cd-f175-4a0c-8161-8cba82fb9958",
                "acknowledged": false,
                "created_at": "2017-02-22T17:03:01+00:00",
                "description": "Dolores ducimus aut.",
                "external_id": "be66b95502e15ff4c6061239b796c3f7",
                "started_at": null,
                "finished_at": "2017-02-22T17:03:01+00:00",
                "ignored": false,
                "message": "Aut placeat dolorum.",
                "name": "f69a7c4359e9b9ce",
                "resource": "https://api.engineyard.com/servers/3",
                "severity": "warning",
                "updated_at": "2017-02-22T17:03:01+00:00",
                "type": "server",
                "account": "https://api.engineyard.com/accounts/a8267061-3f6e-4d21-b337-e4ea8ab9be19",
                "environment": "https://api.engineyard.com/environments/3"
              }
            ]
          }
            
          








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": "Numquam quo vitae.",
              "description": "calculate",
              "severity": "warning",
              "name": "monitor",
              "external_id": "069b6cba-bcef-4f7f-8bec-a25ba0a3c89d"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "d5cc72ee-41ba-4b0e-8688-ced58d31e5f9",
              "acknowledged": false,
              "created_at": "2017-02-22T17:02:23+00:00",
              "description": "calculate",
              "external_id": "069b6cba-bcef-4f7f-8bec-a25ba0a3c89d",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Numquam quo vitae.",
              "name": "monitor",
              "resource": "https://api.engineyard.com/database-servers/f1fd2c28-4c43-4af8-a714-f4c0802a127e",
              "severity": "warning",
              "updated_at": "2017-02-22T17:02:23+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/6ffc6474-1f1d-4b7e-928b-432611a68099",
              "environment": null
            }
          }
            
          








Create a server alert

POST /servers/:server_id/alerts

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
            "alert": {
              "message": "Aliquid eum dignissimos rerum exercitationem.",
              "description": "input",
              "severity": "warning",
              "name": "hard drive",
              "external_id": "d73f32f3-bb35-4d84-84d1-137b8508d0c4"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "9fe5f48f-d45e-4f0e-828f-b1877a7fe1e7",
              "acknowledged": false,
              "created_at": "2017-02-22T17:02:13+00:00",
              "description": "input",
              "external_id": "d73f32f3-bb35-4d84-84d1-137b8508d0c4",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Aliquid eum dignissimos rerum exercitationem.",
              "name": "hard drive",
              "resource": "https://api.engineyard.com/servers/1",
              "severity": "warning",
              "updated_at": "2017-02-22T17:02:13+00:00",
              "type": "server",
              "account": "https://api.engineyard.com/accounts/ece3b5ec-1022-4c0d-8cba-a3cf0ee53692",
              "environment": "https://api.engineyard.com/environments/1"
            }
          }
            
          








Get a alert

GET /alerts/:alert

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "alert": {
              "id": "19242c3e-7b90-43c8-8db3-e3efd618c8d9",
              "acknowledged": false,
              "created_at": "2017-02-22T17:03:39+00:00",
              "description": "Facilis voluptas eum ea.",
              "external_id": "096856c5c1ceaeeccab41c978e70ee63",
              "started_at": null,
              "finished_at": null,
              "ignored": false,
              "message": "Et in quia qui quae officiis.",
              "name": "74a4f0e2631161d5",
              "resource": "https://api.engineyard.com/database-servers/d8f53c85-6bac-4cbb-a408-1aa597cd0a9b",
              "severity": "critical",
              "updated_at": "2017-02-22T17:03:39+00:00",
              "type": "database_server",
              "account": "https://api.engineyard.com/accounts/83a90d3c-387d-4018-932c-e6b9f4cf9989",
              "environment": null
            }
          }