+ +
+
+

API Reference

+

+

+ The Fyipe API is organized around REST. + 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://api.fyipe.com/

+
+
+
+
+
+
+

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, as query string, or as request body. +

+
+
+
+

As Request Headers

+
+

project-id: your-project-id-here

+

api-key: your-api-key-here

+
+
+ +
+

As Request Query

+
+

https://api.fyipe.com/your-path?project-id=XXX&api-key=XXX

+
+
+
+

As Request Body

+
+

{ project-id: XXX, api-key: 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 specifiy what types of output you're looking for by specifing + the output-type param. +

+
+
+ +
+

As Request Query

+
+

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

+
+
+ +
+
+ +
+
+

Errors

+

+

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

+

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

+

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.

+

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 body
    +
    • + +
  • +
    400
    +
    BAD REQUEST - The request was formatted + improperly +
    +
    • + +
  • +
    401
    +
    UNAUTHORIZED - API Key missing or invalid
    +
    • + +
  • +
    403
    +
    FORBIDDEN - Insufficient permissions
    +
    • + +
  • +
    404
    +
    NOT FOUND - The resource requested does not + exist +
    +
    • + +
  • +
    500
    +
    INTERNAL ERROR - We had an error! Sorry + about + that.
    +
    • + +
+
+
+
+
+ + +
+ +
+ +

Alerts

+ +

+

Alerts API gets all the alerts sent your team members. If you want to see alerts that are sent to your + customers who have subscribed to incidents. Please check subscriber alerts instead.

+

+
+

Path

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

Get all alertsGET

+

+

Get the log of all alerts sent to your team.

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you need from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you want to skip. This is used for pagination.

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

https://api.fyipe.com/alert/:projectId?api-key=XXX&limit=10&skip=0

+
+ +
+
+

Example Response (200)

+
+ 
+                        
+                          
{
+  "data":
+  [
+    {
+      "_id": "5bf55a2ed2f835000fb63fae",
+      "createdAt": "2018-11-21T13:14:22.111Z",
+      "project": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+      "subProjectId": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sub Project Name"
+      },
+      "monitor": {
+        "_id": "5bf55957e2e78a000ff4c001",
+        "name": "Sample Monitor"
+      },
+      "alertVia": "sms",
+      "userId": {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Team Member Name"
+      },
+      "incidentId": "5bf55a2dd2f835000fb63fab",
+      
+    },
+    {
+      "_id": "5bf55a2ed2f835000fb63fad",
+      "createdAt": "2018-11-21T13:14:22.089Z",
+      "project": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+      "subProjectId": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sub Project Name"
+      },
+      "monitor": {
+        "_id": "5bf55957e2e78a000ff4c001",
+        "name": "Sample Monitor"
+      },
+      "alertVia": "call",
+      "userId": {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Team Member Name"
+      },
+      "incidentId": "5bf55a2dd2f835000fb63fab",
+      
+    }
+  ],
+  "count":2,
+  "skip":"0",
+  "limit":"10"
+}

+    
+                        
+
+
+
+
+ + + + + +
+
+ +
+
+

Get all alerts by IncidentGET

+

+

Get the log of all alerts sent to your team by Incident.

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you need from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you want to skip. This is used for pagination.

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

https://api.fyipe.com/alert/:projectId?api-key=XXX&limit=10&skip=0

+
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            
{
+  "data":
+  [
+    {
+      "_id": "5bf55a2ed2f835000fb63fae",
+      "createdAt": "2018-11-21T13:14:22.111Z",
+      "project": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+      "subProjectId": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sub Project Name"
+      },
+      "monitor": {
+        "_id": "5bf55957e2e78a000ff4c001",
+        "name": "Sample Monitor"
+      },
+      "alertVia": "sms",
+      "userId": {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Team Member Name"
+      },
+      "incidentId": "5bf55a2dd2f835000fb63fab",
+      
+    },
+    {
+      "_id": "5bf55a2ed2f835000fb63fad",
+      "createdAt": "2018-11-21T13:14:22.089Z",
+      "project": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+      "subProjectId": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sub Project Name"
+      },
+      "monitor": {
+        "_id": "5bf55957e2e78a000ff4c001",
+        "name": "Sample Monitor"
+      },
+      "alertVia": "call",
+      "userId": {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Team Member Name"
+      },
+      "incidentId": "5bf55a2dd2f835000fb63fab",
+      
+    }
+  ],
+  "count":2,
+  "skip":"0",
+  "limit":"10"
+}

+      
+                          
+
+
+
+
+
+
+ + + + + +
+ +
+ +

Incidents

+ +

+

Inidents are created when your monitor goes down. Incidents alerts team members which are responsible for + that monitor. Team members can Acknowledge the incident and when the issue is fixed, resolve it.

+

+
+

Path

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

Create IncidentPOST

+

+

Create an incident for a monitor. If an unresolved incident exists, then it is returne and no new + incident is created.

+

+
+

Path

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

Body

+
    + +
  • +
    +
    +
    + monitorId + string +
    +
    +
    +
    +

    ID of the monitor you want to create incidents for.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+    "api-key":"xxx",
+    "monitorId": "5b521b39f1a8f6000fce3839"
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                            
+                              
{
+  "acknowledged": false,
+  "resolved": false,
+  "internalNote": "",
+  "investigationNote": "",
+  "_id": "5bf698dad2f835000fb63fb6",
+  "createdAt": "2018-11-22T11:54:02.716Z",
+  "project": {
+    "_id": "5bd722c156f172000f33a2cc",
+    "name": "Sample Project"
+  },
+  "subProjectId": "xf3cf7a6c6cc5a000fc523be",
+  "monitor": {
+    "_id": "5b521b39f1a8f6000fce3839",
+    "name": "cloudboost",
+  },
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  }
+}

+
+
+
+
+
+
+ +
+
+

Get all incidents by MonitorGET

+

+

