Obtaining a custom image manifest file

Kaspersky Research Sandbox provides an API to obtain a custom image manifest file that contains the operating system description and a list of required symbol files. These symbol files are required for correct custom image deployment.

Request

Request method: GET

Endpoint: https://<server name>/api/v1/sandbox/images/{id}/manifest

Parameters

Obtaining a custom image manifest parameters

Parameter

Data type

Occurrence

Description

id

integer

Required

ID of a template that failed to deploy, and for which you want to obtain a manifest file.

To obtain template IDs, run GET https://<server name>/api/v1/sandbox/images query. This method returns information about available custom images. Use the id field value as the request parameter.

You can also use the custom image ID from the error message as the id parameter value.

manifest file name

string

Required

Name of a manifest file to save results to (for example manifest.txt).

cURL command sample:

$ curl --http1.1 -X GET -u <user name> https://<server name>/api/v1/sandbox/images/<id>/manifest --output <manifest file name>

You will be asked to enter your password. The password is not displayed while you type it.

Responses

Endpoint returns a custom image manifest file that contains the operating system description and a list of required symbol files.

200 OK

A custom image manifest file is downloaded.

400 Bad Request

The custom image ID is specified incorrectly. Please enter the correct ID.

401 Unauthorized

Failed to obtain a custom image manifest file due to incorrect user credentials.

404 Not Found

The specified custom image has not been deployed yet and the manifest file does not exist. Please deploy a template first.

414 Request URI Too Long

Failed to obtain a custom image manifest file due to URL that is too long for the server to process.

500 Internal Server Error

Failed to obtain a custom image manifest file due to an internal server error.

Page top