Summary:
List, create or delete shared secret keys
URL:
http(s)://{server hostname}/api/webhook/cloudAlert/Meraki/secretKey?objectId={StormWorks object ID}[&serverId={server ID}]
objectId is the StormWorks ID of the Meraki Cloud Controller. You must provide a StormWorks object ID. serverId is an optional parameter.
Methods summary
- GET Method - list shared secret keys
- POST Method - create shared secret keys
- DELETE Method - delete shared secret keys
GET Method detail
Lists shared secret keys.
Response:
| Name | Description |
|---|---|
|
serverID |
the Entuity server ID string. |
| objectID | the StormWorks object ID of the Meraki device on the server. |
| name | the display name of the device in ENA. |
| stormWorksType | StormWorks type. |
| webhookURL | this is the URL that should be put in the settings of the cloud controller (using the Cisco website, not anything in ENA). |
| secretKeyIsSet | if the secret key is set. |
| sharedSecret | if the secret key is shared. |
| webhookEnabled | if the webhook is enabled. |
| status | this is the same as the status displayed in the ENA webhook admin page. |
| merakiDeviceCount | number of devices managed by the cloud controller. |
| secretKey | key that should be entered on the cloud controller settings page (same as the URL). |
Example:
INPUT
curl -u admin:admin https://localhost/api/webhook/cloudAlert/Meraki/secretKey?objectId=5073
OUTPUT
{
"serverId" : "9a55e715-3c18-4ef1-9cc9-f1b7f29ea139",
"objectId" : 5073,
"secretKey" : null
}
POST Method detail
Adds shared secret keys.
Response:
Same items as per GET Method above.
Example:
INPUT
curl -u admin:admin https://localhost/api/webhook/cloudAlert/Meraki/secretKey?objectId=5073 -X POST
OUTPUT
{
"serverId" : "9a55e715-3c18-4ef1-9cc9-f1b7f29ea139",
"objectId" : 5073,
"secretKey" : "bc6241ab-6481-4c5a-8d42-6369a199895c"
}
DELETE Method detail
Deletes shared secret keys.
Response:
Same items as per GET and POST Methods above.
Example:
INPUT
curl -u admin:admin https://localhost/api/webhook/cloudAlert/Meraki/secretKey?objectId=5073 -X DELETE
OUTPUT
{
"serverId" : "9a55e715-3c18-4ef1-9cc9-f1b7f29ea139",
"objectId" : 5073,
"secretKey" : ""
}
Comments
0 comments
Please sign in to leave a comment.