Get the log of all incidents by Monitor.

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you need from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you want to skip. This is used for pagination.

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

+ https://api.fyipe.com/incident/:projectId/:monitorId?api-key=XXX&limit=10&skip=0

+
+ +
+
+

Example Response (200)

+
+ 
+                            
+                              
{
+  "data":
+  [
+    {
+      "acknowledged": false,
+      "resolved": false,
+      "internalNote": "",
+      "investigationNote": "",
+      "_id": "5bf698dad2f835000fb63fb6",
+      "createdAt": "2018-11-22T11:54:02.716Z",
+      "project": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+      "subProjectId": "xf3cf7a6c6cc5a000fc523be",
+      "monitor": {
+        "_id": "5b521b39f1a8f6000fce3839",
+        "name": "cloudboost",
+      },
+      "createdBy": {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Nawaz Dhandala"
+      },
+      
+    },
+    {
+      "acknowledged": false,
+      "resolved": false,
+      "internalNote": "",
+      "investigationNote": "",
+      "_id": "5bf698dad2f835000fb63fb6",
+      "createdAt": "2018-11-22T11:54:02.716Z",
+      "project": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+      "subProjectId": "xf3cf7a6c6cc5a000fc523be",
+      "monitor": {
+        "_id": "5b521b39f1a8f6000fce3839",
+        "name": "cloudboost",
+      },
+      "createdBy": {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Nawaz Dhandala"
+      },
+      
+    }
+  ],
+  "count":2,
+  "skip":"0",
+  "limit":"10"
+}

+        
+                            
+
+
+
+
+
+
+ +
+
+

Get all incidents by ProjectGET

+

+

Get the log of all incidents by Project.

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you need from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you want to skip. This is used for pagination.

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

https://api.fyipe.com/incident/:projectId?api-key=XXX&limit=10&skip=0

+
+ +
+
+

Example Response (200)

