About Integration
AppKeeper Integration is a service that allows to use the recovery function of AppKeeper by using the webhook event of the external service (third party monitoring tool) as a trigger.
AppKeeper Integration provides REST APIs for receiving the Webhook notification (HTTP request) from the external service and executing the AppKeeper function.
A function to generate a token used for API authentication is also provided.
By registering URL of the API and the token in the external service, AppKeeper functions can be executed in cooperation with the external service.
This document describes the API specifications and how to get API token.
Requirement
The followings are required.
- AWS account is registered with AppKeeper tenant
- AppKeeper has detected the target instance
- Monitoring setting for the target instance is On
- Monitoring status of AppKeeper is Running
If these conditions are not met, the API response will result in a 404 (Bad Request) error.
How to use APIs for integration
How to get API Token
- Login to the AppKeeper GUI and click the [Account Information] button.
- On the account information screen, click the [Get Token] button.
API Specifications
- Recovery
URL |
https://api.appkeeper.sios.com/v2/integration/{AWS Account ID}/actions/recover |
Method |
POST |
Header |
appkeeper-integration-token: <API Token> |
Request Body |
{ |
ex)
curl:
curl -X POST https://api.appkeeper.sios.com/v2/integration/{AWS Account ID}/actions/recover -H 'appkeeper-integration-token: <API Token>' -d '{ "instanceId": "<Instance ID>", "name": "<Service Name>"}'
Notes.
The token never expires. For this reason, please strictly manage it not to be leaked.
In case that the token is leaked, please invalidate the token by the following procedure from AppKeeper GUI.
- Login to the AppKeeper GUI and click the [Account Information] button.
- On the account information screen, click the [Disable token] button.
The last token refresh date of the token will be updated, and all tokens issued before that will be invalidated.
Comments
0 comments
Please sign in to leave a comment.