API Reference

The Fyipe API is organized around the REST framework. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application/mobile application, or any service that can consume HTTP RESTful API's. You should remember that you should never expose your API Key in any public website's client-side code, Project ID however can be exposed). JSON will be returned in all responses from the API, including errors (though if you're using API bindings/SDK, we will convert the response to the appropriate language-specific object).

REST API Endpoint

https://fyipe.com/api/

Authentication

Authentication on Fyipe API is possible through Fyipe Project ID and API Key. Every Project in Fyipe has it's own API Project ID and API Key. You can find this on your Fyipe Dashboard under the Project Settings menu. Only Project Owners and Administrators have access to Fyipe API Key.

There are three ways you can perform authentication. Either by passing the Project ID and API Key in request headers, query params, or request body.

As Request Headers

projectId: your-project-id-here

apiKey: your-api-key-here

As Query Params

https://fyipe.com/api/your-path?projectId=XXX&apiKey=XXX

As Request Body

{ projectId: XXX, apiKey: XXX }

Output Types

Fyipe API provides outputs in multiple formats. They are - JSON, XML, and CSV.

JSON will be returned by default. You need to specify what type of output you're looking for by declaring the output-type query param.

As Query Param

https://fyipe.com/api/your-path?output-type=xml

Errors

The Fyipe API uses standard HTTP status codes for responses. These HTTP codes indicate whether or not an API operation is successful.

Status Code 200 is the desired status code. A standard JSON response body will follow.

Status Codes in the 400s range detail all of the errors a Fyipe Developer could encounter while using the API. Bad Request, Rate Limit Reached, and Unauthorized are some of the sorts of responses in the 400s block.

Status Codes in the 500s range are error responses from the Fyipe system. If an error has occured anywhere in the execution of a resource that was not due to user input, a 500 response will be returned with a corresponding JSON error body. In that body will contain a message detailing what went wrong.

HTTP Status Codes

  • 200
    OK - Everything went as planned.
  • 204
    NO CONTENT - Request fulfilled, but no response body.
  • 400
    BAD REQUEST - The request body was formatted improperly.
  • 401
    UNAUTHORIZED - API Key missing or invalid.
  • 403
    FORBIDDEN - Insufficient permissions.
  • 404
    NOT FOUND - The requested resource does not exist.
  • 500
    INTERNAL SERVER ERROR - We had an error! The server has encountered a situation it doesn't know how to handle.

Alert

Alert API will allow you to send alerts and access all the alerts that were sent to your Fyipe project team members. If you want to access alerts that were sent to your customers who have subscribed to monitor incidents, please check Subscriber Alert API.

Path

  • https://fyipe.com/api/alert/

Create AlertPOST

Create Alert by Project ID.

Path

  • https://fyipe.com/api/alert/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/alert/5e089f94b400211639928c94

Request Body

            
              

{ "monitorId": "5e08a21b25c59a1c8033c7e7", "alertVia": "sms", "incidentId": "5e1725db1f31a13e98acd8d9" }

Example Response (200)

            
              

{ "error": false, "deleted": false, "_id": "5e1a0173432bc411d962fa19", "createdAt": "2020-01-11T17:10:11.759Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "alertVia": "sms", "userId": "5e089f88b400211639928c92", "incidentId": "5e1725db1f31a13e98acd8d9", "__v": 0 }

Get All Project AlertsGET

Get All Project Alerts by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/alert/:projectId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/alert/5e089f94b400211639928c94/alert?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "error": false, "_id": "5e1a0173432bc411d962fa19", "createdAt": "2020-01-11T17:10:11.759Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "alertVia": "sms", "userId": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentId": "5e1725db1f31a13e98acd8d9" } ], "count": 1, "skip": 0, "limit": 5 }

Get All SubProjects AlertsGET

Get All SubProjects Alerts by Project ID.

Path

  • https://fyipe.com/api/alert/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/alert/5e089f94b400211639928c94

Example Response (200)

            
              

[ { "alerts": [ { "error": false, "_id": "5e1a0173432bc411d962fa19", "createdAt": "2020-01-11T17:10:11.759Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "alertVia": "sms", "userId": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentId": "5e1725db1f31a13e98acd8d9" } ], "count": 1, "_id": "5e089f94b400211639928c94", "skip": 0, "limit": 10 } ]

Get All Project Alerts By IncidentGET

Get All Project Alerts by Project ID and Incident ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/alert/:projectId/incident/:incidentId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/alert/5e089f94b400211639928c94/incident/5e1725db1f31a13e98acd8d9?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "error": false, "_id": "5e1a0173432bc411d962fa19", "createdAt": "2020-01-11T17:10:11.759Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "alertVia": "sms", "userId": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentId": "5e1725db1f31a13e98acd8d9" } ], "count": 1, "skip": 0, "limit": 5 }

Get Alert ChargesGET

Get Alert Charges by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/alert/:projectId/alert/charges

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/alert/5e089f94b400211639928c94/alert/charges?skip=0&limit=5

Example Response (200)

            
              

{ "data": [], "count": 0, "skip": 0, "limit": 5 }

Delete AlertDELETE

Delete Alert by Project ID.

Path

  • https://fyipe.com/api/alert/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/alert/5e089f94b400211639928c94

Example Response (200)

            
              

