ELS iSE-Cobra 4 API specification (1.9.4)

Download OpenAPI specification:Download

The ELS iSE-Cobra 4 service implements all iSE-Cobra 4 functions for GroupAlarm

Authentication

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

certificate

GetCertificate

Returns the requested certificate for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Responses

200

requested organization's certificate

400

unable to find organizationID

500

unexpected database error

get /certificate/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/certificate/{organizationID}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "caChain": "string",
  • "certificate": "string",
  • "organizationId": 0,
  • "privateKey": "string"
}

StoreCertificate

Store the given certificate for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Request Body schema: application/json
caChain
string
certificate
string
organizationId
integer <int64>
privateKey
string

Responses

200

successfully saved organization's certificate

400

unable to find organizationID

500

unexpected database error

put /certificate/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/certificate/{organizationID}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "caChain": "string",
  • "certificate": "string",
  • "organizationId": 0,
  • "privateKey": "string"
}

DeleteCertificate

Delete the certificate for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Responses

200

successfully deleted organization's certificate

400

unable to find organizationID

500

unexpected database error

delete /certificate/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/certificate/{organizationID}

credentials

GetCredentials

Returns all or the requested credentials for the given organizationID (and serviceName)

path Parameters
organizationID
required
int64

organization to query

query Parameters
serviceName
string

service name to query

Responses

200

requested organization's (service) credentials

400

unable to find organizationID or serviceName

500

unexpected database error

get /credentials/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/credentials/{organizationID}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "organizationId": 0,
  • "password": "string",
  • "serviceName": "string",
  • "url": "string",
  • "username": "string"
}

StoreCredentials

Store the given credentials for the given organizationID and serviceName

query Parameters
organizationID
required
int64

organization to query

serviceName
required
string

service name to query

Request Body schema: application/json
organizationId
integer <int64>
password
string
serviceName
string
url
string
username
string

Responses

200

successfully saved organization's service credentials

400

unable to find organizationID or serviceName

500

unexpected database error

put /credentials/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/credentials/{organizationID}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organizationId": 0,
  • "password": "string",
  • "serviceName": "string",
  • "url": "string",
  • "username": "string"
}

DeleteCredentials

Delete the login for the given organizationID and serviceName

query Parameters
organizationID
required
int64

organization to query

serviceName
required
string

service name to query

Responses

200

successfully deleted organization's service credentials

400

unable to find organizationID or serviceName

500

unexpected database error

delete /credentials/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/credentials/{organizationID}

keyword

GetKeywords

Returns the requested KeywordList for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Responses

200

requested organization's KeywordList

400

unable to find organizationID

500

unexpected database error

get /keyword/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/keyword/{organizationID}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "keywordScenarioList":
    [
    ],
  • "organizationId": 0
}

StoreKeywords

Store the given KeywordList for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Request Body schema: application/json
keywordScenarioList
Array of object (KeywordScenario)
organizationId
integer <int64>

Responses

200

successfully saved organization's KeywordList

400

unable to find organizationID

500

unexpected database error

put /keyword/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/keyword/{organizationID}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "keywordScenarioList":
    [
    ],
  • "organizationId": 0
}

DeleteKeywords

Delete the KeywordList for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Responses

200

successfully deleted organization's KeywordList

400

unable to find organizationID

500

unexpected database error

delete /keyword/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/keyword/{organizationID}

login

GetLogin

Returns the requested login for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Responses

200

requested organization's login

400

unable to find organizationID

500

unexpected database error

get /login/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/login/{organizationID}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "organizationId": 0,
  • "url": "string"
}

StoreLogin

Store the given login for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Request Body schema: application/json
organizationId
integer <int64>
url
string

Responses

200

successfully saved organization's login

400

unable to find organizationID

500

unexpected database error

put /login/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/login/{organizationID}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organizationId": 0,
  • "url": "string"
}

DeleteLogin

Delete the login for the given organizationID

path Parameters
organizationID
required
int64

organization to query

Responses

200

successfully deleted organization's login

400

unable to find organizationID

500

unexpected database error

delete /login/{organizationID}
https://app.groupalarm.com/api/v1/els-cobra/login/{organizationID}