API


Support Center

API SCOPE

Our API supports access to the following areas of Narmada:

  • QBR (aka health checks)
  • Clients
  • Tenants

 

API QUERIES

Complete list of available API queries is available here

https://api-us.narmada.cloud/index.html

 

CREATE API ROLE AND API USER

 

To limit the scope of the API user, you can create a new security role under Settings -> User Roles and disable all UI permissions

 

 

Create an new API user under Settings -> Users  and assign the API user role

 

 

 

Switch to the API Key tab where you can get the keys

 

 

 

INSTANCE INFO

US instance API endpoint

https://api-us.narmada.cloud

 

EU instance API endpoint

https://api-eu.narmada.cloud

 

SAMPLE POWER SHELL SCRIPTS

 

List Tenant info

 

============================================================

$headers = New-Object “System.Collections.Generic.Dictionary[[String],[String]]”

$headers.Add(“publickey”, “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”)

$headers.Add(“secretkey”, “xxxxxxxxxxxxxxxxxxxxxxxxxxxxx”)

 

$response = Invoke-RestMethod ‘https://api-us.narmada.cloud/api/master/tenants’ -Method ‘GET’ -Headers $headers

$response | ConvertTo-Json

============================================================

 

Add QBR

 

===================================================================================

$headers = New-Object “System.Collections.Generic.Dictionary[[String],[String]]”
$headers.Add(“publickey”, “XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”)
$headers.Add(“secretkey”, “XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”)
$headers.Add(“Content-Type”, “application/json”)

$body = “{
`n `”tenantId`”: 12,
`n `”clientId`”: 69,
`n `”area`”: `”`”,
`n `”subArea`”: `”`”,
`n `”currentStatus`”: `”`”,
`n `”currentStatusOptions`”: `”`”,
`n `”recommendation`”: `”`”,
`n `”recommendationOptions`”: `”`”,
`n `”clientDecision`”: `”`”,
`n `”clientDecisionOptions`”: `”`”,
`n `”reference`”: `”`”,
`n `”notes`”: `”`”,
`n `”weight`”: 0,
`n `”categoryIds`”: `”`”,
`n `”officeLocation`”: `”`”,
`n `”actionNeededBy`”: `”`”,
`n `”implementationStatusId`”: 1,
`n `”isReviewed`”: false,
`n `”reviewedDate`”: `”`”,
`n `”frequencyId`”: 0,
`n `”isPresented`”: false,
`n `”presentedDate`”: `”`”,
`n `”healthStatusId`”: 1,
`n `”securityRiskId`”: 1,
`n `”isRiskAccepted`”: false,
`n `”healthCheckTypeId`”: 1,
`n `”enableClientQuestionnaire`”: false,
`n `”trendsTopics`”: [
`n {
`n `”trendId`”: 0
`n }
`n ]
`n}”

$response = Invoke-RestMethod ‘https://api-us.narmada.cloud/api/qbr/add-qbr’ -Method ‘POST’ -Headers $headers -Body $body
$response | ConvertTo-Json

===================================================================================

 

Update QBR

 

===================================================================================

 

$headers = New-Object “System.Collections.Generic.Dictionary[[String],[String]]”
$headers.Add(“publickey”, “XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”)
$headers.Add(“secretkey”, “XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”)
$headers.Add(“Content-Type”, “application/json”)

$body = “{
`n `”tenantId`”: 12,
`n `”clientId`”: 69,
`n `”healthCheckId`”: 5827,
`n `”area`”: `”test`”,
`n `”subArea`”: `”`”,
`n `”currentStatus`”: `”`”,
`n `”currentStatusOptions`”: `”`”,
`n `”recommendation`”: `”`”,
`n `”recommendationOptions`”: `”`”,
`n `”clientDecision`”: `”`”,
`n `”clientDecisionOptions`”: `”`”,
`n `”reference`”: `”`”,
`n `”notes`”: `”`”,
`n `”weight`”: 0,
`n `”categoryIds`”: `”`”,
`n `”officeLocation`”: `”`”,
`n `”actionNeededBy`”: `”`”,
`n `”implementationStatusId`”: 1,
`n `”isReviewed`”: false,
`n `”reviewedDate`”: `”`”,
`n `”frequencyId`”: 0,
`n `”isPresented`”: false,
`n `”presentedDate`”: `”`”,
`n `”healthStatusId`”: 1,
`n `”securityRiskId`”: 1,
`n `”isRiskAccepted`”: false,
`n `”healthCheckTypeId`”: 1,
`n `”enableClientQuestionnaire`”: false,
`n `”trendsTopics`”: [
`n {
`n `”trendId`”: 0
`n }
`n ]
`n}”

$response = Invoke-RestMethod ‘https://api-us.narmada.cloud/api/qbr/update-qbr’ -Method ‘POST’ -Headers $headers -Body $body
$response | ConvertTo-Json

 

===================================================================================

Table of Contents