1. Authentication

You authenticate to the Splunk AppInspect API using HTTP basic authentication via a JSON Web token (JWT).
To obtain the JWT, you first send a GET request that contains your splunk.com user name and password to the login endpoint at api.splunk.com (https://api.splunk.com/2.0/reset/login/splunk), as shown in the following cURL request:

2. Submit an app

Next, you submit your app for validation by sending a POST request to the validation endpoint, or https://appinspect.splunk.com/v1/app/validate. The endpoint returns a request ID. You'll need this for the following two steps.

3. Retrieve the status

Now, retrieve the status of the validation to see its progress. Send a GET request to the status endpoint, or https://appinspect.splunk.com/v1/app/validate/status/{request_id}. {request_id} represents the request ID that was returned in the previous step. The endpoint returns status information. Once the status is completed, you can continue to the final step.

In response, you might get something like the following, which indicates the progress of the validation. In this case, the validation is still in progress:

4. Retrieve the report

When the status of the validation is completed, you can retrieve the validation report. Send a GET request to the report endpoint, or https://appinspect.splunk.com/v1/app/report/{request_id}. {request_id} is the same request ID that was returned in the submit step. You can instruct AppInspect whether to return the validation report in HTML (text/html) or JSON (application/json) format by setting the Content-Type. For example, the following requests a report in HTML:

Note: You will typically see only one report in the response. If the uploaded package contained sub-apps, or support apps included within the main app, a report will be included for the main app and for each sub-app. In this case, note that the first report in the response will always correspond to the main app.

Other actions

The AppInspect API includes other endpoints for such actions as listing reports and checks. For more information, see AppInspect REST API endpoint reference.

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website.
Learn more (including how to update your settings) here »