{ "error": false, "deleted": true, "_id": "5e1a0173432bc411d962fa19", "createdAt": "2020-01-11T17:10:11.759Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "alertVia": "sms", "userId": "5e089f88b400211639928c92", "incidentId": "5e1725db1f31a13e98acd8d9", "__v": 0, "deletedAt": "2020-01-11T17:36:49.978Z", "deletedById": "5e089f88b400211639928c92" }

Application Log

Application Log API will allow you to create application logs and send logs from your third party application using the fyipe-logger library

Path

  • https://fyipe.com/api/application-log/

Create Application LogPOST

Create Application Log by Project ID and Component ID.

Path

  • https://fyipe.com/api/application-log/:projectId/:componentId/create

Path Variables

  • projectId string

    The project id of the project.

  • componentId string

    The component id of the component.

Example Request

Request URL

https://fyipe.com/api/application-log/5eea4077924a3c80a476c185/5eea4077924a3c80a476c188/create

Request Body

                
                  

{ "name":"Rodeo" }

Example Response (200)

                
                  

{ "deleted": false, "_id": "5eeb3bf08888bffbfcae2bc0", "createdAt": "2020-06-18T10:03:28.468Z", "name": "Rodeo", "key": "7f5405df-6af5-440e-9dce-4d42303ffd52", "componentId": { "_id": "5eea4077924a3c80a476c188", "name": "Our Component" }, "createdById": "5eea4076924a3c80a476c183", "__v": 0 }

Edit Application LogPUT

Edit Application Log by Project ID, Component ID and Application Log ID.

Path

  • https://fyipe.com/api/application-log/:projectId/:componentId/:applicationLogId

Path Variables

  • projectId string

    The project id of the project.

  • componentId string

    The component id of the component.

  • applicationLogId string

    The application log id of the application log.

Example Request

Request URL

https://fyipe.com/api/application-log/5eea4077924a3c80a476c185/5eea4077924a3c80a476c188/5eeb3bf08888bffbfcae2bc0

Request Body

                
                  

{ "name":"Astro" }

Example Response (200)

                
                  

{ "deleted": false, "_id": "5eeb3bf08888bffbfcae2bc0", "createdAt": "2020-06-18T10:03:28.468Z", "name": "Astro", "key": "8d734ca6-7c21-4453-8488-45da0dfc7c71", "componentId": { "_id": "5eea4077924a3c80a476c188", "name": "Our Component" }, "createdById": "5eea4076924a3c80a476c183", "__v": 0 }

Get All Application LogsGET

Get All Application Logs by Project ID and Component ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/application-log/:projectId/:componentId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • componentId string

    The component id of the component.

Example Request

Request URL

https://fyipe.com/api/application-log/5eea4077924a3c80a476c185/5eea4077924a3c80a476c188?skip=0&limit=5

Example Response (200)

                
                  

[ { "_id": "5eeb3bf08888bffbfcae2bc0", "createdAt": "2020-06-18T10:03:28.468Z", "name": "Rodeo", "key": "7f5405df-6af5-440e-9dce-4d42303ffd52", "componentId": { "_id": "5eea4077924a3c80a476c188", "name": "Our Component" }, "createdById": "5eea4076924a3c80a476c183" }, { "_id": "5eea4077924a3c80a476c18b", "createdAt": "2020-06-17T16:10:31.612Z", "name": "Application Logger", "key": "3639097e-5e95-4a34-92d4-510eca8c81de", "componentId": { "_id": "5eea4077924a3c80a476c188", "name": "Our Component" }, "createdById": "5eea4076924a3c80a476c183" } ]

Create Log POST

Create Log by Application Log ID and Application Log Key.

Path

  • https://fyipe.com/api/application-log/:applicationLogId/log

Path Variables

  • applicationLogId string

    The application log id of the application log.

Example Request

Request URL

https://fyipe.com/api/application-log/5eeb3bf08888bffbfcae2bc0/log

Request Body

                
                  

{ "content":{ "error_page": "inside Page", "time_taken": "45s", "ghost": { "who": "me here" } }, "applicationLogKey": "7f5405df-6af5-440e-9dce-4d42303ffd52", "type": "warning", "tags": ["fast","continental", "trial"] }

Example Response (200)

                
                  

{ "tags": [ "fast", "continental", "trial" ], "deleted": false, "_id": "5eeb43e38888bffbfcae2bc5", "createdAt": "2020-06-18T10:37:23.014Z", "content": { "error_page": "inside Page", "time_taken": "45s", "ghost": { "who": "me here" } }, "stringifiedContent": "{\"error_page\":\"inside Page\",\"time_taken\":\"45s\",\"ghost\":{\"who\":\"me here\"}}", "applicationLogId": { "_id": "5eeb3bf08888bffbfcae2bc0", "name": "Rodeo" }, "type": "warning", "createdById": null, "__v": 0 }

Get All Logs POST

Get All Logs by Project ID, Component ID and Application Log ID.

Path

  • https://fyipe.com/api/application-log/:projectId/:componentId/:applicationLogId/logs

Path Variables

  • projectId string

    The project id of the project.

  • componentId string

    The component id of the component.

  • applicationLogId string

    The application log id of the application log.

Example Request

Request URL

https://fyipe.com/api/application-log/5eea4077924a3c80a476c185/5eea4077924a3c80a476c188/5eeb3bf08888bffbfcae2bc0/logs

Request Body

                
                  

{ "endDate": "2020-06-18T20:31:59.420Z", "limit": 0, "skip": 0, "startDate": "2020-06-09T15:31:59.420Z", "type": "", "filter":"" }

Example Response (200)

                
                  

{ "data": { "logs": [ { "_id": "5eeb43e38888bffbfcae2bc5", "createdAt": "2020-06-18T10:37:23.014Z", "content": { "error_page": "inside Page", "time_taken": "45s", "ghost": { "who": "me here" } }, "stringifiedContent": "{\"error_page\":\"inside Page\",\"time_taken\":\"45s\",\"ghost\":{\"who\":\"me here\"}}", "applicationLogId": { "_id": "5eeb3bf08888bffbfcae2bc0", "name": "Rodeo" }, "type": "warning", "createdById": null } ], "dateRange": { "startDate": "2020-06-18T10:37:23.014Z", "endDate": "2020-06-18T10:37:23.014Z" } }, "count": 1 }

Reset Application Log Key POST

Reset Application Log Key by Project ID, Component ID and Application Log ID.

Path

  • https://fyipe.com/api/application-log/:projectId/:componentId/:applicationLogId/reset-key

Path Variables

  • projectId string

    The project id of the project.

  • componentId string

    The component id of the component.

  • applicationLogId string

    The application log id of the application log.

Example Request

Request URL

https://fyipe.com/api/application-log/5eea4077924a3c80a476c185/5eea4077924a3c80a476c188/5eeb3bf08888bffbfcae2bc0/reset-key

Example Response (200)

                
                  

{ "deleted": false, "_id": "5eeb3bf08888bffbfcae2bc0", "createdAt": "2020-06-18T10:03:28.468Z", "name": "Rodeo", "key": "8d734ca6-7c21-4453-8488-45da0dfc7c71", "componentId": { "_id": "5eea4077924a3c80a476c188", "name": "Our Component" }, "createdById": "5eea4076924a3c80a476c183", "__v": 0 }

Delete Application Log Key DELETE

Delete Application Log Key by Project ID, Component ID and Application Log ID.

Path

  • https://fyipe.com/api/application-log/:projectId/:componentId/:applicationLogId

Path Variables

  • projectId string

    The project id of the project.

  • componentId string

    The component id of the component.

  • applicationLogId string

    The application log id of the application log.

Example Request

Request URL

https://fyipe.com/api/application-log/5eea4077924a3c80a476c185/5eea4077924a3c80a476c188/5eeb3bf08888bffbfcae2bc0

Example Response (200)

                
                  

{ "deleted": true, "_id": "5eeb3bf08888bffbfcae2bc0", "createdAt": "2020-06-18T10:03:28.468Z", "name": "Rodeo", "key": "8d734ca6-7c21-4453-8488-45da0dfc7c71", "componentId": { "_id": "5eea4077924a3c80a476c188", "name": "Our Component" }, "createdById": "5eea4076924a3c80a476c183", "__v": 0 }

Component

Component API will allow you to create components that will contain monitors.

Path

  • https://fyipe.com/api/component/

Create ComponentPOST

Create Component by Project ID.

Path

  • https://fyipe.com/api/component/:projectId

Path Variables

  • projectId string

    The id of the project.

Example Request

Request URL

https://fyipe.com/api/component/5e6a37b644d6b86198ba4366

Request Body

            
              

{ "projectId": "5e6a37b644d6b86198ba4366", "name": "Component 1" }

Example Response (200)

            
              

{ "deleted": false, "_id": "5e734ad31dacde220ae15158", "createdAt": "2020-03-19T10:34:59.934Z", "name": "Component 1", "createdById": "5e6a37b144d6b86198ba4363", "projectId": { "_id": "5e6a37b644d6b86198ba4366", "name": "Project 1" }, "__v": 0 }

Get All ComponentsGET

Get All Components by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/component/:projectId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The id of the project.

Example Request

Request URL

https://fyipe.com/api/component/5e6a37b644d6b86198ba4366?skip=0&limit=5

Example Response (200)

            
              

[ { "components": [ { "_id": "5e6f2bba1506a816eb888b5e", "createdAt": "2020-03-16T07:33:14.329Z", "name": "Component 2", "createdById": "5e6a37b144d6b86198ba4363", "projectId": { "_id": "5e6e7dd11506a816eb8879ba", "name": "Sub Project 1" } } ], "count": 1, "_id": "5e6e7dd11506a816eb8879ba", "skip": 0, "limit": 0 }, { "components": [ { "_id": "5e6df591c9b5c930f078e8bc", "createdAt": "2020-03-15T09:29:53.335Z", "name": "Component 1", "createdById": "5e6a37b144d6b86198ba4363", "projectId": { "_id": "5e6a37b644d6b86198ba4366", "name": "Project 1" } } ], "count": 1, "_id": "5e6a37b644d6b86198ba4366", "skip": 0, "limit": 0 } ]

Get ComponentGET

Get Single Component by Project ID and Component ID.

Path

  • https://fyipe.com/api/component/:projectId/component/:componentId

Path Variables

  • projectId string

    The id of the project.

  • componentId string

    The id of the component.

Example Request

Request URL

https://fyipe.com/api/component/5e6a37b644d6b86198ba4366/component/5e734ad31dacde220ae15158

Example Response (200)

            
              

{ "deleted": false, "_id": "5e734ad31dacde220ae15158", "createdAt": "2020-03-19T10:34:59.934Z", "name": "Component 1", "createdById": "5e6a37b144d6b86198ba4363", "projectId": { "_id": "5e6a37b644d6b86198ba4366", "name": "Project 1" }, "__v": 0 }

Edit ComponentPUT

Edit Component by Project ID and Component ID.

Path

  • https://fyipe.com/api/component/:projectId/:componentId

Path Variables

  • projectId string

    The id of the project.

  • componentId string

    The id of the component.

Example Request

Request URL

https://fyipe.com/api/component/5e6a37b644d6b86198ba4366/5e734ad31dacde220ae15158

Request Body

            
              

{ "projectId": "5e089f94b400211639928c94", "name": "Component 10" }

Example Response (200)

            
              

{ "deleted": false, "_id": "5e734ad31dacde220ae15158", "createdAt": "2020-03-19T10:34:59.934Z", "name": "Component 10", "createdById": "5e6a37b144d6b86198ba4363", "projectId": null, "__v": 0 }

Delete ComponentDELETE

Delete Component by Project ID and Component ID.

Path

  • https://fyipe.com/api/component/:projectId/:componentId

Path Variables

  • projectId string

    The id of the project.

  • componentId string

    The id of the component.

Example Request

Request URL

https://fyipe.com/api/component/5e6a37b644d6b86198ba4366/5e734ad31dacde220ae15158

Example Response (200)

            
              

{ "deleted": true, "_id": "5e734fac4dafc853fb311137", "createdAt": "2020-03-19T10:55:40.938Z", "name": "Component 10", "createdById": "5e6a37b144d6b86198ba4363", "projectId": "5e6a37b644d6b86198ba4366", "__v": 0, "deletedAt": "2020-03-19T10:55:59.220Z", "deletedById": { "_id": "5e6a37b144d6b86198ba4363", "name": "Jian Yang" } }

Email SMTP

Email SMTP API will allow you to configure and send emails via your SMTP server instead of the default SMTP server of Fyipe.

Path

  • https://fyipe.com/api/emailSmtp/

Setup Email SMTPPOST

Setup Email SMTP by Project ID.

Path

  • https://fyipe.com/api/emailSmtp/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/emailSmtp/5e089f94b400211639928c94

Request Body

            
              

{ "smtpswitch": true, "user": "[email protected]", "pass": "nawazdhandala", "host": "mail.hackerbay.io", "from": "[email protected]", "port": "587", "secure": true }

Example Response (200)

            
              

{ "_id": "5e1a154c1a4dae1373eeeca2", "user": "[email protected]", "pass": "nawazdhandala", "host": "mail.hackerbay.io", "from": "[email protected]", "port": "587", "secure": true, "enabled": true, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdAt": "2020-01-01 15:54:48.005Z", "deleted": false }

Get Email SMTP SetupGET

Get Email SMTP Setup by Project ID.

Path

  • https://fyipe.com/api/emailSmtp/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/emailSmtp/5e089f94b400211639928c94

Example Response (200)

            
              

{ "_id": "5e1a154c1a4dae1373eeeca2", "user": "[email protected]", "pass": "nawazdhandala", "host": "mail.hackerbay.io", "from": "[email protected]", "port": "587", "secure": true, "enabled": true, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdAt": "2020-01-01 15:54:48.005Z", "deleted": false }

Edit Email SMTP SetupPUT

Edit Email SMTP Setup by Project ID and Email SMTP ID.

Path

  • https://fyipe.com/api/emailSmtp/:projectId/:emailSmtpId

Path Variables

  • projectId string

    The project id of the project.

  • emailSmtpId string

    The email SMTP id of the email SMTP config.

Example Request

Request URL

https://fyipe.com/api/emailSmtp/5e089f94b400211639928c94/5e1a154c1a4dae1373eeeca2

Request Body

            
              

{ "smtpswitch": true, "user": "[email protected]", "pass": "nawazdhandala", "host": "mail.hackerbay.io", "from": "[email protected]", "port": "587", "secure": true }

Example Response (200)

            
              

{ "_id": "5e1a154c1a4dae1373eeeca2", "user": "[email protected]", "pass": "nawazdhandala", "host": "mail.hackerbay.io", "from": "[email protected]", "port": "587", "secure": true, "enabled": true, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdAt": "2020-01-01 15:54:48.005Z", "deleted": false }

Delete Email SMTP SetupDELETE

Delete Email SMTP Setup by Project ID and Email SMTP ID.

Path

  • https://fyipe.com/api/emailSmtp/:projectId/:emailSmtpId

Path Variables

  • projectId string

    The project id of the project.

  • emailSmtpId string

    The email SMTP id of the email SMTP config.

Example Request

Request URL

https://fyipe.com/api/emailSmtp/5e089f94b400211639928c94/5e1a154c1a4dae1373eeeca2

Example Response (200)

            
              

{ "_id": "5e1a154c1a4dae1373eeeca2", "user": "[email protected]", "pass": "nawazdhandala", "host": "mail.hackerbay.io", "from": "[email protected]", "port": "587", "secure": true, "enabled": true, "projectId": "5e089f94b400211639928c94", "createdAt": "2020-01-01 15:54:48.005Z", "deleted": true, "deletedAt": "2020-01-11T17:36:49.978Z", "deletedById": "5e089f88b400211639928c92" }

Email Template

Email Template API will allow you to customize your email templates.

Path

  • https://fyipe.com/api/emailTemplate/

Create Email TemplatePOST

Create Email Template by Project ID.

Path

  • https://fyipe.com/api/emailTemplate/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/emailTemplate/5e089f94b400211639928c94

Request Body

            
              

{ "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Created", "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "..." }

Example Response (200)

            
              

{ "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "deleted": false, "_id": "5e1a1c75ba543f2f21682050", "projectId": "5e089f94b400211639928c94", "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "...", "emailType": "Subscriber Incident Created", "__v": 0 }

Get All Email TemplateGET

Get All Email Template by Project ID.

Path

  • https://fyipe.com/api/emailTemplate/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/emailTemplate/5e089f94b400211639928c94

Example Response (200)

            
              

[ { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "_id": "5e1a1c75ba543f2f21682050", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "...", "emailType": "Subscriber Incident Created" }, { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Acknowldeged", "subject": "{{projectName}}/{{monitorName}}: Incident Acknowldeged", "body": "..." }, { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Resolved", "subject": "{{projectName}}/{{monitorName}}: Incident Resolved", "body": "..." } ]

Get Email TemplateGET

Get Single Email Template by Project ID and Email Template ID.

Path

  • https://fyipe.com/api/emailTemplate/:projectId/emailTemplate/:emailTemplateId

Path Variables

  • projectId string

    The project id of the project.

  • emailTemplateId string

    The email template id of the project email template.

Example Request

Request URL

https://fyipe.com/api/emailTemplate/5e089f94b400211639928c94/emailTemplate/5e1a1c75ba543f2f21682050

Example Response (200)

            
              

{ "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "deleted": false, "_id": "5e1a1c75ba543f2f21682050", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "...", "emailType": "Subscriber Incident Created", "__v": 0 }

Edit Email TemplatePUT

Edit Email Template by Project ID and Email Template ID.

Path

  • https://fyipe.com/api/emailTemplate/:projectId/emailTemplate/:emailTemplateId

Path Variables

  • projectId string

    The project id of the project.

  • emailTemplateId string

    The email template id of the project email template.

Example Request

Request URL

https://fyipe.com/api/emailTemplate/5e089f94b400211639928c94/emailTemplate/5e1a1c75ba543f2f21682050

Request Body

            
              

{ "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "deleted": false, "_id": "5e1a1c75ba543f2f21682050", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "...", "emailType": "Subscriber Incident Created", "__v": 0 }

Example Response (200)

            
              

{ "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "deleted": false, "_id": "5e1a1c75ba543f2f21682050", "projectId": "5e089f94b400211639928c94", "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "...", "emailType": "Subscriber Incident Created", "__v": 0 }

Reset Email TemplateGET

Reset Email Template by Project ID and Email Template ID.

Path

  • https://fyipe.com/api/emailTemplate/:projectId/:templateId/reset

Path Variables

  • projectId string

    The project id of the project.

  • templateId string

    The template id of the email template.

Example Request

Request URL

https://fyipe.com/api/emailTemplate/5e089f94b400211639928c94/5e1a1c75ba543f2f21682050/reset

Example Response (200)

            
              

[ { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "_id": "5e1a1c75ba543f2f21682050", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "...", "emailType": "Subscriber Incident Created" }, { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Acknowldeged", "subject": "{{projectName}}/{{monitorName}}: Incident Acknowldeged", "body": "..." }, { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Resolved", "subject": "{{projectName}}/{{monitorName}}: Incident Resolved", "body": "..." } ]

Add Values To Email TemplatesPUT

Add Values To Email Templates by Project ID.

Path

  • https://fyipe.com/api/emailTemplate/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/emailTemplate/5e089f94b400211639928c94

Request Body

            
              

[ { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Created", "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "..." }, { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Acknowldeged", "subject": "{{projectName}}/{{monitorName}}: Incident Acknowldeged", "body": "..." }, { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Resolved", "subject": "{{projectName}}/{{monitorName}}: Incident Resolved", "body": "..." } ]

Example Response (200)

            
              

[ { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "_id": "5e1a1c75ba543f2f21682050", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "...", "emailType": "Subscriber Incident Created" }, { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Acknowldeged", "subject": "{{projectName}}/{{monitorName}}: Incident Acknowldeged", "body": "..." }, { "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "emailType": "Subscriber Incident Resolved", "subject": "{{projectName}}/{{monitorName}}: Incident Resolved", "body": "..." } ]

Delete Email TemplateDELETE

Delete Email Template by Project ID and Email Template ID.

Path

  • https://fyipe.com/api/emailTemplate/:projectId/emailTemplate/:emailTemplateId

Path Variables

  • projectId string

    The project id of the project.

  • emailTemplateId string

    The email template id of the project email template.

Example Request

Request URL

https://fyipe.com/api/emailTemplate/5e089f94b400211639928c94/emailTemplate/5e1a1c75ba543f2f21682050

Example Response (200)

            
              

{ "allowedVariables": [ "{{userName}} : User display name.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentTime}} : Time at which this incident occured.", "{{incidentType}} : Type of incident.", "{{userId}} : Unique identifier for user account.", "{{projectId}} : Unique identifier for the current project." ], "deleted": true, "_id": "5e1a1c75ba543f2f21682050", "projectId": "5e089f94b400211639928c94", "subject": "{{projectName}}/{{monitorName}}: Incident Created", "body": "...", "emailType": "Subscriber Incident Created", "__v": 0, "deletedAt": "2020-01-11T19:17:23.594Z", "deletedById": "5e089f88b400211639928c92" }

Incident

Inident API will allow you to create a monitor incident and alert your on-call team members. You can also acknowledge and resolve created monitor incidents in your Fyipe project.

Path

  • https://fyipe.com/api/incident/

Create IncidentPOST

Create Incident by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/incident/:projectId/:monitorId

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/5e08a21b25c59a1c8033c7e7

Request Body

            
              

{ "monitorId": "5e1633101b8ae81859214adf", "projectId": "5e089f94b400211639928c94", "incidentType": "offline" }

Example Response (200)

            
              

{ "acknowledged": false, "acknowledgedByZapier": false, "resolved": false, "resolvedByZapier": false, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f", "5e089f88b400211639928c92" ], "manuallyCreated": true, "deleted": false, "_id": "5e1ce11ee6a04216343592bb", "probes": [], "createdAt": "2020-01-13T21:29:02.315Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "__v": 0 }

Get All IncidentsGET

Get All Incidents by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/incident/:projectId/incident

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/incident?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "acknowledged": false, "acknowledgedByZapier": false, "resolved": false, "resolvedByZapier": false, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f", "5e089f88b400211639928c92" ], "manuallyCreated": true, "_id": "5e1c5713bc3b9e1ec8cbde31", "probes": [], "createdAt": "2020-01-13T11:40:03.720Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e139b39a55da96da8d14968", "name": "Mello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline" }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1776861f31a13e98acdd1a", "probes": [], "createdAt": "2020-01-09T18:52:54.432Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T18:53:04.687Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T18:53:04.687Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1775f61f31a13e98acdc56", "probes": [], "createdAt": "2020-01-09T18:50:30.836Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e0a4b1678caf04fd1fedcbe", "name": "Ubuntu Machine" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T18:51:29.600Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T18:51:29.600Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1725db1f31a13e98acd8d9", "probes": [], "createdAt": "2020-01-09T13:08:43.790Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e1633101b8ae81859214adf", "name": "Cello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T13:10:42.766Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T13:10:42.766Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1724591f31a13e98acd8d5", "probes": [], "createdAt": "2020-01-09T13:02:17.254Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e1633101b8ae81859214adf", "name": "Cello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T13:07:50.158Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T13:07:50.158Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } } ], "count": 15, "skip": 0, "limit": 5 }

Get All SubProjects IncidentsGET

Get All SubProjects Incidents by Project ID.

Path

  • https://fyipe.com/api/incident/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94

Example Response (200)

            
              

[ { "incidents": [ { "acknowledged": false, "acknowledgedByZapier": false, "resolved": false, "resolvedByZapier": false, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f", "5e089f88b400211639928c92" ], "manuallyCreated": true, "_id": "5e1c5713bc3b9e1ec8cbde31", "probes": [], "createdAt": "2020-01-13T11:40:03.720Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e139b39a55da96da8d14968", "name": "Mello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline" }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1776861f31a13e98acdd1a", "probes": [], "createdAt": "2020-01-09T18:52:54.432Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T18:53:04.687Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T18:53:04.687Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1775f61f31a13e98acdc56", "probes": [], "createdAt": "2020-01-09T18:50:30.836Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e0a4b1678caf04fd1fedcbe", "name": "Ubuntu Machine" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T18:51:29.600Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T18:51:29.600Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1725db1f31a13e98acd8d9", "probes": [], "createdAt": "2020-01-09T13:08:43.790Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e1633101b8ae81859214adf", "name": "Cello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T13:10:42.766Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T13:10:42.766Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1724591f31a13e98acd8d5", "probes": [], "createdAt": "2020-01-09T13:02:17.254Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e1633101b8ae81859214adf", "name": "Cello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T13:07:50.158Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T13:07:50.158Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": true, "_id": "5e139e7da55da96da8d14c89", "probes": [], "createdAt": "2020-01-06T20:54:21.094Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e139b39a55da96da8d14968", "name": "Mello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-06T20:59:54.863Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-06T20:59:54.863Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": true, "_id": "5e139dfda55da96da8d14a39", "probes": [], "createdAt": "2020-01-06T20:52:13.716Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e139b39a55da96da8d14968", "name": "Mello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-06T20:52:45.271Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-06T20:52:45.271Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": true, "_id": "5e139de1a55da96da8d14a35", "probes": [], "createdAt": "2020-01-06T20:51:45.020Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e139b39a55da96da8d14968", "name": "Mello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "degraded", "acknowledgedAt": "2020-01-06T20:52:05.487Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-06T20:52:05.487Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": true, "_id": "5e139ca5a55da96da8d1496d", "probes": [], "createdAt": "2020-01-06T20:46:29.468Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e139b39a55da96da8d14968", "name": "Mello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-06T20:47:28.276Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-06T20:47:28.276Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": true, "_id": "5e0e813b93751013e43f7490", "probes": [], "createdAt": "2020-01-02T23:48:11.307Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e0a4b1678caf04fd1fedcbe", "name": "Ubuntu Machine" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "degraded", "acknowledgedAt": "2020-01-03T00:28:52.559Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-03T00:28:52.559Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } } ], "count": 15, "_id": "5e089f94b400211639928c94", "skip": 0, "limit": 10 } ]

Get All Monitor IncidentsGET

Get All Monitor Incidents by Project ID and Monitor ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/incident/:projectId/monitor/:monitorId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/monitor/5e08a21b25c59a1c8033c7e7?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1776861f31a13e98acdd1a", "probes": [], "createdAt": "2020-01-09T18:52:54.432Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T18:53:04.687Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T18:53:04.687Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } } ], "count": 1, "skip": 0, "limit": 5 }

Get All Unresolved IncidentsGET

Get All Unresolved Incidents by Project ID.

Path

  • https://fyipe.com/api/incident/:projectId/unresolvedincidents

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/unresolvedincidents

Example Response (200)

            
              

[ { "acknowledged": false, "acknowledgedByZapier": false, "resolved": false, "resolvedByZapier": false, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f", "5e089f88b400211639928c92" ], "manuallyCreated": true, "_id": "5e1c5713bc3b9e1ec8cbde31", "probes": [], "createdAt": "2020-01-13T11:40:03.720Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e139b39a55da96da8d14968", "name": "Mello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline" } ]

Get IncidentGET

Get Single Incident by Project ID and Incident ID.

Path

  • https://fyipe.com/api/incident/:projectId/incident/:incidentId

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/incident/5e1ce11ee6a04216343592bb

Example Response (200)

            
              

{ "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "deleted": false, "_id": "5e1725db1f31a13e98acd8d9", "probes": [], "createdAt": "2020-01-09T13:08:43.790Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e1633101b8ae81859214adf", "name": "Cello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "__v": 0, "acknowledgedAt": "2020-01-09T13:10:42.766Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T13:10:42.766Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }

Add Incident MessagePOST

Add Incident Message by Project ID and Incident ID.

Path

  • https://fyipe.com/api/incident/:projectId/incident/:incidentId/message

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Note

  • type string

    type can be only be 'internal' or 'investigation'

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/incident/5e1ce11ee6a04216343592bb/message

Request Body

            
              

{ "content": "This is a note", "type": "investigation", "incident_state": "creation" }

Example Response (200)

            
              

{ "updated": false, "deleted": false, "_id": "5f3ae17313c22b449b950e1a", "createdAt": "2020-08-17T19:58:43.967Z", "content": "This is a note", "incidentId": { "_id": "5f154ead30735313889f9ca2" }, "createdById": { "_id": "5ee92d2323cc0e359d45a93b", "name": "Travis Scott" }, "type": "investigation", "incident_state": "creation", "__v": 0 }

Edit Incident MessagePOST

Edit Incident Message by Incident Message ID, Project ID and Incident ID.

Path

  • https://fyipe.com/api/incident/:projectId/incident/:incidentId/message

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/incident/5e1ce11ee6a04216343592bb/message

Request Body

            
              

{ "content": "update on the notes", "id": "5f3ae17313c22b449b950e1a", "incident_state": "new state" }

Example Response (200)

            
              

{ "updated": true, "deleted": false, "_id": "5f3ae17313c22b449b950e1a", "createdAt": "2020-08-17T19:58:43.967Z", "content": "update on the notes", "incidentId": { "_id": "5f154ead30735313889f9ca2" }, "createdById": { "_id": "5ee92d2323cc0e359d45a93b", "name": "Travis Scott" }, "type": "investigation", "incident_state": "test", "__v": 0 }

Delete Incident MessageDELETE

Delete Incident Message by Incident Message ID, Project ID and Incident ID.

Path

  • https://fyipe.com/api/incident/:projectId/incident/:incidentId/message/incidentMessageId

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

  • incidentMessageId string

    The id of the incident message.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/incident/5e1ce11ee6a04216343592bb/message/5f3ae17313c22b449b950e1a

Example Response (200)

            
              

{ "updated": true, "deleted": true, "_id": "5f3ae17313c22b449b950e1a", "createdAt": "2020-08-17T19:58:43.967Z", "content": "update on the notes", "incidentId": { "_id": "5f154ead30735313889f9ca2" }, "createdById": { "_id": "5ee92d2323cc0e359d45a93b", "name": "Travis Scott" }, "type": "investigation", "incident_state": "test", "__v": 0 }

Delete IncidentDELETE

Delete Incident by Project ID and Incident ID.

Path

  • https://fyipe.com/api/incident/:projectId/:incidentId

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/5e1ce11ee6a04216343592bb

Example Response (200)

            
              

{ "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "deleted": false, "_id": "5e1ce11ee6a04216343592bb", "probes": [], "createdAt": "2020-01-13T21:29:02.315Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "createdById": "5e089f88b400211639928c92", "incidentType": "offline", "__v": 0, "acknowledgedAt": "2020-01-13T21:34:12.600Z", "acknowledgedBy": "5e089f88b400211639928c92", "resolvedAt": "2020-01-13T21:34:34.186Z", "resolvedBy": "5e089f88b400211639928c92" }

Acknowledge IncidentPOST

Acknowledge Incident by Project ID and Incident ID.

Path

  • https://fyipe.com/api/incident/:projectId/acknowledge/:incidentId

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/acknowledge/5e1ce11ee6a04216343592bb

Example Response (200)

            
              

{ "acknowledged": true, "acknowledgedByZapier": null, "resolved": false, "resolvedByZapier": false, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f", "5e089f88b400211639928c92" ], "manuallyCreated": true, "deleted": false, "_id": "5e1ce11ee6a04216343592bb", "probes": [], "createdAt": "2020-01-13T21:29:02.315Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "__v": 0, "acknowledgedAt": "2020-01-13T21:34:12.600Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }

Resolve IncidentPOST

Resolve Incident by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/incident/:projectId/resolve/:incidentId

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/resolve/5e1ce11ee6a04216343592bb

Example Response (200)

            
              

{ "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f", "5e089f88b400211639928c92" ], "manuallyCreated": true, "deleted": false, "_id": "5e1ce11ee6a04216343592bb", "probes": [], "createdAt": "2020-01-13T21:29:02.315Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "__v": 0, "acknowledgedAt": "2020-01-13T21:34:12.600Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-13T21:34:34.186Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }

Close IncidentPOST

Close Incident by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/incident/:projectId/close/:incidentId

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/close/5e1ce11ee6a04216343592bb

Example Response (200)

            
              

{ "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f", "5e089f88b400211639928c92" ], "manuallyCreated": true, "deleted": false, "_id": "5e1ce11ee6a04216343592bb", "probes": [], "createdAt": "2020-01-13T21:29:02.315Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "createdById": "5e089f88b400211639928c92", "incidentType": "offline", "__v": 0, "acknowledgedAt": "2020-01-13T21:34:12.600Z", "acknowledgedBy": "5e089f88b400211639928c92", "resolvedAt": "2020-01-13T21:34:34.186Z", "resolvedBy": "5e089f88b400211639928c92" }

Get Incident Timeline.GET

Get Incident Timeline by Project ID and Incident ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/incident/:projectId/timeline/:incidentId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/incident/5e089f94b400211639928c94/timeline/5e4ebf11f6ae637506e0f534?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "createdByZapier": false, "_id": "5e4ec0b5f6ae637506e0f71b", "createdAt": "2020-02-20T17:24:05.046Z", "incidentId": "5e4ebf11f6ae637506e0f534", "createdById": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "status": "internal notes updated" }, { "createdByZapier": false, "_id": "5e4ec0b3f6ae637506e0f718", "createdAt": "2020-02-20T17:24:03.920Z", "incidentId": "5e4ebf11f6ae637506e0f534", "createdById": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "status": "investigation notes updated" }, { "createdByZapier": false, "_id": "5e4ec0adf6ae637506e0f715", "createdAt": "2020-02-20T17:23:57.292Z", "incidentId": "5e4ebf11f6ae637506e0f534", "createdById": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "status": "internal notes added" }, { "createdByZapier": false, "_id": "5e4ec0a7f6ae637506e0f712", "createdAt": "2020-02-20T17:23:51.638Z", "incidentId": "5e4ebf11f6ae637506e0f534", "createdById": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "status": "resolved" }, { "createdByZapier": false, "_id": "5e4ec0a3f6ae637506e0f70d", "createdAt": "2020-02-20T17:23:47.004Z", "incidentId": "5e4ebf11f6ae637506e0f534", "createdById": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "status": "investigation notes added" } ], "count": 7, "skip": 0, "limit": 5 }

Monitor

Monitor API will allow you to create monitors and monitor any resource like APIs, Websites, Servers, Containers, IoT devices and more.

Path

  • https://fyipe.com/api/monitor/

Create MonitorPOST

Create Monitor by Project ID.

Path

  • https://fyipe.com/api/monitor/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94

Request Body

            
              

{ "data": { "url": "https://google.com" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } }, "componentId": "5e0800q0w400399139943n39", "projectId": "5e089f94b400211639928c94", "name": "Zello", "type": "url" }

Example Response (200)

            
              

[ { "formData": [], "headers": [], "_id": "5e1f4a6e10175840348794bd", "createdAt": "2020-01-15T17:22:54.367Z", "pollTime": "2020-01-15T17:22:54.367Z", "lastPingTime": "2020-01-15T17:22:54.367Z", "updateTime": "2020-01-15T17:22:54.367Z", "name": "Zello", "type": "url", "createdById": "5e089f88b400211639928c92", "data": { "url": "https://google.com" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } }, "probes": [ { "_id": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce4", "probeName": "US East", "lastAlive": "2020-01-06T20:12:55.011Z", "probeStatus": [], "status": "", "responseTime": "" }, { "_id": "5e08a3753ccfdd73a3bb60fe", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce5", "probeName": "US West", "lastAlive": "2019-12-29T12:43:52.563Z", "probeStatus": [], "status": "", "responseTime": "" } ], "count": 0, "incidents": [], "skip": 0, "limit": 3 } ]

Get All MonitorsGET

Get All Monitors by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/monitor/:projectId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94?skip=0&limit=5

Example Response (200)

            
              

[ { "monitors": [ { "formData": [], "headers": [], "_id": "5e1f4a6e10175840348794bd", "createdAt": "2020-01-15T17:22:54.367Z", "pollTime": "2020-01-15T17:22:54.367Z", "lastPingTime": "2020-01-15T17:22:54.367Z", "updateTime": "2020-01-15T17:22:54.367Z", "name": "Zello", "type": "url", "createdById": "5e089f88b400211639928c92", "data": { "url": "https://google.com" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } }, "probes": [ { "_id": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce4", "probeName": "US East", "lastAlive": "2020-01-06T20:12:55.011Z", "probeStatus": [], "status": "", "responseTime": "" }, { "_id": "5e08a3753ccfdd73a3bb60fe", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce5", "probeName": "US West", "lastAlive": "2019-12-29T12:43:52.563Z", "probeStatus": [], "status": "", "responseTime": "" } ], "count": 0, "incidents": [], "skip": 0, "limit": 3 }, { "formData": [], "headers": [], "_id": "5e1633101b8ae81859214adf", "createdAt": "2020-01-08T19:52:48.011Z", "pollTime": "2020-01-08T19:52:48.011Z", "lastPingTime": "2020-01-08T19:52:48.011Z", "updateTime": "2020-01-08T19:52:48.011Z", "name": "Cello", "type": "url", "createdById": "5e089f88b400211639928c92", "data": { "url": "https://google.com" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } }, "probes": [ { "_id": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce4", "probeName": "US East", "lastAlive": "2020-01-06T20:12:55.011Z", "probeStatus": [], "status": "", "responseTime": "" }, { "_id": "5e08a3753ccfdd73a3bb60fe", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce5", "probeName": "US West", "lastAlive": "2019-12-29T12:43:52.563Z", "probeStatus": [], "status": "", "responseTime": "" } ], "count": 3, "incidents": [ { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e1b7f0f41127144f8144abb", "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1ce0f3e6a04216343592b9", "probes": [], "createdAt": "2020-01-13T21:28:19.916Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e1633101b8ae81859214adf", "name": "Cello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-13T22:03:55.776Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-13T22:03:55.776Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "Test", "investigationNote": "Test", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1725db1f31a13e98acd8d9", "probes": [], "createdAt": "2020-01-09T13:08:43.790Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e1633101b8ae81859214adf", "name": "Cello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T13:10:42.766Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T13:10:42.766Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [ "5e162d9f1b8ae8185921498f" ], "manuallyCreated": true, "_id": "5e1724591f31a13e98acd8d5", "probes": [], "createdAt": "2020-01-09T13:02:17.254Z", "projectId": "5e089f94b400211639928c94", "monitorId": { "_id": "5e1633101b8ae81859214adf", "name": "Cello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "incidentType": "offline", "acknowledgedAt": "2020-01-09T13:07:50.158Z", "acknowledgedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-09T13:07:50.158Z", "resolvedBy": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } } ], "skip": 0, "limit": 3 }, ... ], "count": 5, "_id": "5e089f94b400211639928c94", "skip": 0, "limit": 5 } ]

Get All Monitors By TypeGET

Get All Monitors by Project ID and Monitor Type. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/monitor/:projectId/monitor

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

  • type 'url' | 'api' | 'device' | 'server-monitor' | 'script'

    The type of the project monitor.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/monitor?skip=0&limit=5&type=url

Example Response (200)

            
              

{ "data": [ { "formData": [], "headers": [], "_id": "5e1f4a6e10175840348794bd", "createdAt": "2020-01-15T17:22:54.367Z", "pollTime": "2020-01-15T17:22:54.367Z", "lastPingTime": "2020-01-15T17:22:54.367Z", "updateTime": "2020-01-15T17:22:54.367Z", "name": "Zello", "type": "url", "createdById": "5e089f88b400211639928c92", "data": { "url": "https://google.com" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } } }, { "formData": [], "headers": [], "_id": "5e1633101b8ae81859214adf", "createdAt": "2020-01-08T19:52:48.011Z", "pollTime": "2020-01-08T19:52:48.011Z", "lastPingTime": "2020-01-08T19:52:48.011Z", "updateTime": "2020-01-08T19:52:48.011Z", "name": "Cello", "type": "url", "createdById": "5e089f88b400211639928c92", "data": { "url": "https://google.com" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } } } ... ], "count": 5, "skip": 0, "limit": 5 }

Get MonitorGET

Get Single Monitor by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/monitor/:projectId/monitor/:monitorId

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/monitor/5e1f4a6e10175840348794bd

Example Response (200)

            
              

{ "formData": [], "headers": [], "deleted": false, "_id": "5e1f4a6e10175840348794bd", "createdAt": "2020-01-15T17:22:54.367Z", "pollTime": "2020-01-15T17:22:54.367Z", "lastPingTime": "2020-01-15T17:22:54.367Z", "updateTime": "2020-01-15T17:22:54.367Z", "name": "Zello", "type": "url", "createdById": "5e089f88b400211639928c92", "data": { "url": "https://google.com" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } }, "__v": 0 }

Edit MonitorPUT

Edit Monitor by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/monitor/:projectId/:monitorId

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/5e1f4a6e10175840348794bd

Request Body

            
              

{ "data": { "url": "https://google.com" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } }, "projectId": "5e089f94b400211639928c94", "name": "Wello", "type": "url" }

Example Response (200)

            
              

[ { "formData": [], "headers": [], "_id": "5e1f4a6e10175840348794bd", "createdAt": "2020-01-15T17:22:54.367Z", "pollTime": "2020-01-15T17:22:54.367Z", "lastPingTime": "2020-01-15T17:22:54.367Z", "updateTime": "2020-01-15T17:22:54.367Z", "name": "Wello", "type": "url", "createdById": "5e089f88b400211639928c92", "data": { "url": "https://google.com" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } }, "probes": [ { "_id": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce4", "probeName": "US East", "lastAlive": "2020-01-06T20:12:55.011Z", "probeStatus": [], "status": "", "responseTime": "" }, { "_id": "5e08a3753ccfdd73a3bb60fe", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce5", "probeName": "US West", "lastAlive": "2019-12-29T12:43:52.563Z", "probeStatus": [], "status": "", "responseTime": "" } ], "count": 0, "incidents": [], "skip": 0, "limit": 3 } ]

Delete MonitorDELETE

Delete Monitor by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/monitor/:projectId/:monitorId

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/5e1f4a6e10175840348794bd

Example Response (200)

            
              

{ "formData": [], "headers": [], "deleted": true, "_id": "5e1f4a6e10175840348794bd", "createdAt": "2020-01-15T17:22:54.367Z", "pollTime": "2020-01-15T17:22:54.367Z", "lastPingTime": "2020-01-15T17:22:54.367Z", "updateTime": "2020-01-15T17:22:54.367Z", "name": "Wello", "type": "url", "createdById": "5e089f88b400211639928c92", "data": { "url": "https://google.com" }, "projectId": "5e089f94b400211639928c94", "criteria": { "up": { "and": [ { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200" }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300" }, { "responseType": "doesRespond", "filter": "isUp" }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000" } ], "or": [], "createAlert": false, "autoAcknowledge": false, "autoResolve": false }, "degraded": { "and": [ { "responseType": "responseTime", "filter": "greaterThan", "field1": "5000" } ], "or": [], "createAlert": true, "autoAcknowledge": true, "autoResolve": true }, "down": { "and": [], "or": [ { "responseType": "doesRespond", "filter": "isDown" }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400" } ], "createAlert": true, "autoAcknowledge": true, "autoResolve": true } }, "__v": 0, "deletedAt": "2020-01-15T18:27:41.119Z", "deletedById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }

Create Server Monitor LogPOST

Create Server Monitor Log by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/monitor/:projectId/log/:monitorId

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/log/5e1f4a6e10175840348794bd

Request Body

            
              

{ "data": { "load": { "avgload": 0.31, "currentload": 11.993297816580107, "currentload_user": 9.221739863479614, "currentload_system": 2.712832208199919, "currentload_nice": 0.05872574490057444, "currentload_idle": 88.00670218341989, "currentload_irq": 0, "raw_currentload": 65372600, "raw_currentload_user": 50265500, "raw_currentload_system": 14787000, "raw_currentload_nice": 320100, "raw_currentload_idle": 479703500, "raw_currentload_irq": 0, "cpus": [ 1, 2, 3, 4 ] }, "memory": { "total": 6097825792, "free": 149876736, "used": 5947949056, "active": 4246343680, "available": 688734208, "buffcache": 1701605376, "swaptotal": 6143602688, "swapused": 684810240, "swapfree": 5458792448 }, "disk": { "fs": "/dev/sda7", "type": "ext4", "size": 267669123072, "used": 79250288640, "use": 29.61, "mount": "/" }, "traffic": [ { "iface": "wlp2s0", "operstate": "up", "rx_bytes": 259915784, "rx_dropped": 0, "rx_errors": 0, "tx_bytes": 20517137, "tx_dropped": 0, "tx_errors": 0, "rx_sec": -1, "tx_sec": -1, "ms": 0 } ], "temperature": { "main": 47, "cores": [ 47, 47 ], "max": 47 }, "resources": { "manufacturer": "Intel®", "brand": "Core™ i5-7200U", "vendor": "GenuineIntel", "family": "6", "model": "142", "stepping": "9", "revision": "", "voltage": "", "speed": "2.50", "speedmin": "0.40", "speedmax": "3.10", "cores": 4, "physicalCores": 2, "processors": 1, "socket": "", "cache": { "l1d": 65536, "l1i": 65536, "l2": 524288, "l3": 3 } }, "users": [ { "user": "hibeekaey", "tty": ": 0", "date": "2020-01-14", "time": "23: 12", "ip": ": 0", "command": "/usr/lib/gdm3/gdm-x-session --run-script env GNOME_SHELL_SESSION_MODE=ubuntu /usr/bin/gnome-session --systemd --session=ubuntu" } ], "network": [], "vbox": [] } }

Example Response (200)

            
              

{ "incidentIds": [ "5e1f596f96e8204612e8d775" ], "_id": "5e1f596e96e8204612e8d773", "createdAt": "2020-01-15T18:26:54.704Z", "monitorId": "5e1f4a6e10175840348794bd", "data": { "load": { "avgload": 0.31, "currentload": 11.993297816580107, "currentload_user": 9.221739863479614, "currentload_system": 2.712832208199919, "currentload_nice": 0.05872574490057444, "currentload_idle": 88.00670218341989, "currentload_irq": 0, "raw_currentload": 65372600, "raw_currentload_user": 50265500, "raw_currentload_system": 14787000, "raw_currentload_nice": 320100, "raw_currentload_idle": 479703500, "raw_currentload_irq": 0, "cpus": [ 1, 2, 3, 4 ] }, "memory": { "total": 6097825792, "free": 149876736, "used": 5947949056, "active": 4246343680, "available": 688734208, "buffcache": 1701605376, "swaptotal": 6143602688, "swapused": 684810240, "swapfree": 5458792448 }, "disk": { "fs": "/dev/sda7", "type": "ext4", "size": 267669123072, "used": 79250288640, "use": 29.61, "mount": "/" }, "traffic": [ { "iface": "wlp2s0", "operstate": "up", "rx_bytes": 259915784, "rx_dropped": 0, "rx_errors": 0, "tx_bytes": 20517137, "tx_dropped": 0, "tx_errors": 0, "rx_sec": -1, "tx_sec": -1, "ms": 0 } ], "temperature": { "main": 47, "cores": [ 47, 47 ], "max": 47 }, "resources": { "manufacturer": "Intel®", "brand": "Core™ i5-7200U", "vendor": "GenuineIntel", "family": "6", "model": "142", "stepping": "9", "revision": "", "voltage": "", "speed": "2.50", "speedmin": "0.40", "speedmax": "3.10", "cores": 4, "physicalCores": 2, "processors": 1, "socket": "", "cache": { "l1d": 65536, "l1i": 65536, "l2": 524288, "l3": 3 } }, "users": [ { "user": "hibeekaey", "tty": ": 0", "date": "2020-01-14", "time": "23: 12", "ip": ": 0", "command": "/usr/lib/gdm3/gdm-x-session --run-script env GNOME_SHELL_SESSION_MODE=ubuntu /usr/bin/gnome-session --systemd --session=ubuntu" } ], "network": [], "vbox": [] }, "status": "degraded", "__v": 0 }

Get Monitor LogsPOST

Get Monitor Logs by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/monitor/:projectId/monitorLogs/:monitorId

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/monitorLogs/5e08a21b25c59a1c8033c7e7

Request Body

            
              

{ "skip": "0", "limit": "5", "probeValue": "5e08a2c83ccfdd73a3bb5f21" }

Example Response (200)

            
              

{ "data": { "monitorLogs": [ { "incidentIds": [], "_id": "5e1394b9a55da96da8d148bc", "createdAt": "2020-01-06T20:12:41.149Z", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "probeId": { "_id": "5e08a2c83ccfdd73a3bb5f21", "probeName": "US East" }, "responseTime": 6051, "responseStatus": 408, "status": "offline" }, { "incidentIds": [], "_id": "5e13947fa55da96da8d148b1", "createdAt": "2020-01-06T20:11:43.098Z", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "probeId": { "_id": "5e08a2c83ccfdd73a3bb5f21", "probeName": "US East" }, "responseTime": 5059, "responseStatus": 408, "status": "offline" }, { "incidentIds": [], "_id": "5e13943da55da96da8d148af", "createdAt": "2020-01-06T20:10:37.854Z", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "probeId": { "_id": "5e08a2c83ccfdd73a3bb5f21", "probeName": "US East" }, "responseTime": 5028, "responseStatus": 408, "status": "offline" }, { "incidentIds": [], "_id": "5e1393faa55da96da8d148a8", "createdAt": "2020-01-06T20:09:30.195Z", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "probeId": { "_id": "5e08a2c83ccfdd73a3bb5f21", "probeName": "US East" }, "responseTime": 8709, "responseStatus": 408, "status": "offline" }, { "incidentIds": [], "_id": "5e1393bea55da96da8d1489c", "createdAt": "2020-01-06T20:08:30.212Z", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "probeId": { "_id": "5e08a2c83ccfdd73a3bb5f21", "probeName": "US East" }, "responseTime": 5038, "responseStatus": 408, "status": "offline" } ], "probes": [ { "_id": "5e08a2c83ccfdd73a3bb5f21", "probeName": "US East" } ] }, "count": 113 }

Get Aggregate Monitor LogsGET

Get Aggregate Monitor Logs by Project ID and Monitor ID. Return results by Start Date and End Date.

Path

  • https://fyipe.com/api/monitor/:projectId/log/:monitorId

Query Params

  • startDate Date

    The start date of the date range.

  • endDate Date

    The end date of the date range.

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/log/5e08a21b25c59a1c8033c7e7?startDate=Mon%20Dec%2009%202019%2021:06:54%20GMT+0100&endDate=Wed%20Jan%2008%202020%2021:06:54%20GMT+0100

Example Response (200)

            
              

{ "data": [ { "_id": "5e08a2c83ccfdd73a3bb5f21", "logs": [ { "_id": { "probeId": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2020-01-06" }, "monitorId": "5e08a21b25c59a1c8033c7e7", "probeId": "5e08a2c83ccfdd73a3bb5f21", "responseTime": 6051, "responseStatus": 408, "status": "offline", "data": null, "createdAt": "2020-01-06T20:12:41.149Z", "avgResponseTime": 4506.742857142857, "avgCpuLoad": null, "avgMemoryUsed": null, "avgStorageUsed": null, "avgMainTemp": null, "count": 70, "intervalDate": "Jan 6th 2020" }, { "_id": { "probeId": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-31" }, "monitorId": "5e08a21b25c59a1c8033c7e7", "probeId": "5e08a2c83ccfdd73a3bb5f21", "responseTime": 5730, "responseStatus": 408, "status": "offline", "data": null, "createdAt": "2019-12-31T16:14:00.756Z", "avgResponseTime": 3369.521739130435, "avgCpuLoad": null, "avgMemoryUsed": null, "avgStorageUsed": null, "avgMainTemp": null, "count": 23, "intervalDate": "Dec 31st 2019" }, { "_id": { "probeId": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-30" }, "monitorId": "5e08a21b25c59a1c8033c7e7", "probeId": "5e08a2c83ccfdd73a3bb5f21", "responseTime": 5001, "responseStatus": 408, "status": "offline", "data": null, "createdAt": "2019-12-30T15:03:20.050Z", "avgResponseTime": 4295.090909090909, "avgCpuLoad": null, "avgMemoryUsed": null, "avgStorageUsed": null, "avgMainTemp": null, "count": 11, "intervalDate": "Dec 30th 2019" }, { "_id": { "probeId": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-29" }, "monitorId": "5e08a21b25c59a1c8033c7e7", "probeId": "5e08a2c83ccfdd73a3bb5f21", "responseTime": 1369, "responseStatus": 200, "status": "online", "data": null, "createdAt": "2019-12-29T13:17:01.395Z", "avgResponseTime": 1593.5, "avgCpuLoad": null, "avgMemoryUsed": null, "avgStorageUsed": null, "avgMainTemp": null, "count": 4, "intervalDate": "Dec 29th 2019" } ] } ], "count": 1 }

Add Monitor Seat To ProjectPOST

Add Monitor Seat To Project by Project ID.

Path

  • https://fyipe.com/api/monitor/:projectId/addseat

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/addseat

Example Response (200)

            
              

A new seat added. Now you can add a monitor

Update Device Monitor Ping TimePOST or GET

Update Device Monitor Ping Time by Project ID and Device ID.

Path

  • https://fyipe.com/api/monitor/:projectId/inbound/:deviceId

Path Variables

  • projectId string

    The project id of the project.

  • deviceId string

    The device id of the device monitor.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/inbound/12345

Example Response (200)

            
              

{ "formData": [], "headers": [], "deleted": false, "_id": "5e1f5b0796e8204612e8d83b", "createdAt": "2020-01-15T18:33:43.474Z", "pollTime": "2020-01-15T18:33:43.474Z", "lastPingTime": "2020-01-15T18:33:43.474Z", "updateTime": "2020-01-15T18:33:43.474Z", "name": "Hello", "type": "device", "createdById": "5e089f88b400211639928c92", "data": { "deviceId": "12345" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "__v": 0, "probes": [ { "deleted": false, "_id": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce4", "probeName": "US East", "lastAlive": "2020-01-06T20:12:55.011Z", "probeStatus": [], "status": "", "responseTime": "" }, { "deleted": false, "_id": "5e08a3753ccfdd73a3bb60fe", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce5", "probeName": "US West", "lastAlive": "2019-12-29T12:43:52.563Z", "probeStatus": [], "status": "", "responseTime": "" } ], "count": 0, "incidents": [], "skip": 0, "limit": 3 }

Get Device Monitor Ping TimeGET

Get Device Monitor Ping Time by Project ID and Device ID.

Path

  • https://fyipe.com/api/monitor/:projectId/inbound/:deviceId

Path Variables

  • projectId string

    The project id of the project.

  • deviceId string

    The device id of the device monitor.

Example Request

Request URL

https://fyipe.com/api/monitor/5e089f94b400211639928c94/inbound/12345

Example Response (200)

            
              

{ "formData": [], "headers": [], "deleted": false, "_id": "5e1f5b0796e8204612e8d83b", "createdAt": "2020-01-15T18:33:43.474Z", "pollTime": "2020-01-15T18:33:43.474Z", "lastPingTime": "2020-01-15T18:33:43.474Z", "updateTime": "2020-01-15T18:33:43.474Z", "name": "Hello", "type": "device", "createdById": "5e089f88b400211639928c92", "data": { "deviceId": "12345" }, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "__v": 0, "probes": [ { "deleted": false, "_id": "5e08a2c83ccfdd73a3bb5f21", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce4", "probeName": "US East", "lastAlive": "2020-01-06T20:12:55.011Z", "probeStatus": [], "status": "", "responseTime": "" }, { "deleted": false, "_id": "5e08a3753ccfdd73a3bb60fe", "createdAt": "2019-12-29T12:43:52.563Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce5", "probeName": "US West", "lastAlive": "2019-12-29T12:43:52.563Z", "probeStatus": [], "status": "", "responseTime": "" } ], "count": 0, "incidents": [], "skip": 0, "limit": 3 }

Monitor Category

Monitor Category API will allow you to group monitors by categories on Status Page. You can categorize monitors by location, e.g. US, EU. You can also categorize monitors by project.

Path

  • https://fyipe.com/api/monitorCategory/

Create Monitor CategoryPOST

Create Monitor Category by Project ID.

Path

  • https://fyipe.com/api/monitorCategory/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/monitorCategory/5e089f94b400211639928c94

Request Body

            
              

{ "monitorCategoryName": "US EAST" }

Example Response (200)

            
              

{ "deleted": false, "_id": "5e1cee56e6a0421634359442", "createdAt": "2020-01-13T22:25:26.028Z", "projectId": "5e089f94b400211639928c94", "createdById": "5e089f88b400211639928c92", "name": "US EAST", "__v": 0 }

Get All Monitor CategoriesGET

Get All Monitor Categories by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/monitorCategory/:projectId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/monitorCategory/5e089f94b400211639928c94?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "name": "EU", "_id": "5e1cee56e6a0421634359442", "createdAt": "2020-01-13T22:25:26.028Z" }, { "name": "US EAST", "_id": "5e1cedace6a0421634359441", "createdAt": "2020-01-13T22:22:36.084Z" } ], "count": 2, "skip": 0, "limit": 5 }

Edit Monitor CategoryPUT

Edit Monitor Category by Project ID and Monitor Category ID.

Path

  • https://fyipe.com/api/monitorCategory/:projectId/:monitorCategoryId

Path Variables

  • projectId string

    The project id of the project.

  • monitorCategoryId string

    The monitor category id of the monitor category.

Example Request

Request URL

https://fyipe.com/api/monitorCategory/5e089f94b400211639928c94/5e1cedace6a0421634359441

Request Body

            
              

{ "deleted": false, "_id": "5e1cedace6a0421634359441", "createdAt": "2020-01-13T22:22:36.084Z", "projectId": "5e089f94b400211639928c94", "createdById": "5e089f88b400211639928c92", "name": "US EAST", "__v": 0 }

Example Response (200)

            
              

{ "deleted": false, "_id": "5e1cedace6a0421634359441", "createdAt": "2020-01-13T22:22:36.084Z", "projectId": "5e089f94b400211639928c94", "createdById": "5e089f88b400211639928c92", "name": "US EAST", "__v": 0 }

Delete Monitor CategoryDELETE

Delete Monitor Category by Project ID and Monitor Category ID.

Path

  • https://fyipe.com/api/monitorCategory/:projectId/:monitorCategoryId

Path Variables

  • projectId string

    The project id of the project.

  • monitorCategoryId string

    The monitor category id of the monitor category.

Example Request

Request URL

https://fyipe.com/api/monitorCategory/5e089f94b400211639928c94/5e1cedace6a0421634359441

Example Response (200)

            
              

{ "deleted": true, "_id": "5e1cedace6a0421634359441", "createdAt": "2020-01-13T22:22:36.084Z", "projectId": "5e089f94b400211639928c94", "createdById": "5e089f88b400211639928c92", "name": "US EAST", "__v": 0, "deletedAt": "2020-01-13T22:28:17.243Z", "deletedById": "5e089f88b400211639928c92" }

Monitor Criteria

Monitor Criteria API will allow you to get the default monitor criteria (Up, Degraded or Down) for your Fyipe project monitors.

Path

  • https://fyipe.com/api/monitorCriteria/

Get Default CriteriaGET

Get Default Criteria for your Fyipe Project Monitors.

Path

  • https://fyipe.com/api/monitorCriteria/

Example Request

Request URL

https://fyipe.com/api/monitorCriteria/

Example Response (200)

            
              

{ "url": { "up_1000": [ { "match": "all", "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200", "field2": "", "field3": false }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300", "field2": "", "field3": false }, { "responseType": "doesRespond", "filter": "isUp", "field1": "", "field2": "", "field3": false }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000", "field2": "", "field3": false } ], "up_1000_createAlert": false, "up_1000_autoAcknowledge": false, "up_1000_autoResolve": false, "down_1000": [ { "match": "any", "responseType": "doesRespond", "filter": "isDown", "field1": "", "field2": "", "field3": false }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400", "field2": "", "field3": false } ], "down_1000_createAlert": true, "down_1000_autoAcknowledge": true, "down_1000_autoResolve": true, "degraded_1000": [ { "match": "all", "responseType": "responseTime", "filter": "greaterThan", "field1": "5000", "field2": "", "field3": false } ], "degraded_1000_createAlert": true, "degraded_1000_autoAcknowledge": true, "degraded_1000_autoResolve": true, "type_1000": "url" }, "api": { "up_1000": [ { "match": "all", "responseType": "statusCode", "filter": "gtEqualTo", "field1": "200", "field2": "", "field3": false }, { "responseType": "statusCode", "filter": "lessThan", "field1": "300", "field2": "", "field3": false }, { "responseType": "doesRespond", "filter": "isUp", "field1": "", "field2": "", "field3": false }, { "responseType": "responseTime", "filter": "ltEqualTo", "field1": "5000", "field2": "", "field3": false } ], "up_1000_createAlert": false, "up_1000_autoAcknowledge": false, "up_1000_autoResolve": false, "down_1000": [ { "match": "any", "responseType": "doesRespond", "filter": "isDown", "field1": "", "field2": "", "field3": false }, { "responseType": "statusCode", "filter": "gtEqualTo", "field1": "400", "field2": "", "field3": false } ], "down_1000_createAlert": true, "down_1000_autoAcknowledge": true, "down_1000_autoResolve": true, "degraded_1000": [ { "match": "all", "responseType": "responseTime", "filter": "greaterThan", "field1": "5000", "field2": "", "field3": false } ], "degraded_1000_createAlert": true, "degraded_1000_autoAcknowledge": true, "degraded_1000_autoResolve": true, "type_1000": "api" }, "script": { "up_1000": [ { "match": "all", "responseType": "executes", "filter": "executesIn", "field1": "5000", "field2": "", "field3": false }, { "responseType": "error", "filter": "doesNotThrowError", "field1": "", "field2": "", "field3": false } ], "up_1000_createAlert": false, "up_1000_autoAcknowledge": false, "up_1000_autoResolve": false, "down_1000": [ { "match": "any", "responseType": "error", "filter": "throwsError", "field1": "", "field2": "", "field3": false }, { "responseType": "executes", "filter": "doesNotExecuteIn", "field1": "15000", "field2": "", "field3": false } ], "down_1000_createAlert": true, "down_1000_autoAcknowledge": true, "down_1000_autoResolve": true, "degraded_1000": [ { "match": "all", "responseType": "executes", "filter": "doesNotExecuteIn", "field1": "5000", "field2": "", "field3": false }, { "responseType": "error", "filter": "doesNotThrowError", "field1": "", "field2": "", "field3": false }, { "responseType": "executes", "filter": "executesIn", "field1": "15000", "field2": "", "field3": false } ], "degraded_1000_createAlert": true, "degraded_1000_autoAcknowledge": true, "degraded_1000_autoResolve": true, "type_1000": "script" }, "server-monitor": { "up_1000": [ { "match": "all", "responseType": "storageUsage", "filter": "greaterThan", "field1": "10", "field2": "", "field3": false }, { "responseType": "doesRespond", "filter": "isUp", "field1": "", "field2": "", "field3": false } ], "up_1000_createAlert": false, "up_1000_autoAcknowledge": false, "up_1000_autoResolve": false, "down_1000": [ { "match": "any", "responseType": "doesRespond", "filter": "isDown", "field1": "", "field2": "", "field3": false }, { "responseType": "storageUsage", "filter": "lessThan", "field1": "5", "field2": "", "field3": false } ], "down_1000_createAlert": true, "down_1000_autoAcknowledge": true, "down_1000_autoResolve": true, "degraded_1000": [ { "match": "all", "responseType": "storageUsage", "filter": "greaterThan", "field1": "5", "field2": "", "field3": false }, { "responseType": "doesRespond", "filter": "isUp", "field1": "", "field2": "", "field3": false }, { "responseType": "storageUsage", "filter": "lessThan", "field1": "10", "field2": "", "field3": false } ], "degraded_1000_createAlert": true, "degraded_1000_autoAcknowledge": true, "degraded_1000_autoResolve": true, "type_1000": "server-monitor" }, "default": { "up_1000": [ { "match": "", "responseType": "", "filter": "", "field1": "", "field2": "", "field3": false } ], "up_1000_createAlert": false, "up_1000_autoAcknowledge": false, "up_1000_autoResolve": false, "down_1000": [ { "match": "", "responseType": "", "filter": "", "field1": "", "field2": "", "field3": false } ], "down_1000_createAlert": true, "down_1000_autoAcknowledge": true, "down_1000_autoResolve": true, "degraded_1000": [ { "match": "", "responseType": "", "filter": "", "field1": "", "field2": "", "field3": false } ], "degraded_1000_createAlert": true, "degraded_1000_autoAcknowledge": true, "degraded_1000_autoResolve": true, "type_1000": "" } }

Project

Project API will allow you to change your Fyipe project settings like project name and also create and manage sub-projects. Sub-projects will allow you have to flexible access controls between Fyipe resources and your team.

Path

  • https://fyipe.com/api/project/

Delete Team MemberDELETE

Delete Team Member by Project ID and User ID.

Path

  • https://fyipe.com/api/project/:projectId/user/:userId/exitProject

Path Variables

  • projectId string

    The project id of the project.

  • userId string

    The user id of the project team member.

Example Request

Request URL

https://fyipe.com/api/project/5e3db40790968537f188cee1/user/5e2ecf3f516aae26b133f352/exitProject

Example Response (200)

            
              

User successfully exited the project

Create SubProjectPOST

Create SubProject by Project ID.

Path

  • https://fyipe.com/api/project/:projectId/subProject

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/project/5e3db40790968537f188cee1/subProject

Request Body

            
              

{ "subProjectName": "Vello" }

Example Response (200)

            
              

[ { "alertOptions": { "billingUS": true, "billingNonUSCountries": false, "billingRiskCountries": false }, "seats": "1", "alertEnable": false, "alertLimitReached": false, "balance": 0, "isBlocked": false, "_id": "5e3db51390968537f188cef7", "users": [ { "_id": "5e3db40790968537f188cee2", "userId": "5e2ecf3f516aae26b133f352", "role": "Owner" } ], "createdAt": "2020-02-07T19:05:55.143Z", "adminNotes": null, "name": "Vello", "slug": "Vello-32034", "apiKey": "ddd332a0-49dc-11ea-9025-59d19fb1a7b1", "stripePlanId": null, "stripeSubscriptionId": null, "parentProjectId": { "_id": "5e3db40790968537f188cee1", "name": "Dello" } } ]

Get All SubProjectsGET

Get All SubProjects by Project ID.

Path

  • https://fyipe.com/api/project/:projectId/subProject

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/project/5e2ecf45516aae26b133f354/subProject

Example Response (200)

            
              

{ "data": [ { "alertOptions": { "billingUS": true, "billingNonUSCountries": false, "billingRiskCountries": false }, "seats": "1", "alertEnable": false, "alertLimitReached": false, "balance": 0, "isBlocked": false, "_id": "5e321f54542c6f61d1292a5a", "users": [ { "_id": "5e2ecf45516aae26b133f355", "userId": "5e2ecf3f516aae26b133f352", "role": "Owner" } ], "createdAt": "2020-01-30T00:12:04.455Z", "adminNotes": null, "name": "Vello", "slug": "Vello-01020", "apiKey": "2521e320-42f5-11ea-9574-31ddcc0c3f10", "stripePlanId": null, "stripeSubscriptionId": null, "parentProjectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" } } ], "count": 1 }

Rename SubProjectPUT

Rename SubProject by Project ID and SubProject ID.

Path

  • https://fyipe.com/api/project/:projectId/:subProjectId

Path Variables

  • projectId

    The project id of the project.

  • subProjectId

    The subproject id of the project.

Example Request

Request URL

https://fyipe.com/api/project/5e2ecf45516aae26b133f354/5e321f54542c6f61d1292a5a

Request Body

            
              

{ "subProjectName": "Vello" }

Example Response (200)

            
              

{ "alertOptions": { "billingUS": true, "billingNonUSCountries": false, "billingRiskCountries": false }, "seats": "1", "deleted": false, "alertEnable": false, "alertLimitReached": false, "balance": 0, "isBlocked": false, "_id": "5e321f54542c6f61d1292a5a", "users": [ { "_id": "5e2ecf45516aae26b133f355", "userId": "5e2ecf3f516aae26b133f352", "role": "Owner" } ], "createdAt": "2020-01-30T00:12:04.455Z", "adminNotes": null, "name": "Vello", "slug": "Vello-01020", "apiKey": "2521e320-42f5-11ea-9574-31ddcc0c3f10", "stripePlanId": null, "stripeSubscriptionId": null, "parentProjectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" }, "__v": 0 }

Delete SubProjectDELETE

Delete SubProject by Project ID and SubProject ID.

Path

  • https://fyipe.com/api/project/:projectId/:subProjectId

Path Variables

  • projectId

    The project id of the project.

  • subProjectId

    The subproject id of the project.

Example Request

Request URL

https://fyipe.com/api/project/5e3db40790968537f188cee1/5e3db49190968537f188cef4

Example Response (200)

            
              

{ "alertOptions": { "billingUS": true, "billingNonUSCountries": false, "billingRiskCountries": false }, "seats": "1", "deleted": true, "alertEnable": false, "alertLimitReached": false, "balance": 0, "isBlocked": false, "_id": "5e3db49190968537f188cef4", "users": [ { "_id": "5e3db40790968537f188cee2", "userId": "5e2ecf3f516aae26b133f352", "role": "Owner" } ], "createdAt": "2020-02-07T19:03:45.177Z", "adminNotes": null, "name": "Vello", "slug": "Vello-02850", "apiKey": "905ce020-49dc-11ea-9025-59d19fb1a7b1", "stripePlanId": null, "stripeSubscriptionId": null, "parentProjectId": "5e3db40790968537f188cee1", "__v": 0, "deletedAt": "2020-02-07T19:05:11.436Z", "deletedById": "5e2ecf3f516aae26b133f352" }

Report

Report API will allow you to get the average incident resolve times, average number of incidents resolved, members with highest number of resolves and monitor with highest number of incidents over a period of time in your Fyipe project.

Path

  • https://fyipe.com/api/reports/

Get All Active MembersGET

Get All Active Members by Project ID. Return by skipping and limiting the number of results and by Start Date and End Date.

Path

  • https://fyipe.com/api/reports/:projectId/active-members

Query Params

  • startDate Date

    The start date of the date range.

  • endDate Date

    The end date of the date range.

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/reports/5e089f94b400211639928c94/active-members?startDate=Mon%20Dec%2009%202019%2021:06:54%20GMT+0100&endDate=Wed%20Jan%2008%202020%2021:06:54%20GMT+0100&skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "memberId": "5e089f88b400211639928c92", "memberName": "Nawaz Dhandala", "incidents": 30, "averageAcknowledgeTime": 663502.1, "averageResolved": 663502.1 } ], "count": 1, "skip": 0, "limit": 5 }

