Skip to content

Function and Rule Creation

Note

This guide will walk through the steps to configure custom functions and rules to process metrics from deployed sensors (including custom sensors) in the client tenant running in cloud. As of Release 2023.05.v01, the Pulse Platform also has a UI to create custom functions and rules.

Generating the API Security Token

All API endpoints to the Pulse Platform tenant for the client are secured using an API token that can be generated using the credentials to login to the Pulse Dashboard (emailid + password).

Use a REST client (ex: Postman/ARC/cURL) to initiate a request:

  1. Request Type: POST
  2. URI: (api-URL)/auth/login
  3. Request Body: 
    {
  "username": "<email-id>",
  "password": "<password>"
}
  4. Content-type: application/json
  5. Response (success): 
    {
  "orcas-token": "TOKEN"
}
  6. Response (failure): 
    {
  "error": "Invalid request"
}

Use the TOKEN from step 5. above to authenticate requests for API operations.

Expiry

TOKEN generated is expired in 8 hours from the time of creation

Usage

The API token generated needs to be sent as a Header Param to Rest API requests.

  • Security Header Param:
orcas-token: TOKEN