+
+ 
+                            
+                              
{
+  "data":
+  [
+    {
+      "acknowledged": false,
+      "resolved": false,
+      "internalNote": "",
+      "investigationNote": "",
+      "_id": "5bf698dad2f835000fb63fb6",
+      "createdAt": "2018-11-22T11:54:02.716Z",
+      "project": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+      "subProjectId": "xf3cf7a6c6cc5a000fc523be",
+      "monitor": {
+        "_id": "5b521b39f1a8f6000fce3839",
+        "name": "cloudboost",
+      },
+      "createdBy": {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Nawaz Dhandala"
+      },
+      
+    },
+    {
+      "acknowledged": false,
+      "resolved": false,
+      "internalNote": "",
+      "investigationNote": "",
+      "_id": "5bf698dad2f835000fb63fb6",
+      "createdAt": "2018-11-22T11:54:02.716Z",
+      "project": {
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+      "subProjectId": "xf3cf7a6c6cc5a000fc523be",
+      "monitor": {
+        "_id": "5b521b39f1a8f6000fce3839",
+        "name": "cloudboost",
+      },
+      "createdBy": {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Nawaz Dhandala"
+      },
+      
+    }
+  ],
+  "count":2,
+  "skip":"0",
+  "limit":"10"
+}

+        
+                            
+
+
+
+
+
+
+ +
+
+

Get incident by Incident IDGET

+

+

Get the incident by Incident ID.

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • + +
+
+ +
+
+ +
+
+

Example Request

+
+

https://api.fyipe.com/incident/:projectId/:incidentId?api-key=XXX

+
+ +
+
+

Example Response (200)

+
+ 
+                            
+                              
{
+  "acknowledged": false,
+  "resolved": false,
+  "internalNote": "",
+  "investigationNote": "",
+  "_id": "5bf698dad2f835000fb63fb6",
+  "createdAt": "2018-11-22T11:54:02.716Z",
+  "project": { 
+      "_id": "5bd722c156f172000f33a2cc",
+      "name": "Sample Project"
+  },
+  "subProjectId": "xf3cf7a6c6cc5a000fc523be",
+  "monitor": {
+    "_id": "5b521b39f1a8f6000fce3839",
+    "name": "cloudboost",
+  },
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+}

+        
+                            
+
+
+
+
+
+
+ + + +
+
+

Update an incidentPUT

+

+

Update an incident (acknowledge it, resolve it, or post investigation notes or internal notes)

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + resolved + boolean +
    +
    +
    +
    +

    Is this incident resolved?

    +
    +
    +
    +
    • +
  • +
    +
    +
    + acknowledged + boolean +
    +
    +
    +
    +

    Is this incident acknowledged?

    +
    +
    +
    +
    • +
  • +
    +
    +
    + internalNote + boolean +
    +
    +
    +
    +

    Internal note for your team

    +
    +
    +
    +
    • +
  • +
    +
    +
    + investigationNote + boolean +
    +
    +
    +
    +

    Investigation note that will be posted to status page.

    +
    +
    +
    +
    • + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "api-key":"xxx",
+  "acknowledged": true
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                            
+                              

+{
+  "acknowledged": true,
+  "resolved": false,
+  "internalNote": "",
+  "investigationNote": "",
+  "_id": "5bf698dad2f835000fb63fb6",
+  "createdAt": "2018-11-22T11:54:02.716Z",
+  "project": {
+    "_id": "5bd722c156f172000f33a2cc",
+    "name": "Sample Project"
+  },
+  "subProjectId": "xf3cf7a6c6cc5a000fc523be",
+  "monitor": {
+    "_id": "5b521b39f1a8f6000fce3839",
+    "createdAt": "2018-07-20T17:26:17.087Z",
+    "pollTime": "2018-10-28T07:35:28.736Z",
+    "updateTime": "2018-10-28T00:00:18.320Z",
+    "createdBy": "5b0c1298367534000fdbc46e",
+    "name": "cloudboost",
+    "type": "url",
+    "data": {
+      "url": "https://cloudboost.io/"
+    },
+    "project": {  
+      "_id": "5bd722c156f172000f33a2cc",
+      "name": "Sample Project"
+    }
+  },
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+  "acknowledgedBy":{
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+  "acknowledgedAt": "2018-11-22T11:54:02.716Z", 
+}
+                              
+                              

+        
+                            
+
+
+
+
+
+
+ + + + + + + + + + +
+ +
+ +

Monitors

+ +

+

Monitors are the one's that actually monitors your resource, and creates a new incident when something + unexpected happens. Resource can be a URL, Device, Server, Application or a Process.

+

+
+

Path

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

Create a monitorPOST

+

+

Create a monitor in the project.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + name + string +
    +
    +
    +
    +

    Monitor Name

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorCategoryId (optional) + string +
    +
    +
    +
    +

    Monitor category ID of the monitor category you want to attach with the monitor.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + type + string +
    +
    +
    +
    +

    Monitor Type- This can be `url` if you monitor a URL, can be `device` if you want to monitor a + device or can be `manual` like the monitor to not monitor anything.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + type + string +
    +
    +
    +
    +

    Monitor Type- This can be `url` if you monitor a URL, can be `device` if you want to monitor a + device or can be `manual` like the monitor to not monitor anything.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + data + json +
    +
    +
    +
    +

    If monitor type is `url`. Data should be {url: 'https://anyurl.com'} which is the URL that you + would like to monitor.
    If monitor type is `device`. Data should be `{deviceId: 'any-id'}. + Device ID is any ID of an IoT device that you would like to monitor.
    If Monitor Type is + `Manual`. Data can be null.

    +
    +
    +
    +
    • + + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "api-key":"xxx",
+  "name": "Google",
+  "type": "url",
+  "monitorCategoryId":"5cf5f4c27428480b750ae199",
+  "data": {
+    "url": "https://google.com"
+  }
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            
{
+  "_id": "5b521b39f1a8f6000fce3839",
+  "createdAt": "2018-07-20T17:26:17.087Z",
+  "pollTime": "2018-10-28T07:35:28.736Z",
+  "updateTime": "2018-10-28T00:00:18.320Z",
+  "createdBy": "5b0c1298367534000fdbc46e",
+  "name": "Google",
+  "type": "url",
+  "monitorCategoryId":"5cf5f4c27428480b750ae199",
+  "data": {
+    "url": "https://google.com/"
+  },
+  "project": {  
+    "_id": "5bd722c156f172000f33a2cc",
+    "name": "Sample Project"
+  },
+} 

+      
+                          
+
+
+
+
+
+
+ +
+
+

Update a monitorPUT

+

+

Update a monitor in the project. You cannot change the type of the monitor.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + name + string +
    +
    +
    +
    +

    Monitor Name

    +
    +
    +
    +
    • + +
  • +
    +
    +
    + type + string +
    +
    +
    +
    +

    Monitor Type- This can be `url` if you monitor a URL, can be `device` if you want to monitor a + device or can be `manual` like the monitor to not monitor anything.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + data + json +
    +
    +
    +
    +

    If monitor type is `url`. Data should be {url: 'https://anyurl.com'} which is the URL that you + would like to monitor.
    If monitor type is `device`. Data should be `{deviceId: 'any-id'}. + Device ID is any ID of an IoT device that you would like to monitor.
    If Monitor Type is + `Manual`. Data can be null.

    +
    +
    +
    +
    • + + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "api-key":"xxx",
+  "name": "Google",
+  "data": {
+    "url": "https://google.com"
+  }
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            
{
+  "_id": "5b521b39f1a8f6000fce3839",
+  "createdAt": "2018-07-20T17:26:17.087Z",
+  "pollTime": "2018-10-28T07:35:28.736Z",
+  "updateTime": "2018-10-28T00:00:18.320Z",
+  "createdBy": "5b0c1298367534000fdbc46e",
+  "name": "Google",
+  "type": "url",
+  "data": {
+    "url": "https://google.com/"
+  },
+  "project": {
+    "_id": "5bd722c156f172000f33a2cc",
+    "name": "Sample Project"
+  },
+}

+      
+                          
+
+
+
+
+
+
+ +
+
+

Get all monitors by Project IDGET

+

+

Get all monitors by Project ID.

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • + +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Items you would like to skip. This is used for pagination.

    +
    +
    +
    +
    • + +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you want to get from the API.

    +
    +
    +
    +
    • + +
+
+ +
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/monitor/:projectId?api-key=XXX&skip=0&limit=10

+
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            

+{
+  "monitors":
+  [
+    {
+      "_id": "5b521b39f1a8f6000fce3839",
+      "createdAt": "2018-07-20T17:26:17.087Z",
+      "pollTime": "2018-10-28T07:35:28.736Z",
+      "updateTime": "2018-10-28T00:00:18.320Z",
+      "createdBy": "5b0c1298367534000fdbc46e",
+      "name": "cloudboost",
+      "type": "url",
+      "data": {
+        "url": "https://cloudboost.io/"
+      },
+      "project": {  
+        "_id": "5bd722c156f172000f33a2cc",
+        "name": "Sample Project"
+      },
+    }
+  ],
+  "count":1,
+  "skip":"0",
+  "limit":"10"
+}
+                            
+                            

+      
+                          
+
+
+
+
+
+
+ +
+
+

Get monitor by monitor IDGET

+

+

Get all monitors by Monitor ID.

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
+
+
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/monitor/:projectId/:monitorId?api-key=XXX

+
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            
{
+  "_id": "5b521b39f1a8f6000fce3839",
+  "createdAt": "2018-07-20T17:26:17.087Z",
+  "pollTime": "2018-10-28T07:35:28.736Z",
+  "updateTime": "2018-10-28T00:00:18.320Z",
+  "createdBy": "5b0c1298367534000fdbc46e",
+  "name": "cloudboost",
+  "type": "url",
+  "data": {
+    "url": "https://cloudboost.io/"
+  },
+  "project": {  
+    "_id": "5bd722c156f172000f33a2cc",
+    "name": "Sample Project"
+  },
+  
+}

+      
+                          
+
+
+
+
+
+
+ + + +
+
+

Delete a monitorDELETE

+

+

Delete a monitor by Monitor ID

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
+
+
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/monitor/:projectId/:monitorId?api-key=XXX

+
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            

+{
+  "_id": "5b521b39f1a8f6000fce3839",
+  "createdAt": "2018-07-20T17:26:17.087Z",
+  "pollTime": "2018-10-28T07:35:28.736Z",
+  "updateTime": "2018-10-28T00:00:18.320Z",
+  "createdBy": "5b0c1298367534000fdbc46e",
+  "name": "cloudboost",
+  "type": "url",
+  "data": {
+    "url": "https://cloudboost.io/"
+  },
+  "project": {  
+    "_id": "5bd722c156f172000f33a2cc",
+    "name": "Sample Project"
+  },
+  
+}
+                            

+      
+                          
+
+
+
+
+
+
+ +
+
+

Update Monitor of Type Device POST or GET

+

+

Monitor of Type device needs to send a post or a get request in order to keep the monitor updated. If the + monitor is not updated, then an incident is automatically created and that alerts the team.

+

+
+

Path

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

Query String or Body

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
+
+ +
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/monitor/:projectId/inbound/:deviceId?api-key=XXX

+ +
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            

+{
+    
+}
+                            
+                            

+      
+                          
+
+
+
+
+
+
+ + + + + + +
+ +
+ +

Monitor Category

+ +

+

Monitor can be categorized in any way you like. Most of our customers categorize monitors by location - Eg: US EAST, US WEST, EU. You can also categorize monitors by projects.

+

+
+

Path

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

Create a monitor categoryPOST

+

+

Create a monitor category in the project.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorCategoryName + string +
    +
    +
    +
    +

    Name for your monitor category. +

    +
    +
    +
    +
    • + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
+                
+                  

+{
+  "api-key":"xxx",
+  "monitorCategoryName":"US EAST"
+}
+                  

+                
+
+
+ +
+
+

Example Response (200)

+
+ 
+                
+                  

+{
+  "_id": "5cf0415ad79fda043a0b0916",
+  "createdAt": "2019-05-30T20:47:22.581Z",
+  "projectId": "5ce6a2fd2ffa26020dbe00b7",
+  "createdById": "5ce6a2f52ffa26020dbe00b6",
+  "name": "US EAST",
+  "__v": 0
+} 
+                  

+                
+
+
+
+
+
+
+ +
+
+

Get all monitor categories by projectGET

+

+

Get all monitor categories by project ID.

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Items you would like to skip. This is used for pagination.

    +
    +
    +
    +
    • + +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you want to get from the API.

    +
    +
    +
    +
    • + +
+
+ +
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/monitorCategory/:projectId?api-key=XXX&skip=0&limit=10

+
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            

+        {
+          "data": [
+            {
+          "name": "EU",
+          "_id": "5cef73a78b3eac1c10ec6ab2",
+          "createdAt": "2019-05-30T06:09:43.129Z"
+          },
+            {
+          "name": "US WEST",
+          "_id": "5cee7d95e194a35afba8b9aa",
+          "createdAt": "2019-05-29T12:39:49.062Z"
+          }
+          ],
+          "count": 2,
+          "skip":0,
+          "limit":10
+          }
+    
+                            

+      
+                          
+
+
+
+
+
+
+ +
+
+

Delete a monitor categoryDELETE

+

+

Delete a monitor category by ID.

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
+
+
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/monitorCategory/:projectId/:monitorCategoryId?api-key=XXX

+
+ +
+
+

Example Response (200)

+
+ 
+                
+                  

+{
+  "_id": "5ced0a7ed05b2e0ff15e0759",
+  "createdAt": "2019-05-28T10:16:30.829Z",
+  "projectId": "5ce6a2fd2ffa26020dbe00b7",
+  "createdById": "5ce6a2f52ffa26020dbe00b6",
+  "name": "US EAST",
+  "__v": 0,
+}
+                  

+                
+
+
+
+
+
+
+ + + + + + + +
+ +
+ +

Schedule

+ +

+

Schedules defines who in your team will be alerted when the incident is created. How the escalation polies + are created, and more.

+

+ +
+

Path

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

Create a schedulePOST

+

+

Create a schedule in the project.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + name + string +
    +
    +
    +
    +

    Schedule Name

    +
    +
    +
    +
    • +
  • +
    +
    +
    + userIds + Array +
    +
    +
    +
    +

    Who in your team will be alerted for this schedule.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorIds + Array +
    +
    +
    +
    +

    Which monitors do you want to include in this schedule.

    +
    +
    +
    +
    • + + + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "api-key":"xxx",
+  "name": "Sample Schedule",
+  "monitorIds": ["5b521b39f1a8f6000fce3839"],
+  "userIds": ["5b0c1298367534000fdbc46e"]
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            

+{
+  "users": [{
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  }],
+  "monitors": [
+    {
+      "_id": "5b0ed2b5ff1870000fd249c0",
+      "name": "Dashboard"
+    }
+  ],
+  "_id": "5bbe0286d2f835000fb63e91",
+  "name": "Sample Schedule",
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+  "project": {
+    "_id": "5b0c129e367534000fdbc46f",
+    "name": "CloudBoost"
+  },
+  "createdAt": "2018-10-10T13:45:42.206Z",
+  
+}
+                            
+                            

+      
+                          
+
+
+
+
+
+
+ +
+
+

Get all schedules by ProjectGET

+

+

Get all schedules by Project

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you would like to return from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you would need to skip. This is used in pagination

    +
    +
    +
    +
    • + + + + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

https://api.fyipe.com/schedule/:projectId?skip=0&limit=10&api-key=XXX

+ +
+ +
+
+

Example Response (200)

+
+ 
+                          
+                            

+{
+  "data" [{
+    "users": [
+      {
+        "_id": "5b0c1298367534000fdbc46e",
+        "name": "Nawaz Dhandala"
+      }
+    ],
+    "monitors": [],
+    "_id": "5b49fab4d8dacb000fbfdaf7",
+    "name": "Dashboard",
+    "createdBy": {
+      "_id": "5b0c1298367534000fdbc46e",
+      "name": "Nawaz Dhandala"
+    },
+    "project": {
+      "_id": "5b0c129e367534000fdbc46f",
+      "name": "CloudBoost"
+    },
+    "createdAt": "2018-07-14T13:29:24.458Z",
+    
+  }],
+  count:1,
+  skip:0,
+  limit:10
+}
+                            
+                            

+      
+                          
+
+
+
+
+
+
+ +
+
+

Update a schedulePUT

+

+

Update a schedule in the project.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + name + string +
    +
    +
    +
    +

    Schedule Name

    +
    +
    +
    +
    • +
  • +
    +
    +
    + userIds + Array +
    +
    +
    +
    +

    Who in your team will be alerted for this schedule.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorIds + Array +
    +
    +
    +
    +

    Which monitors do you want to include in this schedule.

    +
    +
    +
    +
    • + + + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "api-key":"xxx",
+  "name": "Sample Schedule",
+  "monitorIds": ["5b521b39f1a8f6000fce3839"],
+  "userIds": ["5b0c1298367534000fdbc46e"]
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                            
+                              

+{
+  "users": [{
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  }],
+  "monitors": [
+    {
+      "_id": "5b0ed2b5ff1870000fd249c0",
+      "name": "Dashboard"
+    }
+  ],
+  "_id": "5bbe0286d2f835000fb63e91",
+  "name": "Sample Schedule",
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+  "project": {
+    "_id": "5b0c129e367534000fdbc46f",
+    "name": "CloudBoost"
+  },
+  "createdAt": "2018-10-10T13:45:42.206Z",
+  
+}
+                              
+                              

+        
+                            
+
+
+
+
+
+
+ + +
+
+

Delete a scheduleDELETE

+

+

Delete a schedule by Schedule ID

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
+
+
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/schedule/:projectId/:scheduleId?api-key=XXX

+
+ +
+
+

Example Response (200)

+
+ 
+                              
+                                

+{
+  "users": [{
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  }],
+  "monitors": [
+    {
+      "_id": "5b0ed2b5ff1870000fd249c0",
+      "name": "Dashboard"
+    }
+  ],
+  "_id": "5bbe0286d2f835000fb63e91",
+  "name": "Sample Schedule",
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+  "project": {
+    "_id": "5b0c129e367534000fdbc46f",
+    "name": "CloudBoost"
+  },
+  "createdAt": "2018-10-10T13:45:42.206Z",
+  
+}
+                                

+          
+                              
+
+
+
+
+
+
+ + + + + + +
+ +
+ +

Status Pages

+ +

+

Status Pages creates a status page for your team or your customers (exactly like https://status.fyipe.com) +

+

+ +
+

Path

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

Create a status pagePOST

+

+

Create a status page in the project.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + name + string +
    +
    +
    +
    +

    Status Page Name

    +
    +
    +
    +
    • +
  • +
    +
    +
    + title + String +
    +
    +
    +
    +

    Title of the status page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + description + String +
    +
    +
    +
    +

    Description of the status page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + copyright + String +
    +
    +
    +
    +

    Copyright Info about the status page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + favicon + String +
    +
    +
    +
    +

    Favicon URL for the Status Page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + logoPath + String +
    +
    +
    +
    +

    Logo URL for the status page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + domain + String +
    +
    +
    +
    +

    Domain this status page will be hosted on

    +
    +
    +
    +
    • +
  • +
    +
    +
    + isPrivate + Boolean +
    +
    +
    +
    +

    Is this status page private to your team or public to the whole world.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorIds + Array +
    +
    +
    +
    +

    Which monitors do you want to include in this status page?

    +
    +
    +
    +
    • +
  • +
    +
    +
    + links + Array +
    +
    +
    +
    +

    Links that you want in the footer of the status page. This should not exceed 5. The format + should be `{name: "Home", url: "https://homepage.com"}`

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "api-key":"xxx",
+  "name": "Sample Status Page",
+  "monitorIds": ["Ab0c129e367534000fdbc46f"],
+  "domain": "https://status.fyipe.com",
+  "links": {
+    "name": "Sample Link",
+    "url": "https://samplelink.com"
+  },
+  "isPrivate":false,
+  "description": "Sample description",
+  "title": "Sample Title",
+  "copyright": "HackerBay, Inc.",
+  "faviconPath": "https://path-to-fav-icon/favicon.ico",
+  "logoPath": "https://path-to-logo/logo.ico"
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                            
+                              
{
+  "api-key":"xxx",
+  "name": "Sample Status Page",
+  "monitors": {
+    "_id": "Ab0c129e367534000fdbc46f",
+    "name": "Sample Monitor"
+  },
+  "domain": "https://status.fyipe.com",
+  "links": {
+    "name": "Sample Link",
+    "url": "https://samplelink.com"
+  },
+  "isPrivate":false,
+  "description": "Sample description",
+  "title": "Sample Title",
+  "copyright": "HackerBay, Inc.",
+  "faviconPath": "https://path-to-fav-icon/favicon.ico",
+  "logoPath": "https://path-to-logo/logo.ico",
+  "_id": "5bbe0286d2f835000fb63e91",
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+  "project": {
+    "_id": "5b0c129e367534000fdbc46f",
+    "name": "CloudBoost"
+  },
+  "createdAt": "2018-10-10T13:45:42.206Z",
+                                    
+}
+

+        
+                            
+
+
+
+
+
+
+ +
+
+

Get all status pages by ProjectGET

+

+

Get all status pages by Project

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you would like to return from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you would need to skip. This is used in pagination

    +
    +
    +
    +
    • + + + + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

https://api.fyipe.com/statusPage/:projectId?skip=0&limit=10&api-key=XXX

+ +
+ +
+
+

Example Response (200)

+
+ 
+                            
+                              

+{
+  "data":[{
+  "_id":"5cef7d6d9d9d972fd9f505f4",
+  "monitorIds":[
+      {
+        "_id":"5cf0fea7a59bae3762ae4391",
+        "name":"Test",
+        "type":"url",
+        "data":{
+            "url":"https://www.test.com"
+        },
+        "monitorCategoryId":{
+            "_id":"5cf0cd658ffd6b2475396665",
+            "name":"US EAST"
+        },
+        "time":[
+            {
+              "date":"2019-06-04T05:54:53.114Z",
+              "monitorId":"5cf0fea7a59bae3762ae4391",
+              "upTime":254,
+              "downTime":3
+            },
+            {
+              "upTime":606,
+              "downTime":22,
+              "_id":"5cf56730c3e8414fe087425c",
+              "date":"2019-06-03T18:29:00.912Z",
+              "monitorId":"5cf0fea7a59bae3762ae4391",
+              "status":"online",
+              "__v":0
+            },
+            {
+              "upTime":491,
+              "downTime":7,
+              "_id":"5cf2c43a7319f36a0243b600",
+              "date":"2019-06-01T18:29:00.319Z",
+              "monitorId":"5cf0fea7a59bae3762ae4391",
+              "status":"online",
+              "__v":0
+            }
+          ],
+          "stat":"online",
+          "totalUptimePercent":97.68618944323933
+        }
+    ],
+    "links":null,
+    "isGroupedByMonitorCategory":true,
+    "deleted":false,
+    "createdAt":"2019-05-30T06:51:25.565Z",
+    "projectId":{
+        "_id":"5ce6a2fd2ffa26020dbe00b7",
+        "name":"Sample"
+    },
+    "domain":null,
+    "title":"Sample status page title",
+    "name":Sample status page name,
+    "isPrivate":false,
+    "description":null,
+    "copyright":null,
+    "faviconPath":null,
+    "logoPath":null,
+    "isSubscriberEnabled":true,
+    "__v":0
+  }],
+  "count":1,
+  "skip":0,
+  "limit":10
+}
+                              

+        
+                            
+
+
+
+
+
+
+ +
+
+

Get status page by status page IDGET

+

+

Get status pages by ID

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • + + + + + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

https://api.fyipe.com/statusPage/:projectId/:statusPageId?api-key=XXX

+ +
+ +
+
+

Example Response (200)

+
+ 
+                              
+                                

+{
+  "_id":"5cef7d6d9d9d972fd9f505f4",
+  "monitorIds":[
+      {
+        "_id":"5cf0fea7a59bae3762ae4391",
+        "name":"Test",
+        "type":"url",
+        "data":{
+            "url":"https://www.test.com"
+        },
+        "monitorCategoryId":{
+            "_id":"5cf0cd658ffd6b2475396665",
+            "name":"US EAST"
+        },
+        "time":[
+            {
+              "date":"2019-06-04T05:54:53.114Z",
+              "monitorId":"5cf0fea7a59bae3762ae4391",
+              "upTime":254,
+              "downTime":3
+            },
+            {
+              "upTime":606,
+              "downTime":22,
+              "_id":"5cf56730c3e8414fe087425c",
+              "date":"2019-06-03T18:29:00.912Z",
+              "monitorId":"5cf0fea7a59bae3762ae4391",
+              "status":"online",
+              "__v":0
+            },
+            {
+              "upTime":491,
+              "downTime":7,
+              "_id":"5cf2c43a7319f36a0243b600",
+              "date":"2019-06-01T18:29:00.319Z",
+              "monitorId":"5cf0fea7a59bae3762ae4391",
+              "status":"online",
+              "__v":0
+            }
+        ],
+        "stat":"online",
+        "totalUptimePercent":97.68618944323933
+      }
+  ],
+  "links":null,
+  "isGroupedByMonitorCategory":true,
+  "deleted":false,
+  "createdAt":"2019-05-30T06:51:25.565Z",
+  "projectId":{
+      "_id":"5ce6a2fd2ffa26020dbe00b7",
+      "name":"Sample"
+  },
+  "domain":null,
+  "title":"Sample status page",
+  "name":null,
+  "isPrivate":false,
+  "description":null,
+  "copyright":null,
+  "faviconPath":null,
+  "logoPath":null,
+  "isSubscriberEnabled":true,
+  "__v":0
+}
+                                

+          
+                              
+
+
+
+
+
+
+ + +
+
+

Update a status pagePUT

+

+

Update a status page in the project.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + name + string +
    +
    +
    +
    +

    Status Page Name

    +
    +
    +
    +
    • +
  • +
    +
    +
    + title + String +
    +
    +
    +
    +

    Title of the status page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + description + String +
    +
    +
    +
    +

    Description of the status page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + copyright + String +
    +
    +
    +
    +

    Copyright Info about the status page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + favicon + String +
    +
    +
    +
    +

    Favicon URL for the Status Page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + logoPath + String +
    +
    +
    +
    +

    Logo URL for the status page

    +
    +
    +
    +
    • +
  • +
    +
    +
    + domain + String +
    +
    +
    +
    +

    Domain this status page will be hosted on

    +
    +
    +
    +
    • +
  • +
    +
    +
    + isPrivate + Boolean +
    +
    +
    +
    +

    Is this status page private to your team or public to the whole world.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorIds + Array +
    +
    +
    +
    +

    Which monitors do you want to include in this status page?

    +
    +
    +
    +
    • +
  • +
    +
    +
    + links + Array +
    +
    +
    +
    +

    Links that you want in the footer of the status page. This should not exceed 5. The format + should be `{name: "Home", url: "https://homepage.com"}`

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "api-key":"xxx",
+  "name": "Sample Status Page",
+  "monitorIds": ["Ab0c129e367534000fdbc46f"],
+  "domain": "https://status.fyipe.com",
+  "links": {
+    "name": "Sample Link",
+    "url": "https://samplelink.com"
+  },
+  "isPrivate":false,
+  "description": "Sample description",
+  "title": "Sample Title",
+  "copyright": "HackerBay, Inc.",
+  "faviconPath": "https://path-to-fav-icon/favicon.ico",
+  "logoPath": "https://path-to-logo/logo.ico"
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                              
+                                
{
+  "api-key":"xxx",
+  "name": "Sample Status Page",
+  "monitors": {
+    "_id": "Ab0c129e367534000fdbc46f",
+    "name": "Sample Monitor"
+  },
+  "domain": "https://status.fyipe.com",
+  "links": {
+    "name": "Sample Link",
+    "url": "https://samplelink.com"
+  },
+  "isPrivate":false,
+  "description": "Sample description",
+  "title": "Sample Title",
+  "copyright": "HackerBay, Inc.",
+  "faviconPath": "https://path-to-fav-icon/favicon.ico",
+  "logoPath": "https://path-to-logo/logo.ico"
+  "_id": "5bbe0286d2f835000fb63e91",
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+  "project": {
+    "_id": "5b0c129e367534000fdbc46f",
+    "name": "CloudBoost"
+  },
+  "createdAt": "2018-10-10T13:45:42.206Z",
+  
+}
+                                

+          
+                              
+
+
+
+
+
+
+ + +
+
+

Delete a status pageDELETE

+

+

Delete a status page by Status Page ID

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
+
+
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/statusPage/:projectId/:scheduleId?api-key=XXX

+
+ +
+
+

Example Response (200)

+
+ 
+                                
+                                  
{
+  "api-key":"xxx",
+  "name": "Sample Status Page",
+  "monitors": {
+    "_id": "Ab0c129e367534000fdbc46f",
+    "name": "Sample Monitor"
+  },
+  "domain": "https://status.fyipe.com",
+  "links": {
+    "name": "Sample Link",
+    "url": "https://samplelink.com"
+  },
+  "isPrivate":false,
+  "description": "Sample description",
+  "title": "Sample Title",
+  "copyright": "HackerBay, Inc.",
+  "faviconPath": "https://path-to-fav-icon/favicon.ico",
+  "logoPath": "https://path-to-logo/logo.ico"
+  "_id": "5bbe0286d2f835000fb63e91",
+  "createdBy": {
+    "_id": "5b0c1298367534000fdbc46e",
+    "name": "Nawaz Dhandala"
+  },
+  "project": {
+    "_id": "5b0c129e367534000fdbc46f",
+    "name": "CloudBoost"
+  },
+  "createdAt": "2018-10-10T13:45:42.206Z",
+  
+}
+                                  

+            
+                                
+
+
+
+
+
+
+ + + + + + + +
+ +
+ +

Subscribers

+ +

+

Subscribers are your customers who subscribe to alerts for your Monitors. They are alerted via SMS and + Email when something unexpected happens. +

+

+ +
+

Path

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

Create a subscriberPOST

+

+

Create a subscriber for a monitor.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorIds + Array +
    +
    +
    +
    +

    Array of monitor Id or monitor names you want subscriber to subscribe to.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + contactEmail + String +
    +
    +
    +
    +

    Email of the subscriber

    +
    +
    +
    +
    • +
  • +
    +
    +
    + contactPhone + String +
    +
    +
    +
    +

    Phone Number of the Subscriber

    +
    +
    +
    +
    • +
  • +
    +
    +
    + alertVia + Array +
    +
    +
    +
    +

    How do you want the subscriber to be alerted. Can be any or all of these values ["call", "sms", + "email"]

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "api-key":"xxx",
+  "alertVia": ["sms", "email"],
+  "monitorIds": ["Ab0c129e367534000fdbc46f"],
+  "contactEmail":"my@email.com",
+  "contactPhone": "+1-510-751-0204",
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                                  
+                                    
{
+  "_id": "eb0c129e36753400Xfdbc46l"
+  "alertVia": ["sms", "email"],
+  "monitors": [{ 
+    "_id": "Ab0c129e367534000fdbc46f", 
+    "name": "Sample Monitor"
+  }],
+  "contactEmail":"my@email.com",
+  "contactPhone": "+1-510-751-0204",
+}
+                                    

+              
+                                  
+
+
+
+
+
+
+ +
+
+

Get all subscribers by ProjectGET

+

+

Get all subscribers by Project

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you would like to return from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you would need to skip. This is used in pagination

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

https://api.fyipe.com/subscriber/:projectId?skip=0&limit=10&api-key=XXX

+ +
+ +
+
+

Example Response (200)

+
+ 
+                                  
+                                    

+{
+  "subscribers" [{
+    "_id": "eb0c129e36753400Xfdbc46l"
+    "alertVia": ["sms", "email"],
+    "monitors": [{ 
+      _id: "Ab0c129e367534000fdbc46f", 
+      name: "Sample Monitor"
+    }],
+    "contactEmail":"my@email.com",
+    "contactPhone": "+1-510-751-0204",
+  }],
+  count:1,
+  skip:0,
+  limit:10
+}
+                                    
+                                    

+              
+                                  
+
+
+
+
+
+
+ +
+
+

Get all subscribers by ProjectGET

+

+

Get all subscribers by Project

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you would like to return from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you would need to skip. This is used in pagination

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorId (optional) + String +
    +
    +
    +
    +

    Set this value if you want to filter the results by Monitor

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

https://api.fyipe.com/subscriber/:projectId?skip=0&limit=10&api-key=XXX

+ +
+ +
+
+

Example Response (200)

+
+ 
+                                  
+                                    

+{
+  "subscribers" [{
+    "_id": "eb0c129e36753400Xfdbc46l"
+    "alertVia": ["sms", "email"],
+    "monitors": [{ 
+      _id: "Ab0c129e367534000fdbc46f", 
+      name: "Sample Monitor"
+    }],
+    "contactEmail":"my@email.com",
+    "contactPhone": "+1-510-751-0204",
+  }],
+  count:1,
+  skip:0,
+  limit:10
+}
+                                    
+                                    

+              
+                                  
+
+
+
+
+
+
+ +
+
+

Get all subscriber by Subscriber IDGET

+

+

Get all subscribers by Subscriber ID

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • + + + + + +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

https://api.fyipe.com/subscriber/:projectId/:subscriberId?api-key=XXX

+ +
+ +
+
+

Example Response (200)

+
+ 
+                                    
+                                      

+{
+  "_id": "eb0c129e36753400Xfdbc46l"
+  "alertVia": ["sms", "email"],
+  "monitors": [{ 
+    "_id": "Ab0c129e367534000fdbc46f", 
+    "name": "Sample Monitor"
+  }],
+  "contactEmail":"my@email.com",
+  "contactPhone": "+1-510-751-0204",
+}
+                                      
+                                      

+                
+                                    
+
+
+
+
+
+
+ + +
+
+

Update a subscriberPUT

+

+

Update a subscriber in the project.

+

+
+

Path

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

Body

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorIds + Array +
    +
    +
    +
    +

    Array of monitor Id or monitor names you want subscriber to subscribe to.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + contactEmail + String +
    +
    +
    +
    +

    Email of the subscriber

    +
    +
    +
    +
    • +
  • +
    +
    +
    + contactPhone + String +
    +
    +
    +
    +

    Phone Number of the Subscriber

    +
    +
    +
    +
    • +
  • +
    +
    +
    + alertVia + Array +
    +
    +
    +
    +

    How do you want the subscriber to be alerted. Can be any or all of these values ["call", "sms", + "email"]

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

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

+

Request Body

+ 
{
+  "alertVia": ["sms", "email"],
+  "monitorIds": ["Ab0c129e367534000fdbc46f"],
+  "contactEmail":"my@email.com",
+  "contactPhone": "+1-510-751-0204",
+}
+
+ +
+
+

Example Response (200)

+
+ 
+                                    
+                                      
{
+  "_id": "Xb0c129e367534000fdbc46f"
+  "alertVia": ["sms", "email"],
+  "monitors": [{ 
+    "_id": "Ab0c129e367534000fdbc46f", 
+    "name": "Sample Monitor"
+  }],
+  "contactEmail":"my@email.com",
+  "contactPhone": "+1-510-751-0204",
+
+}
+                                      

+                
+                                    
+
+
+
+
+
+
+ + +
+
+

Delete a subscriberDELETE

+

+

Delete a subscriber by Subscriber ID

+

+
+

Path

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

Query String

+
    + +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for your Fyipe Project

    +
    +
    +
    +
    • +
+
+
+ +
+ +
+
+

Example Request

+
+

https://api.fyipe.com/subscriber/:projectId/:subscriberId?api-key=XXX

+
+ +
+
+

Example Response (200)

+
+ 
+                                      
+                                        
{
+  "_id": "Xb0c129e367534000fdbc46f"
+  "alertVia": ["sms", "email"],
+  "monitors": [{ 
+    "_id": "Ab0c129e367534000fdbc46f", 
+    "name": "Sample Monitor"
+  }],
+  "contactEmail":"my@email.com",
+  "contactPhone": "+1-510-751-0204",
+
+}
+                                      

+                  
+                                      
+
+
+
+
+
+
+ + + + + + + +
+ +
+ +

Subscriber Alert

+ +

+

Subscriber Alert are alerts sent to your subscribers for monitors they have subscribed to. +

+

+ +
+

Path

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

Get all subscriber alerts by ProjectGET

+

+

Get all subscribers by Project

+

+
+

Path

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

Query String

+
    +
  • +
    +
    +
    + api-key + string +
    +
    +
    +
    +

    API Key for the project or sub project

    +
    +
    +
    +
    • +
  • +
    +
    +
    + limit + integer +
    +
    +
    +
    +

    Number of items you would like to return from the API.

    +
    +
    +
    +
    • +
  • +
    +
    +
    + skip + integer +
    +
    +
    +
    +

    Number of items you would need to skip. This is used in pagination

    +
    +
    +
    +
    • +
  • +
    +
    +
    + monitorId (optional) + String +
    +
    +
    +
    +

    Set this value if you want to filter the results by Monitor

    +
    +
    +
    +
    • +
+
+ +
+
+ +
+
+

Example Request

+
+

Request URL

+

https://api.fyipe.com/subscriberAlert/:projectId?skip=0&limit=10&api-key=XXX

+ +
+ +
+
+

Example Response (200)

+
+ 
+                                      
+                                        

+{
+  "subscriberAlerts" [
+    "_id": "qb0c129e36753400Xfdbc46P"
+    "alertVia": "call",
+    "status": "success"
+    "subscriber": {
+      "_id": "eb0c129e36753400Xfdbc46l"
+      "alertVia": ["sms", "email"],
+      "monitors": [{ 
+        "_id": "Ab0c129e367534000fdbc46f", 
+        "name": "Sample Monitor"
+      }],
+      "contactEmail":"my@email.com",
+      "contactPhone": "+1-510-751-0204",
+    }
+  }],
+  count:1,
+  skip:0,
+  limit:10
+}
+                                        
+                                        

+                  
+                                      
+
+
+
+
+
+
+ + + + + + + + + + + + +