A2 API's

You can use to read & manage apps on A2. You can also use these API's to in-build in custom applications.

Following are available API Endpoint's:

A2 API - Get Secrets

Endpoint to get secret data like token and key for accessing API(s) is /api/v1/secrets as shown in example below:

        
        https://A2Portal/api/v1/secrets?user=[user]&password=[password]
        
        


A2 API - List App(s)

Endpoint to list App(s) is /api/v1/app/list as shown in example below:

        
        https://A2Portal/api/v1/app/list?user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/list?user=[user]&token=[token]&key=[key]
        
        


A2 API - List User(s)

Endpoint to list User(s) is /api/v1/user/list as shown in example below:

        
        https://A2Portal/api/v1/user/list?user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/user/list?user=[user]&token=[token]&key=[key]
        
        


A2 API - List Cert(s)

Endpoint to list Cert(s) is /api/v1/cert/list as shown in example below:

        
        https://A2Portal/api/v1/cert/list?user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/cert/list?user=[user]&token=[token]&key=[key]
        
        


A2 API - List RBAC

Endpoint to list RBAC is /api/v1/rbac/list as shown in example below:

        
        https://A2Portal/api/v1/rbac/list?user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/rbac/list?user=[user]&token=[token]&key=[key]
        
        


A2 API - Force Run App(s)

Endpoint to force run an existing app is /api/v1/app/action/force as shown in example below:

        
        https://A2Portal/api/v1/app/action/force?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/action/force?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Kill Running App(s)

Endpoint to terminate and running app is /api/v1/app/action/kill as shown in example below:

        
        https://A2Portal/api/v1/app/action/kill?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/action/kill?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Freeze App(s)

Endpoint to freeze an existing app is /api/v1/app/action/freeze as shown in example below:

        
        https://A2Portal/api/v1/app/action/freeze?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/action/freeze?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Update state to Success

Endpoint to update state to success of an existing app is /api/v1/app/action/updatestate/su as shown in example below:

        
        https://A2Portal/api/v1/app/action/updatestate/su?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/action/updatestate/su?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Update state to Fail

Endpoint to update state to fail of an existing app is /api/v1/app/action/updatestate/fa as shown in example below:

        
        https://A2Portal/api/v1/app/action/updatestate/fa?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/action/updatestate/fa?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Update state to Inactive

Endpoint to update state to inactive of an existing app is /api/v1/app/action/updatestate/in as shown in example below:

        
        https://A2Portal/api/v1/app/action/updatestate/in?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/action/updatestate/in?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Get App Definition

Endpoint to get an existing app definition is /api/v1/app/info/def as shown in example below:

        
        https://A2Portal/api/v1/app/info/def?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/info/def?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Get App Run History

Endpoint to get an existing app run history is /api/v1/app/info/runlog as shown in example below:

        
        https://A2Portal/api/v1/app/info/runlog?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app/info/runlog?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Get App Details

Endpoint to get an existing app complete run details, dependency tree and log files /api/v1/app as shown in example below:

        
        https://A2Portal/api/v1/app?app=[APP_NAME]&user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/app?app=[APP_NAME]&user=[user]&token=[token]&key=[key]
        
        


A2 API - Get Alerts

Endpoint to get A2 Alerts applicable to your App(s) /api/v1/alerts as shown in example below:

        
        https://A2Portal/api/v1/alerts?user=[user]&password=[password]
                                    or
        https://A2Portal/api/v1/alerts?user=[user]&token=[token]&key=[key]
        
        


A2 on GitHub

You may also wish to follow the GitHub project if you have a GitHub account. This is also where we keep the issue tracker for sharing bugs and feature ideas.