Get All Active MonitorsGET

Get All Active Monitors by Project ID. Return by skipping and limiting the number of results and by Start Date and End Date.

Path

  • https://fyipe.com/api/reports/:projectId/active-monitors

Query Params

  • startDate Date

    The start date of the date range.

  • endDate Date

    The end date of the date range.

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/reports/5e089f94b400211639928c94/active-monitors?startDate=Mon%20Dec%2009%202019%2021:06:54%20GMT+0100&endDate=Wed%20Jan%2008%202020%2021:06:54%20GMT+0100&skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "monitorId": "5e0a4b1678caf04fd1fedcbe", "monitorName": "Ubuntu Machine", "incidents": 6, "averageAcknowledgeTime": 2162461, "averageResolved": 2162461 }, { "monitorId": "5e139b39a55da96da8d14968", "monitorName": "Mello", "incidents": 4, "averageAcknowledgeTime": 111149.75, "averageResolved": 111149.75 } ], "count": 2, "skip": 0, "limit": 5 }

Get Average ResolvedGET

Get Average Resolved by Project ID. Return results by Start Date, End Date and Date Filter.

Path

  • https://fyipe.com/api/reports/:projectId/average-resolved

Query Params

  • startDate Date

    The start date of the date range.

  • endDate Date

    The end date of the date range.

  • filter 'day' | 'month' | 'week' | 'year'

    The date filter e.g. day, month, week, year, of the date range.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/reports/5e089f94b400211639928c94/average-resolved?startDate=Mon%20Dec%2009%202019%2021:06:54%20GMT+0100&endDate=Wed%20Jan%2008%202020%2021:06:54%20GMT+0100&filter=month

