Instrument Image with Qualys Instrumentation

Once the instrumenter service is up and running in your environment, you can instrument your images. Note that you can only instrument images that have been scanned by a registry scan job (registry sensor). For this API endpoint, you’ll use the Container Security API. To learn more about using Container Security APIs, please refer to the Container Security API User Guide.

POST/csapi/v1.1/images/{imageId}/instrument

Input ParametersInput Parameters

Parameter Mandatory/Optional Data Type Description

imageId

Mandatory string

Specify the ID or SHA value of the image that you want to instrument.

pullRegistryUuid

 Optional string

The UUID of the registry where the image is located.

pullRepository

 Optional string

Name of the repository where the image is located.

pullTag

 Optional string

Tag associated with the image.

pushRegistryUuid

 Optional string

The UUID of the registry where you want to put the instrumented image.

pushRepository

 Optional string

Name of the repository where you want to put the instrumented image.

pushTag

 Optional string

Tag to be associated with the instrumented image.

SampleSample

API request

    curl -X POST 
"<qualys_base_url>/csapi/v1.1/images/b5e5ffb5cdea/instrument"
--header "Content-Type: application/json" 
--header "Accept: text/plain" 
--header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=" 
-d "{
"imageId": "b5e5ffb5cdea", 
"pullRegistryUuid": "44a38be9-5eaa-4062-9ee3-5c60c50b430f", 
"pullRepository": "centos", 
"pullTag": "6", 
"pushRegistryUuid": "44a38be9-5eaa-4062-9ee3-5c60c50b430f", 
"pushRepository": "centos", 
"pushTag": "6-1.2"
}" 

Response

    response code 200
    

 

 

Was this topic helpful?

success Thank you! We're glad to hear that this topic was useful.
success We appreciate your feedback. We'll work to make this topic better for you in the future.