ELS iSE-Cobra 4 API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)
Download OpenAPI specification:Download
The ELS iSE-Cobra 4 service implements all iSE-Cobra 4 functions for GroupAlarm
API_Token
To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name: | API-TOKEN |
Personal-Access-Token
To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name: | Personal-Access-Token |
StoreCertificate
Store the given certificate for the given organizationID
path Parameters
| organizationID required | integer organization to query |
Request Body schema: application/json
| caChain | string |
| certificate | string |
| organizationId | integer <int64> |
| privateKey | string |
Responses
Request samples
- Payload
{- "caChain": "string",
- "certificate": "string",
- "organizationId": 0,
- "privateKey": "string"
}GetCredentials
Returns all or the requested credentials for the given organizationID (and serviceName)
path Parameters
| organizationID required | integer organization to query |
query Parameters
| serviceName | string service name to query |
Responses
Response samples
- 200
{- "organizationId": 0,
- "password": "string",
- "serviceName": "string",
- "url": "string",
- "username": "string"
}StoreCredentials
Store the given credentials for the given organizationID and serviceName
path Parameters
| organizationID required | integer organization to query |
query Parameters
| serviceName required | string service name to query |
Request Body schema: application/json
| organizationId | integer <int64> |
| password | string |
| serviceName | string |
| url | string |
| username | string |
Responses
Request samples
- Payload
{- "organizationId": 0,
- "password": "string",
- "serviceName": "string",
- "url": "string",
- "username": "string"
}GetKeywords
Returns the requested KeywordList for the given organizationID
path Parameters
| organizationID required | integer organization to query |
Responses
Response samples
- 200
{- "keywordScenarioList": [
- {
- "keyword_1": "string",
- "keyword_2": "string",
- "priority": 0,
- "scenarioIds": [
- 0
], - "type_1": "string",
- "type_2": "string"
}
], - "organizationId": 0
}StoreKeywords
Store the given KeywordList for the given organizationID
path Parameters
| organizationID required | integer organization to query |
Request Body schema: application/json
Array of objects (KeywordScenario) [ items ] | |
| organizationId | integer <int64> |
Responses
Request samples
- Payload
{- "keywordScenarioList": [
- {
- "keyword_1": "string",
- "keyword_2": "string",
- "priority": 0,
- "scenarioIds": [
- 0
], - "type_1": "string",
- "type_2": "string"
}
], - "organizationId": 0
}StoreLogin
Store the given login for the given organizationID
path Parameters
| organizationID required | integer organization to query |
Request Body schema: application/json
| organizationId | integer <int64> |
| url | string |
Responses
Request samples
- Payload
{- "organizationId": 0,
- "url": "string"
}