Example Response (200)

            
              

{ "data": [ { "incidents": 13, "averageResolved": 127, "month": "Dec 2019" }, { "incidents": 17, "averageResolved": 1074, "month": "Jan 2020" } ], "count": 2 }

Get Incidents CountGET

Get Incidents Count by Project ID. Return results by Start Date, End Date and Date Filter.

Path

  • https://fyipe.com/api/reports/:projectId/incidents

Query Params

  • startDate Date

    The start date of the date range.

  • endDate Date

    The end date of the date range.

  • filter 'day' | 'month' | 'week' | 'year'

    The date filter e.g. day, month, week, year, of the date range.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/reports/5e089f94b400211639928c94/incidents?startDate=Mon%20Dec%2009%202019%2021:06:54%20GMT+0100&endDate=Wed%20Jan%2008%202020%2021:06:54%20GMT+0100&filter=month

Example Response (200)

            
              

{ "data": [ { "incidents": 13, "month": "Dec 2019" }, { "incidents": 17, "month": "Jan 2020" } ], "count": 2 }

Schedule

Schedule API will allow you to connect your team members to specific monitors, so only on-duty members who are responsible for certain monitors are alerted when an incident is created.

Path

  • https://fyipe.com/api/schedule/

Create SchedulePOST

Create Schedule by Project ID.

