AppInspect API

To use the AppInspect API, you send the Splunk app package in a POST request to the /v1/app/validate endpoint on appinspect.splunk.com. The JSON response contains the request ID. Then you send the request ID in a GET request to the /v1/app/validate/status/{request_id} endpoint on appinspect.splunk.com. The JSON response contains a detailed report of the checks run and their results.

Note: Within this section's examples, <auth_token> is a placeholder for an authorization token, and <app_package> is a placeholder for a Splunk app's package file (a .tgz file).

Including and excluding tags and header values

You can explicitly include and exclude tags from a validation by including additional options in your request. Specifically, including the included_tags and excluded_tags options will include and exclude, respectively, the tags you specify from a validation.

Use the max-messages header value to specify the number of results AppInspect returns. By default, AppInspect returns 25 results. You can set the value to any positive, non-zero integer or all to return all results.

See the following examples to learn how to use tags and header values:

GET /v1/app/validate/status/{request_id}

https://appinspect.splunk.com/v1/app/validate/status/{request_id}

Description

Returns the status of an in-process request using the request_id returned from an initial validation request (/v1/app/validate).Once the request is complete, this endpoint will return information for a limited time. Note that the app information in 'info' may change if multiple apps are submitted at once. For the full report use the /report/{request_id} endpoint.HTTP Method: GETAuthentication: Bearer token (JWT) obtained from splunk.com.Response Codes: 200, 401

GET /v1/app/validate/status/{request_id} method detail

Response keys

Key

Description

request_id

An alphanumeric string that uniquely identifies this request.

app_name

The name of the app as set in app.conf for the app currently being checked.

app_version

The version of the app as set in app.conf.

status

One of PENDING, PREPARING, PROCESSING, SUCCESS, or ERROR.

checks

False metadata about checks that have been run or are running in this current check. Pending checks are not listed.

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 »