Authentication

Authentication is required with every API request by sending a header with your unique Access Token.

Step 1: Acquire An Access Token

To acquire an access token, send a POST request with your your username & password to:

Create a new user

POST https://api.interloopdata.com/login

Login with your Username & Password to acquire an access token.

Body

Name	Type	Description
username	string	Your username (likely your email address)
password	string	Your password (as plain text)

Response

200

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IktLQ1BOQTZaLUNXN21NV29NM...",
  "expires_in": 86400,
  "token_type": "Bearer"  
}

403

{
  "error": "Unathorized"
}

Copy the token provided in the response to be used in Step 2.

Step 2: Authenticate Your Requests

To make an authenticated request to your Interloop instance. Please include an Authorization header with your HTTP request with the following format Bearer <Token>

For instance, to return a list of Monitors from the Interloop API. You would make the following API CAll:

Find All Monitors

GET https://api.interloopdata.com/monitors

Returns a list of all Monitors.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

200

// RESPONSE TRUNCATED FOR READABILITY
[
  {
    "name": "Monitor Main Pipeline",
    "artifact_type": "Pipeline",
    "artifact_id": "d628fc9f-c34a-4ca9-9c13-bbe8cadcb675",
    "config": {},
    "status": "UP",
    "updated_on": "2024-09-01T14:17:46.000Z",
    "updated_by": "user|1234567890",
    "created_on": "2024-09-01T14:17:46.000Z",
    "created_by": "user|1234567890",
    "archived": false,
    "archived_on": false,
    "archived_by": "user|1234567890",
    "organization": "507f1f77bcf86cd799439011",
    "workspace": "507f1f77bcf86cd799439011",
    "description": "This monitor is used to...",
    "paused_on": "2024-09-01T14:17:46.000Z",
    "paused_by": "user|1234567890",
    "last_response": "2024-09-01T14:17:46.000Z"
  },
  ...
]

403

{
  "error": "Unauthorized"
}

Congratulations! 🎉 You have successfully retrieved data using the Interloop API.

To validate your are authenticated you can submit a GET Request to the /me endpoint

GET https://api.interloopdata.com/me

If authentication is successful, you will receive the User record associated with that Token.