Path

  • https://fyipe.com/api/schedule/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/schedule/5e089f94b400211639928c94

Request Body

            
              

{ "name": "Call Team Members" }

Example Response (200)

            
              

{ "userIds": [], "monitorIds": [], "escalationIds": [], "deleted": false, "_id": "5e1e1e25b1df96583e883f23", "createdAt": "2020-01-14T20:01:41.409Z", "name": "Call Team Members", "projectId": "5e089f94b400211639928c94", "createdById": "5e089f88b400211639928c92", "__v": 0 }

Get All SchedulesGET

Get All Schedules by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/schedule/:projectId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/schedule/5e089f94b400211639928c94?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "userIds": [], "monitorIds": [ { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" } ], "escalationIds": [], "_id": "5e1e1e25b1df96583e883f23", "createdAt": "2020-01-14T20:01:41.409Z", "name": "Call Team Members", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "userIds": [], "monitorIds": [ { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" } ], "escalationIds": [], "_id": "5e1e1d2bb1df96583e883f22", "createdAt": "2020-01-14T19:57:31.646Z", "name": "Call Nilanshu", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } } ], "count": 2, "skip": 0, "limit": 5 }

Get All SchedulesGET

Get All Schedules by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/schedule/:projectId/schedule

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/schedule/5e089f94b400211639928c94/schedule?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "userIds": [], "monitorIds": [ { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" } ], "escalationIds": [], "_id": "5e1e1e25b1df96583e883f23", "createdAt": "2020-01-14T20:01:41.409Z", "name": "Call Team Members", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "userIds": [], "monitorIds": [ { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" } ], "escalationIds": [], "_id": "5e1e1d2bb1df96583e883f22", "createdAt": "2020-01-14T19:57:31.646Z", "name": "Call Nilanshu", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } } ], "count": 2, "skip": 0, "limit": 5 }

Get All SubProjects SchedulesGET

Get All SubProjects Schedules by Project ID.

Path

  • https://fyipe.com/api/schedule/:projectId/schedules

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/schedule/5e089f94b400211639928c94/schedules

Example Response (200)

            
              

[ { "schedules": [ { "userIds": [], "monitorIds": [ { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" } ], "escalationIds": [], "_id": "5e1e1e25b1df96583e883f23", "createdAt": "2020-01-14T20:01:41.409Z", "name": "Call Team Members", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } }, { "userIds": [], "monitorIds": [ { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" } ], "escalationIds": [], "_id": "5e1e1d2bb1df96583e883f22", "createdAt": "2020-01-14T19:57:31.646Z", "name": "Call Nilanshu", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } } ], "count": 2, "_id": "5e089f94b400211639928c94", "skip": 0, "limit": 10 } ]

Edit SchedulePUT

Edit Schedule by Project ID and Schedule ID.

Path

  • https://fyipe.com/api/schedule/:projectId/:scheduleId

Path Variables

  • projectId string

    The project id of the project.

  • scheduleId string

    The schedule id of the project schedule.

Example Request

Request URL

https://fyipe.com/api/schedule/5e089f94b400211639928c94/5e1e1e25b1df96583e883f23

Request Body

            
              

{ "name": "Call Nilanshu", "monitorIds": [ "5e08a21b25c59a1c8033c7e7" ] }

Example Response (200)

            
              

[ { "userIds": [], "monitorIds": [ { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" } ], "escalationIds": [], "_id": "5e1e1e25b1df96583e883f23", "createdAt": "2020-01-14T20:01:41.409Z", "name": "Call Nilanshu", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" } } ]

Delete ScheduleDELETE

Delete Schedule by Project ID and Schedule ID.

Path

  • https://fyipe.com/api/monitor/:projectId/:scheduleId

Path Variables

  • projectId string

    The project id of the project.

  • scheduleId string

    The schedule id of the project schedule.

Example Request

Request URL

https://fyipe.com/api/schedule/5e089f94b400211639928c94/5e1e1e25b1df96583e883f23

Example Response (200)

            
              

{ "userIds": [], "monitorIds": [ "5e08a21b25c59a1c8033c7e7" ], "escalationIds": [ "5e1e2355b1df96583e883f2b" ], "deleted": true, "_id": "5e1e1e25b1df96583e883f23", "createdAt": "2020-01-14T20:01:41.409Z", "name": "Call Nilanshu", "projectId": "5e089f94b400211639928c94", "createdById": "5e089f88b400211639928c92", "__v": 0, "deletedAt": "2020-01-14T20:24:35.106Z", "deletedById": "5e089f88b400211639928c92" }

Add EscalationPOST

Add Schedule Escalation by Project ID and Schedule ID.

Path

  • https://fyipe.com/api/schedule/:projectId/:scheduleId/addEscalation

Path Variables

  • projectId string

    The project id of the project.

  • scheduleId string

    The schedule id of the project schedule.

Example Request

Request URL

https://fyipe.com/api/schedule/5e089f94b400211639928c94/5e1e1e25b1df96583e883f23/addEscalation

Request Body

            
              

[ { "callReminders": 3, "smsReminders": 3, "emailReminders": 3, "email": true, "sms": true, "call": false, "team": [ { "teamMember": [ { "member": "5e089f88b400211639928c92", "timezone": "Africa/Algiers", "startTime": "Tue Jan 14 2020 09:00:06 GMT+0100 (West Africa Standard Time)", "endTime": "Tue Jan 14 2020 17:00:06 GMT+0100 (West Africa Standard Time)" } ] } ], "rotateBy": "day" } ]

Example Response (200)

            
              

[ { "call": false, "email": true, "sms": true, "_id": "5e1e2355b1df96583e883f2b", "team": [ { "teamMember": [ { "_id": "5e1e2355b1df96583e883f2d", "member": "5e089f88b400211639928c92", "startTime": "Tue Jan 14 2020 09:00:06 GMT+0100 (West Africa Standard Time)", "endTime": "Tue Jan 14 2020 17:00:06 GMT+0100 (West Africa Standard Time)", "timezone": "Africa/Algiers" } ], "_id": "5e1e2355b1df96583e883f2c" } ], "createdAt": "2020-01-14T20:23:49.525Z", "callReminders": "10", "smsReminders": "10", "emailReminders": "10", "rotateBy": "day", "rotationInterval": null, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "scheduleId": null, "createdById": "5e089f88b400211639928c92" } ]

Get EscalationGET

Get Schedule Escalation by Project ID and Schedule ID.

Path

  • https://fyipe.com/api/schedule/:projectId/:scheduleId/getescalation

Path Variables

  • projectId string

    The project id of the project.

  • scheduleId string

    The schedule id of the project schedule.

Example Request

Request URL

https://fyipe.com/api/schedule/5e089f94b400211639928c94/5e1e1e25b1df96583e883f23/getescalation

Example Response (200)

            
              

{ "data": [ { "call": false, "email": true, "sms": true, "_id": "5e1e2355b1df96583e883f2b", "team": [ { "teamMember": [ { "_id": "5e1e2355b1df96583e883f2d", "member": "5e089f88b400211639928c92", "startTime": "Tue Jan 14 2020 09:00:06 GMT+0100 (West Africa Standard Time)", "endTime": "Tue Jan 14 2020 17:00:06 GMT+0100 (West Africa Standard Time)", "timezone": "Africa/Algiers" } ], "_id": "5e1e2355b1df96583e883f2c" } ], "createdAt": "2020-01-14T20:23:49.525Z", "callReminders": "10", "smsReminders": "10", "emailReminders": "10", "rotateBy": "day", "rotationInterval": null, "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "scheduleId": null, "createdById": "5e089f88b400211639928c92" } ], "count": 1 }

Scheduled Event

Scheduled Event API will allow you to create and manage scheduled events for your Fyipe project monitors.

Path

  • https://fyipe.com/api/scheduledEvent/

Create Scheduled EventPOST

Create Scheduled Event by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/scheduledEvent/:projectId/:monitorId

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/scheduledEvent/5e089f94b400211639928c94/5e08a21b25c59a1c8033c7e7

Request Body

            
              

{ "name": "Hello", "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "alertSubscriber": true }

Example Response (200)

            
              

{ "_id": "5e1e2a60b1df96583e883fe2", "deleted": false, "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-01-14T20:53:52.379Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "name": "Hello", "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello", "__v": 0 }

Get All Scheduled EventsGET

Get All Scheduled Events by Project ID and Monitor ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/scheduledEvent/:projectId/:monitorId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/scheduledEvent/5e089f94b400211639928c94/5e08a21b25c59a1c8033c7e7?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "_id": "5e1e2a60b1df96583e883fe2", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-01-14T20:53:52.379Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "name": "Hello", "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello" }, { "_id": "5e1e2a07b1df96583e883fe1", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-01-14T20:52:23.198Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "name": "Hello 2", "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello" } ], "count": 2, "skip": 0, "limit": 5 }

Get All Status Page Scheduled EventsGET

Get All Status Page Scheduled Events by Project ID and Monitor ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/scheduledEvent/:projectId/:monitorId/statusPage

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/scheduledEvent/5e089f94b400211639928c94/5e08a21b25c59a1c8033c7e7/statusPage?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "_id": "5e1e2a60b1df96583e883fe2", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-01-14T20:53:52.379Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "name": "Hello", "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello" }, { "_id": "5e1e2a07b1df96583e883fe1", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-01-14T20:52:23.198Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "name": "Hello 2", "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello" } ], "count": 2, "skip": 0, "limit": 5 }

Edit Scheduled EventPUT

Edit Scheduled Event by Project ID and Event ID.

Path

  • https://fyipe.com/api/scheduledEvent/:projectId/:eventId

Path Variables

  • projectId string

    The project id of the project.

  • eventId string

    The event id of the monitor scheduled event.

Example Request

Request URL

https://fyipe.com/api/scheduledEvent/5e089f94b400211639928c94/5e1e2a60b1df96583e883fe2

Request Body

            
              

{ "name": "Hello 3", "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true }

Example Response (200)

            
              

{ "deleted": false, "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "_id": "5e1e2a60b1df96583e883fe2", "createdAt": "2020-01-14T20:53:52.379Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "name": "Hello 3", "createdById": "5e089f88b400211639928c92", "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello", "__v": 0 }

Delete Scheduled EventDELETE

Delete Scheduled Event by Project ID and Event ID.

Path

  • https://fyipe.com/api/scheduledEvent/:projectId/:eventId

Path Variables

  • projectId string

    The project id of the project.

  • eventId string

    The event id of the monitor scheduled event.

Example Request

Request URL

https://fyipe.com/api/scheduledEvent/5e089f94b400211639928c94/5e1e2a60b1df96583e883fe2

Example Response (200)

            
              

{ "deleted": true, "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "_id": "5e1e2a60b1df96583e883fe2", "createdAt": "2020-01-14T20:53:52.379Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "name": "Pello", "createdById": "5e089f88b400211639928c92", "startDate": "2020-01-14T20:49:47.069Z", "endDate": "2020-01-15T20:49:47.069Z", "description": "Hello", "__v": 0, "deletedAt": "2020-01-14T20:57:57.751Z", "deletedById": "5e089f88b400211639928c92" }

SMS SMTP

SMS SMTP API will allow you to configure and send SMS and calls via your Twilio API instead of the default Twilio API of Fyipe.

Path

  • https://fyipe.com/api/smsSmtp/

Setup SMS SMTPPOST

Setup SMS SMTP by Project ID.

Path

  • https://fyipe.com/api/smsSmtp/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/smsSmtp/5e089f94b400211639928c94

Request Body

            
              

{ "smssmtpswitch": true, "accountSid": "", "authToken": "", "phoneNumber": "" }

Example Response (200)

            
              

{ "enabled": true, "deleted": false, "_id": "5e1f65e0823e774e4a3aaf52", "createdAt": "2020-01-15T19:20:00.335Z", "projectId": "5e089f94b400211639928c94", "accountSid": "", "authToken": "", "phoneNumber": "", "__v": 0 }

Get SMS SMTP SetupGET

Get SMS SMTP Setup by Project ID.

Path

  • https://fyipe.com/api/smsSmtp/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/smsSmtp/5e089f94b400211639928c94

Example Response (200)

            
              

{ "_id": "5e1f65e0823e774e4a3aaf52", "enabled": true, "deleted": false, "createdAt": "2020-01-15T19:20:00.335Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "accountSid": "", "authToken": "", "phoneNumber": "", "__v": 0 }

Edit SMS SMTP SetupPUT

Edit SMS SMTP Setup by Project ID and SMS SMTP ID.

Path

  • https://fyipe.com/api/smsSmtp/:projectId/:smsSmtpId

Path Variables

  • projectId string

    The project id of the project.

  • smsSmtpId string

    The sms SMTP id of the sms SMTP config.

Example Request

Request URL

https://fyipe.com/api/smsSmtp/5e089f94b400211639928c94/5e1f65e0823e774e4a3aaf52

Request Body

            
              

{ "smssmtpswitch": true, "accountSid": "", "authToken": "", "phoneNumber": "" }

Example Response (200)

            
              

{ "_id": "5e1f65e0823e774e4a3aaf52", "enabled": true, "deleted": false, "createdAt": "2020-01-15T19:20:00.335Z", "projectId": "5e089f94b400211639928c94", "accountSid": "", "authToken": "", "phoneNumber": "", "__v": 0 }

Delete SMS SMTP SetupDELETE

Delete SMS SMTP Setup by Project ID and SMS SMTP ID.

Path

  • https://fyipe.com/api/smsSmtp/:projectId/:smsSmtpId

Path Variables

  • projectId string

    The project id of the project.

  • smsSmtpId string

    The sms SMTP id of the sms SMTP config.

Example Request

Request URL

https://fyipe.com/api/smsSmtp/5e089f94b400211639928c94/5e1f65e0823e774e4a3aaf52

Example Response (200)

            
              

{ "_id": "5e1f65e0823e774e4a3aaf52", "enabled": true, "deleted": true, "createdAt": "2020-01-15T19:20:00.335Z", "projectId": "5e089f94b400211639928c94", "accountSid": "", "authToken": "", "phoneNumber": "", "__v": 0, "deletedAt": "2020-01-14T20:57:57.751Z", "deletedById": "5e089f88b400211639928c92" }

SMS Template

SMS Template API will allow you to customize your SMS templates.

Path

  • https://fyipe.com/api/smsTemplate/

Create SMS TemplatePOST

Create SMS Template by Project ID.

Path

  • https://fyipe.com/api/smsTemplate/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/smsTemplate/5e089f94b400211639928c94

Request Body

            
              

{ "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Created", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." }

Example Response (200)

            
              

{ "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "deleted": false, "_id": "5e1f691fecabd254a975b655", "projectId": "5e089f94b400211639928c94", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor.", "smsType": "Subscriber Incident Created", "__v": 0 }

Get All SMS TemplatesGET

Get All SMS Templates by Project ID.

Path

  • https://fyipe.com/api/smsTemplate/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/smsTemplate/5e089f94b400211639928c94

Example Response (200)

            
              

[ { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Created", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." }, { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Acknowldeged", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." }, { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Resolved", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." } ]

Get SMS TemplateGET

Get Single SMS Template by Project ID and SMS Template ID.

Path

  • https://fyipe.com/api/smsTemplate/:projectId/smsTemplate/:smsTemplateId

Path Variables

  • projectId string

    The project id of the project.

  • smsTemplateId string

    The sms template id of the project sms template.

Example Request

Request URL

https://fyipe.com/api/smsTemplate/5e089f94b400211639928c94/smsTemplate/5e1f691fecabd254a975b655

Example Response (200)

            
              

{ "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "deleted": false, "_id": "5e1f691fecabd254a975b655", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor.", "smsType": "Subscriber Incident Created", "__v": 0 }

Edit SMS TemplatePUT

Edit SMS Template by Project ID and SMS Template ID.

Path

  • https://fyipe.com/api/smsTemplate/:projectId/smsTemplate/:smsTemplateId

Path Variables

  • projectId string

    The project id of the project.

  • smsTemplateId string

    The sms template id of the project sms template.

Example Request

Request URL

https://fyipe.com/api/smsTemplate/5e089f94b400211639928c94/smsTemplate/5e1f691fecabd254a975b655

Request Body

            
              

{ "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "deleted": false, "_id": "5e1f691fecabd254a975b655", "projectId": "5e089f94b400211639928c94", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor.", "smsType": "Subscriber Incident Created", "__v": 0 }

Example Response (200)

            
              

{ "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "deleted": false, "_id": "5e1f691fecabd254a975b655", "projectId": "5e089f94b400211639928c94", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor.", "smsType": "Subscriber Incident Created", "__v": 0 }

Reset SMS TemplateGET

Reset SMS Template by Project ID and SMS Template ID.

Path

  • https://fyipe.com/api/smsTemplate/:projectId/:templateId/reset

Path Variables

  • projectId string

    The project id of the project.

  • templateId string

    The template id of the sms template.

Example Request

Request URL

https://fyipe.com/api/smsTemplate/5e089f94b400211639928c94/5e1f691fecabd254a975b655/reset

Example Response (200)

            
              

[ { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "_id": "5e1f691fecabd254a975b655", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor.", "smsType": "Subscriber Incident Created" }, { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Acknowldeged", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." }, { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Resolved", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." } ]

Add Values To SMS TemplatePUT

Add Values To SMS Template by Project ID.

Path

  • https://fyipe.com/api/smsTemplate/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/smsTemplate/5e089f94b400211639928c94

Request Body

            
              

[ { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Created", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." }, { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Acknowldeged", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." }, { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Resolved", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." } ]

Example Response (200)

            
              

[ { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Created", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." }, { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Acknowldeged", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." }, { "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "smsType": "Subscriber Incident Resolved", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor." } ]

Delete SMS TemplateDELETE

Delete SMS Template by Project ID and SMS Template ID.

Path

  • https://fyipe.com/api/smsTemplate/:projectId/smsTemplate/:smsTemplateId

Path Variables

  • projectId string

    The project id of the project.

  • smsTemplateId string

    The sms template id of the project sms template.

Example Request

Request URL

https://fyipe.com/api/smsTemplate/5e089f94b400211639928c94/smsTemplate/5e1f691fecabd254a975b655

Example Response (200)

            
              

{ "allowedVariables": [ "{{incidentTime}} : Time at which this incident occured.", "{{monitorName}} : Name of the monitor on which incident has occured.", "{{projectName}} : Name of the project on which the incident has occured.", "{{incidentType}} : Type of incident." ], "deleted": false, "_id": "5e1f691fecabd254a975b655", "projectId": "5e089f94b400211639928c94", "body": "{{projectName}}/{{monitorName}} is {{incidentType}} at {{incidentTime}}. You are receiving this message because you subscribed to this monitor.", "smsType": "Subscriber Incident Created", "__v": 0, "deletedAt": "2020-01-11T19:17:23.594Z", "deletedById": "5e089f88b400211639928c92" }

Status Page

Status Page API will allow your team members and customers to view real-time status and health of your Fyipe project monitors (like https://status.fyipe.com).

Path

  • https://fyipe.com/api/statusPage/

Create Status PagePOST

Create Status Page by Project ID.

Path

  • https://fyipe.com/api/statusPage/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354

Request Body

            
              

{ "name": "Zenith 2" }

Example Response (200)

            
              

{ "monitors": [], "links": null, "isPrivate": null, "isSubscriberEnabled": false, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "deleted": false, "_id": "5e3bfa83de29ed659247259d", "createdAt": "2020-02-06T11:37:39.786Z", "projectId": "5e2ecf45516aae26b133f354", "domain": null, "title": null, "name": "Zenith 2", "description": null, "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": null, "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } }, "__v": 0 }

Get All Status PagesGET

Get All Status Pages by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/statusPage/:projectId/dashboard

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354/dashboard?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "_id": "5e3bfa83de29ed659247259d", "monitors": [], "links": null, "isPrivate": null, "isSubscriberEnabled": false, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "createdAt": "2020-02-06T11:37:39.786Z", "projectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" }, "domain": null, "title": null, "name": "Zenith 2", "description": null, "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": null, "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } } }, { "_id": "5e3adb35fb75ab7729a63a5d", "monitors": [ { "_id": "5ee892bf60f71a7040c0d94b" "monitor": "5ede38285ca10640b23c228f" "description": "Server" "cpu": false "memory": false "responseTime": false "runtime": false "storage": true "temperature": false "uptime": true }, { "_id": "5ee8951b60f71a7040c0dade" "monitor": "5ede36fb5ca10640b23c1f2d" "description": "API" "cpu": false "memory": false "responseTime": false "runtime": false "storage": false "temperature": false "uptime": true } ], "links": null, "isPrivate": null, "isSubscriberEnabled": true, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "createdAt": "2020-02-05T15:11:49.439Z", "projectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" }, "domain": null, "title": "Zenith", "name": "Zenith", "description": "Zenith", "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": "c96f5f7fc70bea01a2c5a1b0aef8b053", "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } } } ], "count": 2, "skip": 0, "limit": 5 }

Get All Status PagesGET

Get All Status Pages by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/statusPage/:projectId/statuspage

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354/statuspage?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "_id": "5e3bfa83de29ed659247259d", "monitors": [], "links": null, "isPrivate": null, "isSubscriberEnabled": false, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "createdAt": "2020-02-06T11:37:39.786Z", "projectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" }, "domain": null, "title": null, "name": "Zenith 2", "description": null, "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": null, "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } } }, { "_id": "5e3adb35fb75ab7729a63a5d", "monitors": [ { "_id": "5ee892bf60f71a7040c0d94b" "monitor": "5ede38285ca10640b23c228f" "description": "Server" "cpu": false "memory": false "responseTime": false "runtime": false "storage": true "temperature": false "uptime": true }, { "_id": "5ee8951b60f71a7040c0dade" "monitor": "5ede36fb5ca10640b23c1f2d" "description": "API" "cpu": false "memory": false "responseTime": false "runtime": false "storage": false "temperature": false "uptime": true } ], "links": null, "isPrivate": null, "isSubscriberEnabled": true, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "createdAt": "2020-02-05T15:11:49.439Z", "projectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" }, "domain": null, "title": "Zenith", "name": "Zenith", "description": "Zenith", "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": "c96f5f7fc70bea01a2c5a1b0aef8b053", "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } } } ], "count": 2, "skip": 0, "limit": 5 }

Get All SubProjects Status PagesGET

Get All SubProjects Status Pages by Project ID.

Path

  • https://fyipe.com/api/statusPage/:projectId/statuspages

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354/statuspages

Example Response (200)

            
              

[ { "statusPages": [], "count": 0, "_id": "5e321f54542c6f61d1292a5a", "skip": 0, "limit": 10 }, { "statusPages": [ { "_id": "5e3bfa83de29ed659247259d", "monitors": [], "links": null, "isPrivate": null, "isSubscriberEnabled": false, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "createdAt": "2020-02-06T11:37:39.786Z", "projectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" }, "domain": null, "title": null, "name": "Zenith 2", "description": null, "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": null, "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } } }, { "_id": "5e3adb35fb75ab7729a63a5d", "monitors": [ { "_id": "5ee892bf60f71a7040c0d94b" "monitor": "5ede38285ca10640b23c228f" "description": "Server" "cpu": false "memory": false "responseTime": false "runtime": false "storage": true "temperature": false "uptime": true }, { "_id": "5ee8951b60f71a7040c0dade" "monitor": "5ede36fb5ca10640b23c1f2d" "description": "API" "cpu": false "memory": false "responseTime": false "runtime": false "storage": false "temperature": false "uptime": true } ], "links": null, "isPrivate": null, "isSubscriberEnabled": true, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "createdAt": "2020-02-05T15:11:49.439Z", "projectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" }, "domain": null, "title": "Zenith", "name": "Zenith", "description": "Zenith", "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": "c96f5f7fc70bea01a2c5a1b0aef8b053", "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } } } ], "count": 2, "_id": "5e2ecf45516aae26b133f354", "skip": 0, "limit": 10 } ]

Get Status PageGET

Get Single Status Pages by Status Page ID and URL.

Path

  • https://fyipe.com/api/statusPage/:statusPageId

Query Params

  • url string

    The url of the status page.

Path Variables

  • statusPageId string

    The status page id of the project status page.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e3bfa83de29ed659247259d

Example Response (200)

            
              

{ "_id": "5e3bfa83de29ed659247259d", "monitors": [], "links": null, "isPrivate": null, "isSubscriberEnabled": false, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "deleted": false, "createdAt": "2020-02-06T11:37:39.786Z", "projectId": { "_id": "5e2ecf45516aae26b133f354", "name": "Bello" }, "domain": null, "title": null, "name": "Zenith 2", "description": null, "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": null, "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } }, "__v": 0, "monitorsData": [] }

Edit Status PagePUT

Edit Status Page by Project ID.

Path

  • https://fyipe.com/api/statusPage/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354

Request Body

            
              

{ "_id": "5e3bfa83de29ed659247259d", "monitors": [ "monitor": "5ede38285ca10640b23c228f", "description": "Web Server", "cpu": false, "memory": false, "responseTime": false, "runtime": false, "storage": false, "temperature": false, "uptime": true ] }

Example Response (200)

            
              

{ "monitors": [ "_id": "5ee8a4a060f71a7040c0e0e5", "monitor": "5ede38285ca10640b23c228f", "description": "Web Server", "cpu": false, "memory": false, "responseTime": false, "runtime": false, "storage": false, "temperature": false, "uptime": true ], "links": null, "isPrivate": null, "isSubscriberEnabled": false, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "deleted": false, "_id": "5e3bfa83de29ed659247259d", "createdAt": "2020-02-06T11:37:39.786Z", "projectId": "5e2ecf45516aae26b133f354", "domain": null, "title": null, "name": "Zenith 2", "description": null, "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": null, "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } }, "__v": 0 }

Delete Status PageDELETE

Delete Status Page by Project ID and Status Page ID.

Path

  • https://fyipe.com/api/statusPage/:projectId/:statusPageId

Path Variables

  • projectId string

    The project id of the project.

  • statusPageId string

    The status page id of the project status page.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354/5e3bfa83de29ed659247259d

Example Response (200)

            
              

{ "monitors": [ { "_id": "5ee892bf60f71a7040c0d94b", "monitor": "5ede38285ca10640b23c228f", "description": "", "uptime": true, "memory": false, "cpu": false, "storage": true, "responseTime": false, "temperature": false, "runtime": false }, { "_id": "5ee8951b60f71a7040c0dade", "monitor": "5ede36fb5ca10640b23c1f2d", "description": "API", "uptime": true, "memory": false, "cpu": false, "storage": false, "responseTime": false, "temperature": false, "runtime": false } ], "links": null, "isPrivate": null, "isSubscriberEnabled": false, "isGroupedByMonitorCategory": false, "showScheduledEvents": true, "enableRSSFeed": true, "emailNotification": true, "smsNotification": true, "webhookNotification": true, "deleted": true, "_id": "5e3bfa83de29ed659247259d", "createdAt": "2020-02-06T11:37:39.786Z", "projectId": "5e2ecf45516aae26b133f354", "domain": null, "title": null, "name": "Zenith 2", "description": null, "copyright": null, "faviconPath": null, "logoPath": null, "bannerPath": null, "colors": { "pageBackground": { "r": 238, "g": 242, "b": 246, "a": 1 }, "statusPageBackground": { "r": 246, "g": 249, "b": 252, "a": 1 }, "heading": { "r": 50, "g": 50, "b": 93, "a": 0.8 }, "subheading": { "r": 50, "g": 50, "b": 93, "a": 0.8 } }, "__v": 0, "deletedAt": "2020-02-06T12:38:34.968Z", "deletedById": "5e2ecf3f516aae26b133f352" }

Get Status Page RSSGET

Get Status Page RSS by Status Page ID and URL.

Path

  • https://fyipe.com/api/statusPage/:statusPageId/rss

Query Params

  • url string

    The url of the status page.

Path Variables

  • statusPageId string

    The status page id of the project status page.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e3bfa83de29ed659247259d/rss

Example Response (200)

            
              

Incidents for status page Zenith RSS feed for all incidents related to monitors attached to status page http://localhost:3002/statusPage/rss Thu Feb 06 2020 12:44:44 GMT+0100 (West Africa Standard Time) en offline 5e3485a6f798176b8eceaa29 Google Home 5e321f87542c6f61d1292a83 false offline 5e3443912d08987eda83a4df Google Home 5e321f87542c6f61d1292a83 false degraded 5e3317c7cafe407ab9351f40 Google Home 5e321f87542c6f61d1292a83 false degraded 5e3316d9cafe407ab9351ed2 Google Home 5e321f87542c6f61d1292a83 false degraded 5e33169ecafe407ab9351ec3 Google Home 5e321f87542c6f61d1292a83 true offline 5e33168bcafe407ab9351ec0 Tello 5e3154a8e991437d71ed1f16 true degraded 5e33165dcafe407ab9351eb5 Google Home 5e321f87542c6f61d1292a83 false offline 5e323bb2ab4ef87817ebf957 Tello 5e3154a8e991437d71ed1f16 true offline 5e323b5fab4ef87817ebf94c Google Home 5e321f87542c6f61d1292a83 true offline 5e323b30ab4ef87817ebf93f Google Home 5e321f87542c6f61d1292a83 true degraded 5e323ad1ab4ef87817ebf932 Google Home 5e321f87542c6f61d1292a83 true

Get Status Page NotesGET

Get Status Page Notes by Project ID and Status Page ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/statusPage/:projectId/:statusPageId/notes

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • statusPageId string

    The status page id of the project status page.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354/5e3bfa83de29ed659247259d/notes?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": false, "_id": "5e3485a6f798176b8eceaa29", "probes": [ { "status": true, "_id": "5e3485a6f798176b8eceaa2a", "probeId": { "_id": "5e2ede37dbe0ab20a749ed9b", "probeName": "US East" }, "updatedAt": "2020-01-31T19:53:10.599Z", "reportedStatus": "offline" } ], "createdAt": "2020-01-31T19:53:10.599Z", "projectId": "5e321f54542c6f61d1292a5a", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "createdById": null, "incidentType": "offline", "acknowledgedAt": "2020-01-31T19:54:56.571Z", "acknowledgedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-31T19:54:56.571Z", "resolvedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": false, "_id": "5e348476f798176b8ecea8c7", "probes": [ { "status": true, "_id": "5e348476f798176b8ecea8c8", "probeId": { "_id": "5e2ede37dbe0ab20a749ed9b", "probeName": "US East" }, "updatedAt": "2020-01-31T19:48:06.495Z", "reportedStatus": "degraded" } ], "createdAt": "2020-01-31T19:48:06.493Z", "projectId": "5e321f54542c6f61d1292a5a", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "createdById": null, "incidentType": "degraded", "acknowledgedAt": "2020-01-31T19:48:14.839Z", "acknowledgedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-31T19:48:14.839Z", "resolvedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": false, "_id": "5e3481e2f798176b8ecea4ec", "probes": [ { "status": true, "_id": "5e3481e2f798176b8ecea4ed", "probeId": { "_id": "5e2ede37dbe0ab20a749ed9b", "probeName": "US East" }, "updatedAt": "2020-01-31T19:37:06.548Z", "reportedStatus": "degraded" } ], "createdAt": "2020-01-31T19:37:06.548Z", "projectId": "5e321f54542c6f61d1292a5a", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "createdById": null, "incidentType": "degraded", "acknowledgedAt": "2020-01-31T19:39:53.962Z", "acknowledgedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-31T19:39:53.962Z", "resolvedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": false, "_id": "5e347fc6f798176b8ecea2a1", "probes": [ { "status": true, "_id": "5e347fc6f798176b8ecea2a2", "probeId": { "_id": "5e2ede37dbe0ab20a749ed9b", "probeName": "US East" }, "updatedAt": "2020-01-31T19:28:06.789Z", "reportedStatus": "degraded" } ], "createdAt": "2020-01-31T19:28:06.788Z", "projectId": "5e321f54542c6f61d1292a5a", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "createdById": null, "incidentType": "degraded", "acknowledgedAt": "2020-01-31T19:35:40.653Z", "acknowledgedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-31T19:35:40.653Z", "resolvedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" } }, { "acknowledged": true, "acknowledgedByZapier": null, "resolved": true, "resolvedByZapier": null, "internalNote": "", "investigationNote": "", "createdByZapier": false, "notClosedBy": [], "manuallyCreated": false, "_id": "5e347f17f798176b8ecea1be", "probes": [ { "status": true, "_id": "5e347f17f798176b8ecea1bf", "probeId": { "_id": "5e2ede37dbe0ab20a749ed9b", "probeName": "US East" }, "updatedAt": "2020-01-31T19:25:11.713Z", "reportedStatus": "degraded" } ], "createdAt": "2020-01-31T19:25:11.712Z", "projectId": "5e321f54542c6f61d1292a5a", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "createdById": null, "incidentType": "degraded", "acknowledgedAt": "2020-01-31T19:27:49.224Z", "acknowledgedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" }, "resolvedAt": "2020-01-31T19:27:49.224Z", "resolvedBy": { "_id": "5e2ecf3f516aae26b133f352", "name": "Nawaz Dhandala" } } ], "count": 29, "skip": 0, "limit": 5 }

Get Status Page Monitor NotesGET

Get Status Page Monitor Notes by Project ID and Monitor ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/statusPage/:projectId/:monitorId/individualnotes

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354/5e321f87542c6f61d1292a83/individualnotes?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "investigationNote": "", "createdAt": "2020-01-31T19:53:10.599Z", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "resolved": true, "_id": "5e3485a6f798176b8eceaa29" }, { "investigationNote": "", "createdAt": "2020-01-31T19:48:06.493Z", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "resolved": true, "_id": "5e348476f798176b8ecea8c7" }, { "investigationNote": "", "createdAt": "2020-01-31T19:37:06.548Z", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "resolved": true, "_id": "5e3481e2f798176b8ecea4ec" }, { "investigationNote": "", "createdAt": "2020-01-31T19:28:06.788Z", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "resolved": true, "_id": "5e347fc6f798176b8ecea2a1" }, { "investigationNote": "", "createdAt": "2020-01-31T19:25:11.712Z", "monitorId": { "_id": "5e321f87542c6f61d1292a83", "name": "Google Home" }, "resolved": true, "_id": "5e347f17f798176b8ecea1be" } ], "count": 16, "skip": 0, "limit": 5 }

Get Status Page Scheduled EventsGET

Get Status Page Scheduled Events by Project ID and Status Page ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/statusPage/:projectId/:statusPageId/events

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • statusPageId string

    The status page id of the project status page.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e8cda4eac92233bf1e4645a/5e8cdb19ac92233bf1e464d6/events?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "_id": "5e8f7cff373fe04be53f6435", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:52:31.296Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8e37756699ef07cef3cc94", "name": "Google Home" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:52:16.000Z", "endDate": "2020-04-09T19:52:16.000Z", "description": "Event Description" }, { "_id": "5e8f7cde373fe04be53f6417", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:51:58.844Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8cdaebac92233bf1e4649a", "name": "Mello" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:51:42.000Z", "endDate": "2020-04-09T19:51:42.000Z", "description": "Event Description" }, { "_id": "5e8f7cbc373fe04be53f6412", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:51:24.172Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8cdaebac92233bf1e4649a", "name": "Mello" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:51:07.000Z", "endDate": "2020-04-09T19:51:07.000Z", "description": "Event Description" }, { "_id": "5e8f7c98373fe04be53f63f4", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:50:48.156Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8e37756699ef07cef3cc94", "name": "Google Home" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:50:32.000Z", "endDate": "2020-04-09T19:50:32.000Z", "description": "Event Description" }, { "_id": "5e8f7b75373fe04be53f63e5", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:45:57.012Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8e37756699ef07cef3cc94", "name": "Google Home" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:45:37.000Z", "endDate": "2020-04-09T19:45:37.000Z", "description": "Event Description" } ], "count": 25, "skip": 0, "limit": 5 }

Get Status Page Monitor Scheduled EventsGET

Get Status Page Monitor Scheduled Events by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/statusPage/:projectId/:monitorId/individualevents

Query Params

  • date Date

    The current date.

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e8cda4eac92233bf1e4645a/5e8cdaebac92233bf1e4649a/individualevents?date=2020-04-09T21:22:08.845Z

Example Response (200)

            
              

{ "data": [ { "_id": "5e8f7cde373fe04be53f6417", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:51:58.844Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8cdaebac92233bf1e4649a", "name": "Mello" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:51:42.000Z", "endDate": "2020-04-09T19:51:42.000Z", "description": "Event Description" }, { "_id": "5e8f7cbc373fe04be53f6412", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:51:24.172Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8cdaebac92233bf1e4649a", "name": "Mello" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:51:07.000Z", "endDate": "2020-04-09T19:51:07.000Z", "description": "Event Description" }, { "_id": "5e8f7b4c373fe04be53f63c7", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:45:16.903Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8cdaebac92233bf1e4649a", "name": "Mello" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:44:41.000Z", "endDate": "2020-04-09T19:44:41.000Z", "description": "Event Description" }, { "_id": "5e8f7aff373fe04be53f63c1", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:43:59.715Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8cdaebac92233bf1e4649a", "name": "Mello" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:43:36.000Z", "endDate": "2020-04-09T19:43:36.000Z", "description": "Event Description" }, { "_id": "5e8f7aad373fe04be53f63b9", "showEventOnStatusPage": true, "callScheduleOnEvent": true, "monitorDuringEvent": false, "alertSubscriber": true, "createdAt": "2020-04-09T19:42:37.893Z", "projectId": "5e8cda4eac92233bf1e4645a", "monitorId": { "_id": "5e8cdaebac92233bf1e4649a", "name": "Mello" }, "name": "System Upgrade", "createdById": { "_id": "5e8cda48ac92233bf1e46458", "name": "Nawaz Dhandala" }, "startDate": "2020-04-09T19:42:16.000Z", "endDate": "2020-04-09T19:42:16.000Z", "description": "Event Description" } ], "count": 10 }

Get All Monitor StatusesGET

Get All Monitor Statuses by Project ID and Monitor ID. Return results by Start Date and End Date.

Path

  • https://fyipe.com/api/statusPage/:projectId/:monitorId/monitorStatuses

Query Params

  • startDate Date

    The start date of the date range.

  • endDate Date

    The end date of the date range.

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354d/5e321f87542c6f61d1292a83/monitorStatuses

Example Response (200)

            
              

{ "data": [ { "_id": "5e2ede37dbe0ab20a749ed9b", "statuses": [ { "manuallyCreated": false, "endTime": null, "_id": "5e3b1f94927afc6d082372ea", "startTime": "2020-02-05T20:03:32.688Z", "createdAt": "2020-02-05T20:03:32.688Z", "monitorId": "5e321f87542c6f61d1292a83", "probeId": "5e2ede37dbe0ab20a749ed9b" }, { "manuallyCreated": false, "endTime": null, "_id": "5e322885542c6f61d1292c7c", "startTime": "2020-01-30T00:51:17.983Z", "createdAt": "2020-01-30T00:51:17.983Z", "monitorId": "5e321f87542c6f61d1292a83", "probeId": "5e2ede37dbe0ab20a749ed9b", "responseTime": null, "status": "online" } ] } ], "count": 1 }

Get All ProbesGET

Get All Probes by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/statusPage/:projectId/probes

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/statusPage/5e2ecf45516aae26b133f354/probes?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "_id": "5e2ede37dbe0ab20a749ed9b", "createdAt": "2020-01-27T11:53:35.429Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce4", "probeName": "US East", "lastAlive": "2020-02-05T20:09:34.596Z" }, { "_id": "5e2ede71dbe0ab20a749edd4", "createdAt": "2020-01-27T11:53:35.429Z", "probeKey": "33b674ca-9fdd-11e9-a2a3-2a2ae2dbcce5", "probeName": "US West", "lastAlive": "2020-01-27T11:53:35.429Z" } ], "count": 2, "skip": 0, "limit": 5 }

Subscriber

Subscriber API will allow you to subscribe your customers to monitor incidents and send alerts.

Path

  • https://fyipe.com/api/subscriber/

Create Status Page SubscriberPOST

Create Status Page Subscriber by Project ID and Status Page ID.

Path

  • https://fyipe.com/api/subscriber/:projectId/:statusPageId

Path Variables

  • projectId string

    The project id of the project.

  • statusPageId string

    The status page id of the project status page.

Example Request

Request URL

https://fyipe.com/api/subscriber/5e089f94b400211639928c94/5e1b877a41127144f8144b9d

Request Body

            
              

{ "userDetails": { "method": "email", "email": "[email protected]", "contactEmail": "[email protected]" }, "monitors": [ "5e08a21b25c59a1c8033c7e7" ] }

Example Response (200)

            
              

[ { "_id": "5e1b990041127144f8144ce9", "createdAt": "2020-01-12T22:09:04.011Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "statusPageId": "5e1b877a41127144f8144b9d", "alertVia": "email", "contactEmail": "[email protected]", "contactPhone": null, "countryCode": null, "contactWebhook": null } ]

Create Monitor SubscriberPOST

Create Monitor Subscriber by Project ID and Monitor ID.

Path

  • https://fyipe.com/api/subscriber/:projectId/subscribe/:monitorId

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/subscriber/5e089f94b400211639928c94/subscribe/5e08a21b25c59a1c8033c7e7

Request Body

            
              

{ "alertVia": "email", "email": "[email protected]", "contactEmail": "[email protected]" }

Example Response (200)

            
              

{ "deleted": false, "_id": "5e1b973341127144f8144ce8", "createdAt": "2020-01-12T22:01:23.791Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "statusPageId": null, "alertVia": "email", "contactEmail": "[email protected]", "contactPhone": null, "countryCode": null, "contactWebhook": null, "__v": 0 }

Get All SubscribersGET

Get All Subscribers by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/subscriber/:projectId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/subscriber/5e089f94b400211639928c94?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "_id": "5e0f2e717f3127159be72c9f", "createdAt": "2020-01-03T12:07:13.864Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "statusPageId": null, "alertVia": "email", "contactEmail": "[email protected]", "contactPhone": null, "countryCode": null, "contactWebhook": null } ], "count": 1, "skip": 0, "limit": 5 }

Get All Monitor SubscribersGET

Get All Monitor Subscribers by Project ID and Monitor ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/subscriber/:projectId/monitor/:monitorId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • monitorId string

    The monitor id of the project monitor.

Example Request

Request URL

https://fyipe.com/api/subscriber/5e089f94b400211639928c94/monitor/5e08a21b25c59a1c8033c7e7?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "_id": "5e0f2e717f3127159be72c9f", "createdAt": "2020-01-03T12:07:13.864Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "statusPageId": null, "alertVia": "email", "contactEmail": "[email protected]", "contactPhone": null, "countryCode": null, "contactWebhook": null } ], "count": 1, "skip": 0, "limit": 5 }

Get SubscriberGET

Get Single Subscriber by Project ID and Subscriber ID.

Path

  • https://fyipe.com/api/subscriber/:projectId/:subscriberId

Path Variables

  • projectId string

    The project id of the project.

  • subscriberId string

    The subscriber id of the monitor subscriber.

Example Request

Request URL

https://fyipe.com/api/subscriber/5e089f94b400211639928c94/5e0f2e717f3127159be72c9f

Example Response (200)

            
              

{ "deleted": false, "_id": "5e0f2e717f3127159be72c9f", "createdAt": "2020-01-03T12:07:13.864Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "statusPageId": null, "alertVia": "email", "contactEmail": "[email protected]", "contactPhone": null, "countryCode": null, "contactWebhook": null, "__v": 0 }

Delete SubscriberDELETE

Delete Subscriber by Project ID and Subscriber ID.

Path

  • https://fyipe.com/api/subscriber/:projectId/:subscriberId

Path Variables

  • projectId string

    The project id of the project.

  • subscriberId string

    The subscriber id of the monitor subscriber.

Example Request

Request URL

https://fyipe.com/api/subscriber/5e089f94b400211639928c94/5e0f2e717f3127159be72c9f

Example Response (200)

            
              

{ "deleted": true, "_id": "5e1b973341127144f8144ce8", "createdAt": "2020-01-12T22:01:23.791Z", "projectId": "5e089f94b400211639928c94", "monitorId": "5e08a21b25c59a1c8033c7e7", "statusPageId": null, "alertVia": "email", "contactEmail": "[email protected]", "contactPhone": null, "countryCode": null, "contactWebhook": null, "__v": 0, "deletedAt": "2020-01-12T22:02:33.736Z", "deletedById": "5e089f88b400211639928c92" }

Subscriber Alert

Subscriber Alert API will allow you to send alerts and access all the alerts that were sent to your customers who have subscribed to monitor incidents. If you want to access alerts that were sent to your Fyipe team members, please check Alert API.

Path

  • https://fyipe.com/api/subscriberAlert/

Create Subscriber AlertPOST

Create Subscriber Alert by Project ID and Subscriber ID.

Path

  • https://fyipe.com/api/subscriberAlert/:projectId/:subscriberId

Path Variables

  • projectId string

    The project id of the project.

  • subscriberId string

    The subscriber id of the monitor subscriber.

Example Request

Request URL

https://fyipe.com/api/subscriberAlert/5e089f94b400211639928c94/5e0f2e717f3127159be72c9f

Request Body

            
              

{ "alertStatus": "offline", "alertVia": "sms", "incidentId": "5e1725db1f31a13e98acd8d9" }

Example Response (200)

            
              

{ "error": false, "deleted": false, "_id": "5e1b551f41127144f81447ab", "createdAt": "2020-01-12T17:19:27.346Z", "projectId": "5e089f94b400211639928c94", "subscriberId": "5e0f2e717f3127159be72c9f", "incidentId": "5e1725db1f31a13e98acd8d9", "alertVia": "sms", "alertStatus": "offline", "__v": 0 }

Get All Subscriber AlertsGET

Get All Subscriber Alerts by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/subscriberAlert/:projectId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/subscriberAlert/5e089f94b400211639928c94?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "error": false, "_id": "5e1776ec1f31a13e98acdd1e", "createdAt": "2020-01-09T18:54:36.231Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subscriberId": { "_id": "5e0f2e717f3127159be72c9f", "contactEmail": "[email protected]", "contactPhone": null, "contactWebhook": null }, "incidentId": { "_id": "5e1776861f31a13e98acdd1a" }, "alertVia": "email", "alertStatus": "Sent" }, { "error": false, "_id": "5e1776af1f31a13e98acdd1d", "createdAt": "2020-01-09T18:53:35.262Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subscriberId": { "_id": "5e0f2e717f3127159be72c9f", "contactEmail": "[email protected]", "contactPhone": null, "contactWebhook": null }, "incidentId": { "_id": "5e1776861f31a13e98acdd1a" }, "alertVia": "email", "alertStatus": "Sent" }, { "error": false, "_id": "5e1395f5a55da96da8d148bf", "createdAt": "2020-01-06T20:17:57.981Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subscriberId": { "_id": "5e0f2e717f3127159be72c9f", "contactEmail": "[email protected]", "contactPhone": null, "contactWebhook": null }, "incidentId": { "_id": "5e13933da55da96da8d1482a" }, "alertVia": "email", "alertStatus": "Sent" }, { "error": false, "_id": "5e139343a55da96da8d14893", "createdAt": "2020-01-06T20:06:27.277Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subscriberId": { "_id": "5e0f2e717f3127159be72c9f", "contactEmail": "[email protected]", "contactPhone": null, "contactWebhook": null }, "incidentId": { "_id": "5e13933da55da96da8d1482a" }, "alertVia": "email", "alertStatus": "Sent" }, { "error": false, "_id": "5e138f8578c1306cb706bda3", "createdAt": "2020-01-06T19:50:29.225Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subscriberId": { "_id": "5e0f2e717f3127159be72c9f", "contactEmail": "[email protected]", "contactPhone": null, "contactWebhook": null }, "incidentId": { "_id": "5e138f7f78c1306cb706bd68" }, "alertVia": "email", "alertStatus": "Sent" } ], "count": 16, "skip": 0, "limit": 5 }

Get All Subscriber Alerts By IncidentGET

Get All Subscriber Alerts by Project ID and Incident ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/subscriberAlert/:projectId/incident/:incidentId

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

  • incidentId string

    The incident id of the monitor incident.

Example Request

Request URL

https://fyipe.com/api/subscriberAlert/5e089f94b400211639928c94/incident/5e1776861f31a13e98acdd1a?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "error": false, "_id": "5e1776ec1f31a13e98acdd1e", "createdAt": "2020-01-09T18:54:36.231Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subscriberId": { "_id": "5e0f2e717f3127159be72c9f", "contactEmail": "[email protected]", "contactPhone": null, "contactWebhook": null }, "incidentId": { "_id": "5e1776861f31a13e98acdd1a" }, "alertVia": "email", "alertStatus": "Sent" }, { "error": false, "_id": "5e1776af1f31a13e98acdd1d", "createdAt": "2020-01-09T18:53:35.262Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "subscriberId": { "_id": "5e0f2e717f3127159be72c9f", "contactEmail": "[email protected]", "contactPhone": null, "contactWebhook": null }, "incidentId": { "_id": "5e1776861f31a13e98acdd1a" }, "alertVia": "email", "alertStatus": "Sent" } ], "count": 2, "skip": 0, "limit": 5 }

Team

Team API will allow you to invite and manage team members in your Fyipe project team.

Path

  • https://fyipe.com/api/team/

Create Team MemberPOST

Create Team Member by Project ID.

Path

  • https://fyipe.com/api/team/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/team/5e089f94b400211639928c94

Request Body

            
              

{ "emails": "[email protected]", "role": "Member", "projectId": "5e089f94b400211639928c94" }

Example Response (200)

            
              

[ { "projectId": "5e089f94b400211639928c94", "team": [ { "userId": "5e1b7f7241127144f8144ac0", "email": "[email protected]", "name": null, "role": "Member", "lastActive": "2020-01-12T20:20:02.089Z" }, { "userId": "5e1b7f0f41127144f8144abb", "email": "[email protected]", "name": null, "role": "Member", "lastActive": "2020-01-12T20:18:23.100Z" }, { "userId": "5e162d9f1b8ae8185921498f", "email": "[email protected]", "name": null, "role": "Administrator", "lastActive": "2020-01-08T19:29:35.404Z" }, { "userId": "5e089f88b400211639928c92", "email": "[email protected]", "name": "Nawaz Dhandala", "role": "Administrator", "lastActive": "2020-01-12T20:20:02.051Z" } ] } ]

Get All Team MembersGET

Get All Team Members by Project ID.

Path

  • https://fyipe.com/api/team/:projectId

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/team/5e089f94b400211639928c94

Example Response (200)

            
              

[ { "userId": "5e162d9f1b8ae8185921498f", "email": "[email protected]", "name": null, "role": "Member", "lastActive": "2020-01-08T19:29:35.404Z" }, { "userId": "5e089f88b400211639928c92", "email": "[email protected]", "name": "Nawaz Dhandala", "role": "Owner", "lastActive": "2020-01-12T19:45:29.603Z" } ]

Get All SubProjects Team MembersGET

Get All SubProjects Team Members by Project ID.

Path

  • https://fyipe.com/api/team/:projectId/teamMembers

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/team/5e089f94b400211639928c94/teamMembers

Example Response (200)

            
              

[ { "teamMembers": [ { "userId": "5e162d9f1b8ae8185921498f", "email": "[email protected]", "name": null, "role": "Member", "lastActive": "2020-01-08T19:29:35.404Z" }, { "userId": "5e089f88b400211639928c92", "email": "[email protected]", "name": "Nawaz Dhandala", "role": "Owner", "lastActive": "2020-01-12T19:46:44.316Z" } ], "count": 2, "_id": "5e089f94b400211639928c94" } ]

Get Team MemberGET

Get Single Team Member by Project ID and Team Member ID.

Path

  • https://fyipe.com/api/team/:projectId/:teamMemberId

Path Variables

  • projectId string

    The project id of the project.

  • teamMemberId string

    The team member id of the project team member.

Example Request

Request URL

https://fyipe.com/api/team/5e089f94b400211639928c94/5e089f88b400211639928c92

Example Response (200)

            
              

{ "id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala", "email": "[email protected]", "companyName": "Hackerbay", "companyRole": null, "companySize": null, "referral": null, "isVerified": true, "companyPhoneNumber": "2348058486168", "alertPhoneNumber": "+234 815 848 6068", "profilePic": "c0df90baf454d1e4f1b547791a661b48", "timezone": "Africa/El_Aaiun", "tempEmail": null, "tempAlertPhoneNumber": null }

Delete Team MemberDELETE

Delete Team Member by Project ID and Team Member ID.

Path

  • https://fyipe.com/api/team/:projectId/:teamMemberId

Path Variables

  • projectId string

    The project id of the project.

  • teamMemberId string

    The team member id of the project team member.

Example Request

Request URL

https://fyipe.com/api/team/5e089f94b400211639928c94/5e089f88b400211639928c92

Example Response (200)

            
              

[ { "projectId": "5e089f94b400211639928c94", "team": [ { "userId": "5e1b7f0f41127144f8144abb", "email": "[email protected]", "name": null, "role": "Member", "lastActive": "2020-01-12T20:18:23.100Z" }, { "userId": "5e162d9f1b8ae8185921498f", "email": "[email protected]", "name": null, "role": "Administrator", "lastActive": "2020-01-08T19:29:35.404Z" }, { "userId": "5e089f88b400211639928c92", "email": "[email protected]", "name": "Nawaz Dhandala", "role": "Administrator", "lastActive": "2020-01-12T20:22:45.095Z" } ] } ]

Change Team Member RolePUT

Change Team Member Role by Project ID and Team Member ID.

Path

  • https://fyipe.com/api/team/:projectId/:teamMemberId/changerole

Path Variables

  • projectId string

    The project id of the project.

  • teamMemberId string

    The team member id of the project team member.

Example Request

Request URL

https://fyipe.com/api/team/5e089f94b400211639928c94/5e089f88b400211639928c92/changerole

Request Body

            
              

{ "teamMemberId": "5e162d9f1b8ae8185921498f", "role": "Member" }

Example Response (200)

            
              

[ { "projectId": "5e089f94b400211639928c94", "team": [ { "userId": "5e162d9f1b8ae8185921498f", "email": "[email protected]", "name": null, "role": "Member", "lastActive": "2020-01-08T19:29:35.404Z" }, { "userId": "5e089f88b400211639928c92", "email": "[email protected]", "name": "Nawaz Dhandala", "role": "Member", "lastActive": "2020-01-12T19:51:34.323Z" } ] } ]

Tutorial

Tutorial API will allow you to interact with the Fyipe resources tutorial interface.

Path

  • https://fyipe.com/api/tutorial/

Get All TutorialsGET

Get All Tutorials.

Path

  • https://fyipe.com/api/tutorial/

Example Request

Request URL

https://fyipe.com/api/tutorial/

Example Response (200)

            
              

{ "_id": "5e089f88b400211639928c92", "data": { "monitor": { "show": false } } }

Close TutorialPUT

Close Tutorial.

Path

  • https://fyipe.com/api/tutorial/

Example Request

Request URL

https://fyipe.com/api/tutorial/

Request Body

            
              

{ "type": "monitor" }

Example Response (200)

            
              

{ "_id": "5e089f88b400211639928c92", "data": { "monitor": { "show": false } } }

Version

Version API will allow you to get both the Fyipe server and dashboard application versions.

Path

  • https://fyipe.com/api/version/

Get API VersionGET

Get API Version.

Path

  • https://fyipe.com/api/version/

Example Request

Request URL

https://fyipe.com/api/version/

Example Response (200)

            
              

{ "server": "3.0.1169", "client": "" }

WebHook

WebHook API will allow you to integrate Fyipe with your WebHook URLs.

Path

  • https://fyipe.com/api/webhook/

Create WebHookPOST

Create WebHook by Project ID.

Path

  • https://fyipe.com/api/webhook/:projectId/create

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/webhook/5e089f94b400211639928c94/create

Request Body

            
              

{ "endpoint": "https://fyipe.com", "endpointType": "get", "monitorId": "5e08a21b25c59a1c8033c7e7", "type": "webhook", "incidentCreated": true, "incidentResolved": false, "incidentAcknowledged": false }

Example Response (200)

            
              

{ "notificationOptions": { "incidentCreated": true, "incidentAcknowledged": false, "incidentResolved": false }, "deleted": false, "_id": "5e1cf554e6a0421634359491", "monitorId": { "_id": "5e08a21b25c59a1c8033c7e7", "name": "Google Home" }, "createdAt": "2020-01-13T22:55:16.682Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "data": { "userId": "5e089f88b400211639928c92", "endpoint": "https://fyipe.com", "endpointType": "get", "monitorId": "5e08a21b25c59a1c8033c7e7" }, "integrationType": "webhook", "__v": 0 }

Get All WebHooksGET

Get All WebHooks by Project ID. Return by skipping and limiting the number of results.

Path

  • https://fyipe.com/api/webhook/:projectId/hooks

Query Params

  • skip integer

    The number of results to skip in the response body.

  • limit integer

    The number of results to return in the response body.

Path Variables

  • projectId string

    The project id of the project.

Example Request

Request URL

https://fyipe.com/api/webhook/5e089f94b400211639928c94/hooks?skip=0&limit=5

Example Response (200)

            
              

{ "data": [ { "notificationOptions": { "incidentCreated": true, "incidentAcknowledged": false, "incidentResolved": false }, "_id": "5e0fd2f97f3127159be74863", "monitorId": { "_id": "5e0a4b1678caf04fd1fedcbe", "name": "Ubuntu Machine" "name": "Ubuntu Machine" }, "createdAt": "2020-01-03T23:49:13.864Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "data": { "userId": "5e089f88b400211639928c92", "endpoint": "https://fyipe.com", "endpointType": "get", "monitorId": "5e0a4b1678caf04fd1fedcbe" }, "integrationType": "webhook" } ], "count": 1, "skip": 0, "limit": 5 }

Edit WebHookPUT

Edit WebHook by Project ID and Integration ID.

Path

  • https://fyipe.com/api/webhook/:projectId/:integrationId

Path Variables

  • projectId string

    The project id of the project.

  • integrationId string

    The integration id of the webhook integration.

Example Request

Request URL

https://fyipe.com/api/webhook/5e089f94b400211639928c94/5e0fd2f97f3127159be74863

Request Body

            
              

{ "endpoint": "https://fyipe.com", "monitorId": "5e0a4b1678caf04fd1fedcbe", "endpointType": "get", "type": "webhook", "incidentCreated": true, "incidentResolved": false, "incidentAcknowledged": false }

Example Response (200)

            
              

{ "notificationOptions": { "incidentCreated": true, "incidentAcknowledged": false, "incidentResolved": false }, "deleted": false, "_id": "5e0fd2f97f3127159be74863", "monitorId": { "_id": "5e0a4b1678caf04fd1fedcbe", "name": "Ubuntu Machine" }, "createdAt": "2020-01-03T23:49:13.864Z", "projectId": { "_id": "5e089f94b400211639928c94", "name": "Bello" }, "createdById": { "_id": "5e089f88b400211639928c92", "name": "Nawaz Dhandala" }, "data": { "userId": "5e089f88b400211639928c92", "endpoint": "https://fyipe.com", "endpointType": "get", "monitorId": "5e0a4b1678caf04fd1fedcbe" }, "integrationType": "webhook", "__v": 0 }

Delete WebHookDELETE

Delete WebHook by Project ID and Integration ID.

Path

  • https://fyipe.com/api/webhook/:projectId/delete/:integrationId

Path Variables

  • projectId string

    The project id of the project.

  • integrationId string

    The integration id of the webhook integration.

Example Request

Request URL

https://fyipe.com/api/webhook/5e089f94b400211639928c94/delete/5e1cf554e6a0421634359491

Example Response (200)

            
              

{ "notificationOptions": { "incidentCreated": true, "incidentAcknowledged": false, "incidentResolved": false }, "deleted": true, "_id": "5e1cf554e6a0421634359491", "monitorId": "5e08a21b25c59a1c8033c7e7", "createdAt": "2020-01-13T22:55:16.682Z", "projectId": "5e089f94b400211639928c94", "createdById": "5e089f88b400211639928c92", "data": { "userId": "5e089f88b400211639928c92", "endpoint": "https://fyipe.com", "endpointType": "get", "monitorId": "5e08a21b25c59a1c8033c7e7" }, "integrationType": "webhook", "__v": 0, "deletedAt": "2020-01-14T20:57:57.751Z", "deletedById": "5e089f88b400211639928c92" }