Vulnerability Advisor for IBM Cloud Container Registry

Vulnerability Advisor 4 for IBM Cloud Container Registry

Last updated: 2024-05-02

Introduction

Vulnerability Advisor checks the security status of container images that are provided by IBM, third parties, or added to your organization's registry namespace.

Vulnerability Advisor 4 introduces a different back-end scanning technology to Vulnerability Advisor 3, and includes some minor changes to the API.

Discontinued: Vulnerability Advisor version 3 is discontinued from 13 November 2023. For more information about how to update to version 4, see Vulnerability Advisor version 3 is being discontinued on 13 November 2023.

For more information about Vulnerability Advisor, see Managing image security with Vulnerability Advisor.

For more information about IBM Cloud® Container Registry, see About IBM Cloud Container Registry.

For more information about IBM Cloud Kubernetes Service, see Getting started with IBM Cloud Kubernetes Service.

SDKs

SDKs for Java, Node, Python, and Go are available for this API. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries.

The code examples on this tab use the client library that is provided for Node.js.

npm install @ibm-cloud/ibm-container-registry

GitHub

https://github.com/IBM/container-registry-node-sdk

The code examples on this tab use the client library that is provided for Go.

go get -u github.com/IBM/container-registry-go-sdk

GitHub

https://github.com/IBM/container-registry-go-sdk

The code examples on this tab use the client library that is provided for Python.

pip install --upgrade "ibm-container-registry"

GitHub

https://github.com/IBM/container-registry-python-sdk

The code examples on this tab use the client library that is provided for Java.

Gradle

compile group: 'com.ibm.cloud', name: 'vulnerability-advisor', version: '1.+'
Copy to clipboard

Maven

Maven installation instructions

GitHub

https://github.com/IBM/container-registry-java-sdk

Endpoint URL

The endpoint for the Vulnerability Advisor for IBM Cloud Container Registry API is in the format: https://<registry_dns_name>/va/api/v4 For example, the API endpoint for Dallas is: https://us.icr.io/va/api/v4 To find out about the available IBM Cloud Container Registry DNS names, see Regions.

Authentication

Access to IBM Cloud Container Registry and Vulnerability Advisor is controlled by using IBM Cloud Identity and Access Management (IAM), which provides a unified approach to managing user identities and access control across your IBM Cloud services and applications.

This API requires IBM Cloud Identity and Access Management (IAM) authentication. You must pass an IAM token in the Authorization header of the request. You can retrieve your IAM access token, which is prefixed with Bearer, by running the ibmcloud iam oauth-tokens command. You must also set the Account header to the unique ID for your IBM Cloud account. You can retrieve your Account ID by running the ibmcloud account show command.

To call each method, you must be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see Managing access for IBM Cloud Container Registry.

Auditing

You can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method. For more information about how to track IBM Cloud Container Registry activity, see Auditing the events for Container Registry.

For more information about IAM actions and Activity Tracker actions by API method, see IAM and Activity Tracker actions by API method.

Error handling

The Vulnerabiliy Advisor service uses standard HTTP response codes to indicate whether a method completed successfully.

A 200 response always indicates success.
A 400 type response indicates a bad request that you must change before retrying.
A 500 type response usually indicates an internal system error.

Vulnerability report status codes

The following table shows the vulnerability report status codes.

Table 1. Vulnerability report status codes
Code	Description
`OK`	No security issues were found in the image.
`FAIL`	The scan found one or more potential security issues or vulnerabilities in the image that are outside the scope of all exemptions.
`WARN`	The scan found one or more potential security issues or vulnerabilities in the image. However all of the issues are within the scope of one or more exemptions.
`UNSUPPORTED`	The scan found no supported operating system (OS) distribution and no active configuration issues in the image.
`INCOMPLETE`	The image is being scanned and the final vulnerability status is not determined.
`UNSCANNED`	A vulnerability assessment for the image could not be found.

Get the vulnerability assessment for the list of registry images that belong to a specific account.

GET /va/api/v4/report/account

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) AccountReportQueryPath(accountReportQueryPathOptions *AccountReportQueryPathOptions) (result *ScanReportList, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) AccountReportQueryPathWithContext(ctx context.Context, accountReportQueryPathOptions *AccountReportQueryPathOptions) (result *ScanReportList, response *core.DetailedResponse, err error)

accountReportQueryPath(params)

account_report_query_path(
        self,
        *,
        repository: str = None,
        include_ibm: str = None,
        include_private: str = None,
        **kwargs,
    ) -> DetailedResponse
Copy to clipboard

ServiceCall<ScanReportList> accountReportQueryPath(AccountReportQueryPathOptions accountReportQueryPathOptions)
Copy to clipboard

Request

Instantiate the AccountReportQueryPathOptions struct and set the fields to provide parameter values for the AccountReportQueryPath method.

Use the AccountReportQueryPathOptions.Builder to create a AccountReportQueryPathOptions object that contains the parameter values for the accountReportQueryPath method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Query Parameters

repository
string
The name of the repository that you want to see image vulnerability assessments for. For example, us.icr.io/namespace/image.
includeIBM
string
When set to true, the returned list contains IBM public images and the account images. If not set, or set to false, the list contains only the account images.
includePrivate
string
When set to false, the returned list does not contain the private account images. If not set, or set to true, the list contains the private account images.

parameter

WithContext method only

AccountReportQueryPathOptions

The AccountReportQueryPath options.

parameters

repository
string
The name of the repository that you want to see image vulnerability assessments for. For example, us.icr.io/namespace/image.
includeIbm
string
When set to true, the returned list contains IBM public images and the account images. If not set, or set to false, the list contains only the account images.
includePrivate
string
When set to false, the returned list does not contain the private account images. If not set, or set to true, the list contains the private account images.

parameters

repository
str
The name of the repository that you want to see image vulnerability assessments for. For example, us.icr.io/namespace/image.
include_ibm
str
When set to true, the returned list contains IBM public images and the account images. If not set, or set to false, the list contains only the account images.
include_private
str
When set to false, the returned list does not contain the private account images. If not set, or set to true, the list contains the private account images.

AccountReportQueryPathOptions

The accountReportQueryPath options.

Example request

accountReportQueryPathOptions := vulnerabilityAdvisorService.NewAccountReportQueryPathOptions()

accountReportQueryPathOptions.IncludePrivate = core.StringPtr("true")

scanReportList, response, err := vulnerabilityAdvisorService.AccountReportQueryPath(accountReportQueryPathOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(scanReportList, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

let res;
try {
  res = await vulnerabilityAdvisorService.accountReportQueryPath({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.account_report_query_path()
scan_report_list = response.get_result()

print(json.dumps(scan_report_list, indent=2))

Example request

AccountReportQueryPathOptions accountReportQueryPathOptions = new AccountReportQueryPathOptions.Builder()
  .build();

Response<ScanReportList> response = vulnerabilityAdvisorService.accountReportQueryPath(accountReportQueryPathOptions).execute();
ScanReportList scanReportList = response.getResult();

System.out.println(scanReportList);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/report/account'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

ScanReportList

Status Code

200
The returned list might contain unscanned results for images in your account that haven't yet been scanned. Try again later. If this issue persists, contact support for help; see https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatar
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

{
  "assessments": {
    "us.icr.io/birds/grebe:crested": {
      "id": "12345678-130f-423f-a521-16f787651234",
      "scan_time": 1594050648,
      "status": "UNSUPPORTED",
      "vulnerabilities": [],
      "configuration_issues": [],
      "os_distribution": {
        "distribution_id": "unknown"
      }
    },
    "us.icr.io/birds/woodpecker:green": {
      "id": "12345678-130f-423f-a521-16f787654321",
      "scan_time": 1594148866,
      "status": "WARN",
      "vulnerabilities": [
        {
          "cve_id": "CVE-2019-99999",
          "summary": "This is a CVE.",
          "cve_exempt": true,
          "exempt_status": "exempt",
          "security_notice_count": 1,
          "exempt_security_notice_count": 0,
          "total_security_notice_count": 1,
          "security_notices": [
            {
              "notice_id": "ALPINE-CVE-2019-99999",
              "notice": "",
              "references": [
                ""
              ],
              "notice_exempt": false,
              "summary": "This is a summary.",
              "vulnerable_packages": [
                {
                  "description": "Description of vulnerability to package",
                  "corrective_action": "Upgrade the offending package",
                  "fix_version": "0.0.1",
                  "installed_version": "0.0.0",
                  "package_name": "package"
                }
              ]
            }
          ]
        }
      ],
      "configuration_issues": [],
      "os_distribution": {
        "distribution_id": "alpine"
      }
    }
  }
}
Copy to clipboard

Success example

{
  "assessments": {
    "us.icr.io/birds/grebe:crested": {
      "id": "12345678-130f-423f-a521-16f787651234",
      "scan_time": 1594050648,
      "status": "UNSUPPORTED",
      "vulnerabilities": [],
      "configuration_issues": [],
      "os_distribution": {
        "distribution_id": "unknown"
      }
    },
    "us.icr.io/birds/woodpecker:green": {
      "id": "12345678-130f-423f-a521-16f787654321",
      "scan_time": 1594148866,
      "status": "WARN",
      "vulnerabilities": [
        {
          "cve_id": "CVE-2019-99999",
          "summary": "This is a CVE.",
          "cve_exempt": true,
          "exempt_status": "exempt",
          "security_notice_count": 1,
          "exempt_security_notice_count": 0,
          "total_security_notice_count": 1,
          "security_notices": [
            {
              "notice_id": "ALPINE-CVE-2019-99999",
              "notice": "",
              "references": [
                ""
              ],
              "notice_exempt": false,
              "summary": "This is a summary.",
              "vulnerable_packages": [
                {
                  "description": "Description of vulnerability to package",
                  "corrective_action": "Upgrade the offending package",
                  "fix_version": "0.0.1",
                  "installed_version": "0.0.0",
                  "package_name": "package"
                }
              ]
            }
          ]
        }
      ],
      "configuration_issues": [],
      "os_distribution": {
        "distribution_id": "alpine"
      }
    }
  }
}
Copy to clipboard

Get the vulnerability assessment status for the list of registry images that belong to a specific account.

GET /va/api/v4/report/account/status

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) AccountStatusQueryPath(accountStatusQueryPathOptions *AccountStatusQueryPathOptions) (result *ScanreportImageSummaryList, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) AccountStatusQueryPathWithContext(ctx context.Context, accountStatusQueryPathOptions *AccountStatusQueryPathOptions) (result *ScanreportImageSummaryList, response *core.DetailedResponse, err error)

accountStatusQueryPath(params)

account_status_query_path(
        self,
        *,
        repository: str = None,
        include_ibm: str = None,
        include_private: str = None,
        **kwargs,
    ) -> DetailedResponse
Copy to clipboard

ServiceCall<ScanreportImageSummaryList> accountStatusQueryPath(AccountStatusQueryPathOptions accountStatusQueryPathOptions)
Copy to clipboard

Request

Instantiate the AccountStatusQueryPathOptions struct and set the fields to provide parameter values for the AccountStatusQueryPath method.

Use the AccountStatusQueryPathOptions.Builder to create a AccountStatusQueryPathOptions object that contains the parameter values for the accountStatusQueryPath method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Query Parameters

repository
string
The name of the repository that you want to see image vulnerability assessments for. For example, us.icr.io/namespace/image.
includeIBM
string
When set to true, the returned list contains IBM public images and the account images. If not set, or set to false, the list contains only the account images.
includePrivate
string
When set to false, the returned list does not contain the private account images. If not set, or set to true, the list contains the private account images.

parameter

WithContext method only

AccountStatusQueryPathOptions

The AccountStatusQueryPath options.

parameters

repository
string
The name of the repository that you want to see image vulnerability assessments for. For example, us.icr.io/namespace/image.
includeIbm
string
When set to true, the returned list contains IBM public images and the account images. If not set, or set to false, the list contains only the account images.
includePrivate
string
When set to false, the returned list does not contain the private account images. If not set, or set to true, the list contains the private account images.

parameters

repository
str
The name of the repository that you want to see image vulnerability assessments for. For example, us.icr.io/namespace/image.
include_ibm
str
When set to true, the returned list contains IBM public images and the account images. If not set, or set to false, the list contains only the account images.
include_private
str
When set to false, the returned list does not contain the private account images. If not set, or set to true, the list contains the private account images.

AccountStatusQueryPathOptions

The accountStatusQueryPath options.

Example request

accountStatusQueryPathOptions := vulnerabilityAdvisorService.NewAccountStatusQueryPathOptions()

scanreportImageSummaryList, response, err := vulnerabilityAdvisorService.AccountStatusQueryPath(accountStatusQueryPathOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(scanreportImageSummaryList, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

let res;
try {
  res = await vulnerabilityAdvisorService.accountStatusQueryPath({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.account_status_query_path()
scanreport_image_summary_list = response.get_result()

print(json.dumps(scanreport_image_summary_list, indent=2))

Example request

AccountStatusQueryPathOptions accountStatusQueryPathOptions = new AccountStatusQueryPathOptions.Builder()
  .build();

Response<ScanreportImageSummaryList> response = vulnerabilityAdvisorService.accountStatusQueryPath(accountStatusQueryPathOptions).execute();
ScanreportImageSummaryList scanreportImageSummaryList = response.getResult();

System.out.println(scanreportImageSummaryList);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/report/account/status'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

scanreport.ImageSummaryList

Status Code

200
The returned list might contain unscanned results for images in your account that haven't yet been scanned. Try again later. If this issue persists, contact support for help; see https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatar
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

{
  "images": [
    {
      "name": "us.icr.io/birds/woodpecker:green",
      "created_time": 1515532258,
      "status": "FAIL",
      "scan_time": 1594031816,
      "issue_count": 2,
      "exempt_issue_count": 1,
      "vulnerability_count": 2,
      "exempt_vulnerability_count": 1,
      "configuration_issue_count": 0,
      "exempt_configuration_issue_count": 0
    },
    {
      "name": "us.icr.io/birds/grebe:crested",
      "created_time": 1546305670,
      "status": "UNSUPPORTED",
      "scan_time": 1594389126,
      "issue_count": 0,
      "exempt_issue_count": 0,
      "vulnerability_count": 0,
      "exempt_vulnerability_count": 0,
      "configuration_issue_count": 0,
      "exempt_configuration_issue_count": 0
    }
  ]
}
Copy to clipboard

Success example

{
  "images": [
    {
      "name": "us.icr.io/birds/woodpecker:green",
      "created_time": 1515532258,
      "status": "FAIL",
      "scan_time": 1594031816,
      "issue_count": 2,
      "exempt_issue_count": 1,
      "vulnerability_count": 2,
      "exempt_vulnerability_count": 1,
      "configuration_issue_count": 0,
      "exempt_configuration_issue_count": 0
    },
    {
      "name": "us.icr.io/birds/grebe:crested",
      "created_time": 1546305670,
      "status": "UNSUPPORTED",
      "scan_time": 1594389126,
      "issue_count": 0,
      "exempt_issue_count": 0,
      "vulnerability_count": 0,
      "exempt_vulnerability_count": 0,
      "configuration_issue_count": 0,
      "exempt_configuration_issue_count": 0
    }
  ]
}
Copy to clipboard

Get the vulnerability assessment for a registry image.

GET /va/api/v4/report/image/{name}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ImageReportQueryPath(imageReportQueryPathOptions *ImageReportQueryPathOptions) (result *ScanReport, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ImageReportQueryPathWithContext(ctx context.Context, imageReportQueryPathOptions *ImageReportQueryPathOptions) (result *ScanReport, response *core.DetailedResponse, err error)

imageReportQueryPath(params)

image_report_query_path(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<ScanReport> imageReportQueryPath(ImageReportQueryPathOptions imageReportQueryPathOptions)
Copy to clipboard

Request

Instantiate the ImageReportQueryPathOptions struct and set the fields to provide parameter values for the ImageReportQueryPath method.

Use the ImageReportQueryPathOptions.Builder to create a ImageReportQueryPathOptions object that contains the parameter values for the imageReportQueryPath method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

name
Required*
string
The name of the image. For example, us.icr.io/namespace/repository:tag

Possible values: Value must match regular expression .*

parameter

WithContext method only

ImageReportQueryPathOptions

The ImageReportQueryPath options.

parameters

name
Required*
string
The name of the image. For example, us.icr.io/namespace/repository:tag.

Possible values: Value must match regular expression /.*/

parameters

name
Required*
str
The name of the image. For example, us.icr.io/namespace/repository:tag.

Possible values: Value must match regular expression /.*/

ImageReportQueryPathOptions

The imageReportQueryPath options.

Example request

imageReportQueryPathOptions := vulnerabilityAdvisorService.NewImageReportQueryPathOptions(
  "image name",
)

scanReport, response, err := vulnerabilityAdvisorService.ImageReportQueryPath(imageReportQueryPathOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(scanReport, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  name: 'image name',
};

let res;
try {
  res = await vulnerabilityAdvisorService.imageReportQueryPath(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.image_report_query_path(
  name='image name',
)
scan_report = response.get_result()

print(json.dumps(scan_report, indent=2))
Copy to clipboard

Example request

ImageReportQueryPathOptions imageReportQueryPathOptions = new ImageReportQueryPathOptions.Builder()
  .name("image name")
  .build();

Response<ScanReport> response = vulnerabilityAdvisorService.imageReportQueryPath(imageReportQueryPathOptions).execute();
ScanReport scanReport = response.getResult();

System.out.println(scanReport);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/report/image/us.icr.io%2Fbirds%2Fwoodpecker%3Agreen'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

ScanReport

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
404
Your image hasn't been scanned yet. Try again later. If this issue persists, contact support for help; see https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatar
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

{
  "id": "12345678-130f-423f-a521-16f787654321",
  "scan_time": 1594148866,
  "status": "WARN",
  "vulnerabilities": [
    {
      "cve_id": "CVE-2019-99999",
      "summary": "This is a CVE.",
      "cve_exempt": true,
      "exempt_status": "exempt",
      "security_notice_count": 1,
      "exempt_security_notice_count": 0,
      "total_security_notice_count": 1,
      "security_notices": [
        {
          "notice_id": "DEBIAN-CVE-2019-99999",
          "notice": "",
          "references": [
            ""
          ],
          "notice_exempt": false,
          "summary": "This is a summary.",
          "vulnerable_packages": [
            {
              "description": "Description of vulnerability to package",
              "corrective_action": "Upgrade the offending package",
              "fix_version": "0.0.1",
              "installed_version": "0.0.0",
              "package_name": "package"
            }
          ]
        }
      ]
    }
  ],
  "configuration_issues": [],
  "os_distribution": {
    "distribution_id": "debian",
    "version_id": "11",
    "version_code_name": "bullseye"
  }
}
Copy to clipboard

Success example

{
  "id": "12345678-130f-423f-a521-16f787654321",
  "scan_time": 1594148866,
  "status": "WARN",
  "vulnerabilities": [
    {
      "cve_id": "CVE-2019-99999",
      "summary": "This is a CVE.",
      "cve_exempt": true,
      "exempt_status": "exempt",
      "security_notice_count": 1,
      "exempt_security_notice_count": 0,
      "total_security_notice_count": 1,
      "security_notices": [
        {
          "notice_id": "DEBIAN-CVE-2019-99999",
          "notice": "",
          "references": [
            ""
          ],
          "notice_exempt": false,
          "summary": "This is a summary.",
          "vulnerable_packages": [
            {
              "description": "Description of vulnerability to package",
              "corrective_action": "Upgrade the offending package",
              "fix_version": "0.0.1",
              "installed_version": "0.0.0",
              "package_name": "package"
            }
          ]
        }
      ]
    }
  ],
  "configuration_issues": [],
  "os_distribution": {
    "distribution_id": "debian",
    "version_id": "11",
    "version_code_name": "bullseye"
  }
}
Copy to clipboard

Get the overall vulnerability status for a registry image.

GET /va/api/v4/report/image/status/{name}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ImageStatusQueryPath(imageStatusQueryPathOptions *ImageStatusQueryPathOptions) (result *ScanreportSummary, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ImageStatusQueryPathWithContext(ctx context.Context, imageStatusQueryPathOptions *ImageStatusQueryPathOptions) (result *ScanreportSummary, response *core.DetailedResponse, err error)

imageStatusQueryPath(params)

image_status_query_path(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<ScanreportSummary> imageStatusQueryPath(ImageStatusQueryPathOptions imageStatusQueryPathOptions)
Copy to clipboard

Request

Instantiate the ImageStatusQueryPathOptions struct and set the fields to provide parameter values for the ImageStatusQueryPath method.

Use the ImageStatusQueryPathOptions.Builder to create a ImageStatusQueryPathOptions object that contains the parameter values for the imageStatusQueryPath method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

name
Required*
string
The name of the image. For example, us.icr.io/namespace/repository:tag.

Possible values: Value must match regular expression .*

parameter

WithContext method only

ImageStatusQueryPathOptions

The ImageStatusQueryPath options.

parameters

name
Required*
string
The name of the image. For example, us.icr.io/namespace/repository:tag.

Possible values: Value must match regular expression /.*/

parameters

name
Required*
str
The name of the image. For example, us.icr.io/namespace/repository:tag.

Possible values: Value must match regular expression /.*/

ImageStatusQueryPathOptions

The imageStatusQueryPath options.

Example request

imageStatusQueryPathOptions := vulnerabilityAdvisorService.NewImageStatusQueryPathOptions(
  "image name",
)

scanreportSummary, response, err := vulnerabilityAdvisorService.ImageStatusQueryPath(imageStatusQueryPathOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(scanreportSummary, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  name: 'image name',
};

let res;
try {
  res = await vulnerabilityAdvisorService.imageStatusQueryPath(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.image_status_query_path(
  name='image name',
)
scanreport_summary = response.get_result()

print(json.dumps(scanreport_summary, indent=2))
Copy to clipboard

Example request

ImageStatusQueryPathOptions imageStatusQueryPathOptions = new ImageStatusQueryPathOptions.Builder()
  .name("image name")
  .build();

Response<ScanreportSummary> response = vulnerabilityAdvisorService.imageStatusQueryPath(imageStatusQueryPathOptions).execute();
ScanreportSummary scanreportSummary = response.getResult();

System.out.println(scanreportSummary);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/report/image/status/us.icr.io%2Fbirds%2Fwoodpecker%3Agreen'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

scanreport.Summary

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
404
Your image hasn't been scanned yet. Try again later. If this issue persists, contact support for help; see https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatar
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

{
  "name": "us.icr.io/birds/woodpecker:green",
  "created_time": 1515532258,
  "status": "FAIL",
  "scan_time": 1594031816,
  "issue_count": 2,
  "exempt_issue_count": 1,
  "vulnerability_count": 2,
  "exempt_vulnerability_count": 1,
  "configuration_issue_count": 0,
  "exempt_configuration_issue_count": 0
}
Copy to clipboard

Success example

{
  "name": "us.icr.io/birds/woodpecker:green",
  "created_time": 1515532258,
  "status": "FAIL",
  "scan_time": 1594031816,
  "issue_count": 2,
  "exempt_issue_count": 1,
  "vulnerability_count": 2,
  "exempt_vulnerability_count": 1,
  "configuration_issue_count": 0,
  "exempt_configuration_issue_count": 0
}
Copy to clipboard

List the exemptions that are specified with account level scope.

GET /va/api/v4/exempt/image

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListExemptionAccount(listExemptionAccountOptions *ListExemptionAccountOptions) (result []Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListExemptionAccountWithContext(ctx context.Context, listExemptionAccountOptions *ListExemptionAccountOptions) (result []Exemption, response *core.DetailedResponse, err error)

listExemptionAccount(params)

list_exemption_account(
        self,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<List<Exemption>> listExemptionAccount(ListExemptionAccountOptions listExemptionAccountOptions)

Request

Instantiate the ListExemptionAccountOptions struct and set the fields to provide parameter values for the ListExemptionAccount method.

Use the ListExemptionAccountOptions.Builder to create a ListExemptionAccountOptions object that contains the parameter values for the listExemptionAccount method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

parameter

WithContext method only

parameters

Example request

listExemptionAccountOptions := vulnerabilityAdvisorService.NewListExemptionAccountOptions()

exemption, response, err := vulnerabilityAdvisorService.ListExemptionAccount(listExemptionAccountOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

let res;
try {
  res = await vulnerabilityAdvisorService.listExemptionAccount({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.list_exemption_account()
list_exemption = response.get_result()

print(json.dumps(list_exemption, indent=2))

Example request

ListExemptionAccountOptions listExemptionAccountOptions = new ListExemptionAccountOptions();

Response<List<Exemption>> response = vulnerabilityAdvisorService.listExemptionAccount(listExemptionAccountOptions).execute();
List<Exemption> listExemption = response.getResult();

System.out.println(listExemption);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/exempt/image'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response type: []Exemption

Response type: Exemption[]

Response type: List[Exemption]

Response type: List<Exemption>

Response Body

Exemption[]

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

[
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-99999",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
    "scope": {
      "scope_type": "image",
      "namespace": "",
      "repository": "",
      "tag": ""
    }
  }
]
Copy to clipboard

Success example

[
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-99999",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
    "scope": {
      "scope_type": "image",
      "namespace": "",
      "repository": "",
      "tag": ""
    }
  }
]
Copy to clipboard

Get details of an exemption that is specified with account level scope.

GET /va/api/v4/exempt/image/issue/{issueType}/{issueID}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) GetExemptionAccount(getExemptionAccountOptions *GetExemptionAccountOptions) (result *Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) GetExemptionAccountWithContext(ctx context.Context, getExemptionAccountOptions *GetExemptionAccountOptions) (result *Exemption, response *core.DetailedResponse, err error)

getExemptionAccount(params)

get_exemption_account(
        self,
        issue_type: str,
        issue_id: str,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<Exemption> getExemptionAccount(GetExemptionAccountOptions getExemptionAccountOptions)
Copy to clipboard

Request

Instantiate the GetExemptionAccountOptions struct and set the fields to provide parameter values for the GetExemptionAccount method.

Use the GetExemptionAccountOptions.Builder to create a GetExemptionAccountOptions object that contains the parameter values for the getExemptionAccount method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueID
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression .*

parameter

WithContext method only

GetExemptionAccountOptions

The GetExemptionAccount options.

parameters

issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueId
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

parameters

issue_type
Required*
str
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issue_id
Required*
str
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

GetExemptionAccountOptions

The getExemptionAccount options.

Example request

getExemptionAccountOptions := vulnerabilityAdvisorService.NewGetExemptionAccountOptions(
  "cve",
  "CVE-2020-0001",
)

exemption, response, err := vulnerabilityAdvisorService.GetExemptionAccount(getExemptionAccountOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  issueType: 'cve',
  issueId: 'CVE-2020-0001',
};

let res;
try {
  res = await vulnerabilityAdvisorService.getExemptionAccount(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.get_exemption_account(
  issue_type='cve',
  issue_id='CVE-2023-0001',
)
exemption = response.get_result()

print(json.dumps(exemption, indent=2))
Copy to clipboard

Example request

GetExemptionAccountOptions getExemptionAccountOptions = new GetExemptionAccountOptions.Builder()
  .issueType("cve")
  .issueId("CVE-2023-0001")
  .build();

Response<Exemption> response = vulnerabilityAdvisorService.getExemptionAccount(getExemptionAccountOptions).execute();
Exemption exemption = response.getResult();

System.out.println(exemption);
Copy to clipboard

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/exempt/image/issue/cve/CVE-2019-99999'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

Exemption

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

{
  "issue_type": "cve",
  "issue_id": "CVE-2019-99999",
  "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
  "scope": {
    "scope_type": "image",
    "namespace": "",
    "repository": "",
    "tag": ""
  }
}
Copy to clipboard

Success example

{
  "issue_type": "cve",
  "issue_id": "CVE-2019-99999",
  "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
  "scope": {
    "scope_type": "image",
    "namespace": "",
    "repository": "",
    "tag": ""
  }
}
Copy to clipboard

Create or update an exemption that is specified with account level scope.

POST /va/api/v4/exempt/image/issue/{issueType}/{issueID}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) CreateExemptionAccount(createExemptionAccountOptions *CreateExemptionAccountOptions) (result *Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) CreateExemptionAccountWithContext(ctx context.Context, createExemptionAccountOptions *CreateExemptionAccountOptions) (result *Exemption, response *core.DetailedResponse, err error)

createExemptionAccount(params)

create_exemption_account(
        self,
        issue_type: str,
        issue_id: str,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<Exemption> createExemptionAccount(CreateExemptionAccountOptions createExemptionAccountOptions)
Copy to clipboard

Request

Instantiate the CreateExemptionAccountOptions struct and set the fields to provide parameter values for the CreateExemptionAccount method.

Use the CreateExemptionAccountOptions.Builder to create a CreateExemptionAccountOptions object that contains the parameter values for the createExemptionAccount method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueID
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression .*

parameter

WithContext method only

CreateExemptionAccountOptions

The CreateExemptionAccount options.

parameters

issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueId
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

parameters

issue_type
Required*
str
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issue_id
Required*
str
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

CreateExemptionAccountOptions

The createExemptionAccount options.

Example request

createExemptionAccountOptions := vulnerabilityAdvisorService.NewCreateExemptionAccountOptions(
  "cve",
  "CVE-2020-0001",
)

exemption, response, err := vulnerabilityAdvisorService.CreateExemptionAccount(createExemptionAccountOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  issueType: 'cve',
  issueId: 'CVE-2020-0001',
};

let res;
try {
  res = await vulnerabilityAdvisorService.createExemptionAccount(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.create_exemption_account(
  issue_type='cve',
  issue_id='CVE-2023-0001',
)
exemption = response.get_result()

print(json.dumps(exemption, indent=2))
Copy to clipboard

Example request

CreateExemptionAccountOptions createExemptionAccountOptions = new CreateExemptionAccountOptions.Builder()
  .issueType("cve")
  .issueId("CVE-2023-0001")
  .build();

Response<Exemption> response = vulnerabilityAdvisorService.createExemptionAccount(createExemptionAccountOptions).execute();
Exemption exemption = response.getResult();

System.out.println(exemption);
Copy to clipboard

Example request

curl -X 'POST'   'https://icr.io/va/api/v4/exempt/image/issue/cve/CVE-2019-99999'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

Exemption

Status Code

201
Created
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 201

{
  "issue_type": "cve",
  "issue_id": "CVE-2019-99999",
  "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
  "scope": {
    "scope_type": "image",
    "namespace": "",
    "repository": "",
    "tag": ""
  }
}
Copy to clipboard

Success example

{
  "issue_type": "cve",
  "issue_id": "CVE-2019-99999",
  "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
  "scope": {
    "scope_type": "image",
    "namespace": "",
    "repository": "",
    "tag": ""
  }
}
Copy to clipboard

Delete an exemption that is specified with account level scope.

DELETE /va/api/v4/exempt/image/issue/{issueType}/{issueID}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) DeleteExemptionAccount(deleteExemptionAccountOptions *DeleteExemptionAccountOptions) (response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) DeleteExemptionAccountWithContext(ctx context.Context, deleteExemptionAccountOptions *DeleteExemptionAccountOptions) (response *core.DetailedResponse, err error)

deleteExemptionAccount(params)

delete_exemption_account(
        self,
        issue_type: str,
        issue_id: str,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<Void> deleteExemptionAccount(DeleteExemptionAccountOptions deleteExemptionAccountOptions)
Copy to clipboard

Request

Instantiate the DeleteExemptionAccountOptions struct and set the fields to provide parameter values for the DeleteExemptionAccount method.

Use the DeleteExemptionAccountOptions.Builder to create a DeleteExemptionAccountOptions object that contains the parameter values for the deleteExemptionAccount method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueID
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression .*

parameter

WithContext method only

DeleteExemptionAccountOptions

The DeleteExemptionAccount options.

parameters

issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueId
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

parameters

issue_type
Required*
str
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issue_id
Required*
str
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

DeleteExemptionAccountOptions

The deleteExemptionAccount options.

Example request

deleteExemptionAccountOptions := vulnerabilityAdvisorService.NewDeleteExemptionAccountOptions(
  "cve",
  "CVE-2020-0001",
)

response, err := vulnerabilityAdvisorService.DeleteExemptionAccount(deleteExemptionAccountOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 200 {
  fmt.Printf("\nUnexpected response status code received from DeleteExemptionAccount(): %d\n", response.StatusCode)
}
Copy to clipboard

Example request

const params = {
  issueType: 'cve',
  issueId: 'CVE-2020-0001',
};

try {
  await vulnerabilityAdvisorService.deleteExemptionAccount(params);
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.delete_exemption_account(
  issue_type='cve',
  issue_id='CVE-2023-0001',
)

Example request

DeleteExemptionAccountOptions deleteExemptionAccountOptions = new DeleteExemptionAccountOptions.Builder()
  .issueType("cve")
  .issueId("CVE-2023-0001")
  .build();

Response<Void> response = vulnerabilityAdvisorService.deleteExemptionAccount(deleteExemptionAccountOptions).execute();
Copy to clipboard

Example request

curl -X 'DELETE'   'https://icr.io/va/api/v4/exempt/image/issue/cve/CVE-2019-99999'   -H 'Authorization: Bearer <bearer_token>'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
404
Exemption not found.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

No Sample Response

This method does not specify any sample responses.

List the exemptions that are specified for a resource (account, registry namespace, repository, or image).

GET /va/api/v4/exempt/image/{resource}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListExemptionResource(listExemptionResourceOptions *ListExemptionResourceOptions) (result []Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListExemptionResourceWithContext(ctx context.Context, listExemptionResourceOptions *ListExemptionResourceOptions) (result []Exemption, response *core.DetailedResponse, err error)

listExemptionResource(params)

list_exemption_resource(
        self,
        resource: str,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<List<Exemption>> listExemptionResource(ListExemptionResourceOptions listExemptionResourceOptions)

Request

Instantiate the ListExemptionResourceOptions struct and set the fields to provide parameter values for the ListExemptionResource method.

Use the ListExemptionResourceOptions.Builder to create a ListExemptionResourceOptions object that contains the parameter values for the listExemptionResource method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash)

Possible values: Value must match regular expression .*

parameter

WithContext method only

ListExemptionResourceOptions

The ListExemptionResource options.

parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/

parameters

resource
Required*
str
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/

ListExemptionResourceOptions

The listExemptionResource options.

Example request

listExemptionResourceOptions := vulnerabilityAdvisorService.NewListExemptionResourceOptions(
  "image name",
)

exemption, response, err := vulnerabilityAdvisorService.ListExemptionResource(listExemptionResourceOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  resource: 'image name',
};

let res;
try {
  res = await vulnerabilityAdvisorService.listExemptionResource(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.list_exemption_resource(
  resource='image name',
)
list_exemption = response.get_result()

print(json.dumps(list_exemption, indent=2))
Copy to clipboard

Example request

ListExemptionResourceOptions listExemptionResourceOptions = new ListExemptionResourceOptions.Builder()
  .resource("image name")
  .build();

Response<List<Exemption>> response = vulnerabilityAdvisorService.listExemptionResource(listExemptionResourceOptions).execute();
List<Exemption> listExemption = response.getResult();

System.out.println(listExemption);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/exempt/image/birds'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response type: []Exemption

Response type: Exemption[]

Response type: List[Exemption]

Response type: List<Exemption>

Response Body

Exemption[]

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

[
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-99999",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
    "scope": {
      "scope_type": "image",
      "namespace": "birds",
      "repository": "",
      "tag": ""
    }
  }
]
Copy to clipboard

Success example

[
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-99999",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
    "scope": {
      "scope_type": "image",
      "namespace": "birds",
      "repository": "",
      "tag": ""
    }
  }
]
Copy to clipboard

Get an exemption that is specified for a resource (account, registry namespace, repository, or image).

GET /va/api/v4/exempt/image/{resource}/issue/{issueType}/{issueID}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) GetExemptionResource(getExemptionResourceOptions *GetExemptionResourceOptions) (result *Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) GetExemptionResourceWithContext(ctx context.Context, getExemptionResourceOptions *GetExemptionResourceOptions) (result *Exemption, response *core.DetailedResponse, err error)

getExemptionResource(params)

get_exemption_resource(
        self,
        resource: str,
        issue_type: str,
        issue_id: str,
        **kwargs,
    ) -> DetailedResponse
Copy to clipboard

ServiceCall<Exemption> getExemptionResource(GetExemptionResourceOptions getExemptionResourceOptions)
Copy to clipboard

Request

Instantiate the GetExemptionResourceOptions struct and set the fields to provide parameter values for the GetExemptionResource method.

Use the GetExemptionResourceOptions.Builder to create a GetExemptionResourceOptions object that contains the parameter values for the getExemptionResource method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash)

Possible values: Value must match regular expression .*
issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueID
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression .*

parameter

WithContext method only

GetExemptionResourceOptions

The GetExemptionResource options.

parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/
issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueId
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

parameters

resource
Required*
str
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/
issue_type
Required*
str
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issue_id
Required*
str
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

GetExemptionResourceOptions

The getExemptionResource options.

Example request

getExemptionResourceOptions := vulnerabilityAdvisorService.NewGetExemptionResourceOptions(
  "cve",
  "CVE-2020-0001",
  "image name",
)

exemption, response, err := vulnerabilityAdvisorService.GetExemptionResource(getExemptionResourceOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  resource: 'image name',
  issueType: 'cve',
  issueId: 'CVE-2020-0001',
};

let res;
try {
  res = await vulnerabilityAdvisorService.getExemptionResource(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.get_exemption_resource(
  resource='image name',
  issue_type='cve',
  issue_id='CVE-2023-0001',
)
exemption = response.get_result()

print(json.dumps(exemption, indent=2))
Copy to clipboard

Example request

GetExemptionResourceOptions getExemptionResourceOptions = new GetExemptionResourceOptions.Builder()
  .resource("image name")
  .issueType("cve")
  .issueId("CVE-2023-0001")
  .build();

Response<Exemption> response = vulnerabilityAdvisorService.getExemptionResource(getExemptionResourceOptions).execute();
Exemption exemption = response.getResult();

System.out.println(exemption);
Copy to clipboard

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/exempt/image/birds/issue/cve/CVE-2019-99999'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

Exemption

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

{
  "issue_type": "cve",
  "issue_id": "CVE-2019-99999",
  "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
  "scope": {
    "scope_type": "image",
    "namespace": "birds",
    "repository": "",
    "tag": ""
  }
}
Copy to clipboard

Success example

{
  "issue_type": "cve",
  "issue_id": "CVE-2019-99999",
  "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
  "scope": {
    "scope_type": "image",
    "namespace": "birds",
    "repository": "",
    "tag": ""
  }
}
Copy to clipboard

Create or update an exemption that is specified for a resource (account, registry namespace, repository, or image).

POST /va/api/v4/exempt/image/{resource}/issue/{issueType}/{issueID}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) CreateExemptionResource(createExemptionResourceOptions *CreateExemptionResourceOptions) (result *Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) CreateExemptionResourceWithContext(ctx context.Context, createExemptionResourceOptions *CreateExemptionResourceOptions) (result *Exemption, response *core.DetailedResponse, err error)

createExemptionResource(params)

create_exemption_resource(
        self,
        resource: str,
        issue_type: str,
        issue_id: str,
        **kwargs,
    ) -> DetailedResponse
Copy to clipboard

ServiceCall<Exemption> createExemptionResource(CreateExemptionResourceOptions createExemptionResourceOptions)
Copy to clipboard

Request

Instantiate the CreateExemptionResourceOptions struct and set the fields to provide parameter values for the CreateExemptionResource method.

Use the CreateExemptionResourceOptions.Builder to create a CreateExemptionResourceOptions object that contains the parameter values for the createExemptionResource method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash)

Possible values: Value must match regular expression .*
issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueID
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression .*

parameter

WithContext method only

CreateExemptionResourceOptions

The CreateExemptionResource options.

parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/
issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueId
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

parameters

resource
Required*
str
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/
issue_type
Required*
str
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issue_id
Required*
str
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

CreateExemptionResourceOptions

The createExemptionResource options.

Example request

createExemptionResourceOptions := vulnerabilityAdvisorService.NewCreateExemptionResourceOptions(
  "cve",
  "CVE-2020-0001",
  "image name",
)

exemption, response, err := vulnerabilityAdvisorService.CreateExemptionResource(createExemptionResourceOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  resource: 'image name',
  issueType: 'cve',
  issueId: 'CVE-2020-0001',
};

let res;
try {
  res = await vulnerabilityAdvisorService.createExemptionResource(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.create_exemption_resource(
  resource='image name',
  issue_type='cve',
  issue_id='CVE-2023-0001',
)
exemption = response.get_result()

print(json.dumps(exemption, indent=2))
Copy to clipboard

Example request

CreateExemptionResourceOptions createExemptionResourceOptions = new CreateExemptionResourceOptions.Builder()
  .resource("image name")
  .issueType("cve")
  .issueId("CVE-2023-0001")
  .build();

Response<Exemption> response = vulnerabilityAdvisorService.createExemptionResource(createExemptionResourceOptions).execute();
Exemption exemption = response.getResult();

System.out.println(exemption);
Copy to clipboard

Example request

curl -X 'POST'   'https://icr.io/va/api/v4/exempt/image/birds/issue/cve/CVE-2019-99999'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

Exemption

Status Code

201
Created
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 201

{
  "issue_type": "cve",
  "issue_id": "CVE-2019-99999",
  "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
  "scope": {
    "scope_type": "image",
    "namespace": "birds",
    "repository": "",
    "tag": ""
  }
}
Copy to clipboard

Success example

{
  "issue_type": "cve",
  "issue_id": "CVE-2019-99999",
  "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
  "scope": {
    "scope_type": "image",
    "namespace": "birds",
    "repository": "",
    "tag": ""
  }
}
Copy to clipboard

Delete an exemption that is specified for a resource (account, registry namespace, repository, or image).

DELETE /va/api/v4/exempt/image/{resource}/issue/{issueType}/{issueID}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) DeleteExemptionResource(deleteExemptionResourceOptions *DeleteExemptionResourceOptions) (response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) DeleteExemptionResourceWithContext(ctx context.Context, deleteExemptionResourceOptions *DeleteExemptionResourceOptions) (response *core.DetailedResponse, err error)

deleteExemptionResource(params)

delete_exemption_resource(
        self,
        resource: str,
        issue_type: str,
        issue_id: str,
        **kwargs,
    ) -> DetailedResponse
Copy to clipboard

ServiceCall<Void> deleteExemptionResource(DeleteExemptionResourceOptions deleteExemptionResourceOptions)
Copy to clipboard

Request

Instantiate the DeleteExemptionResourceOptions struct and set the fields to provide parameter values for the DeleteExemptionResource method.

Use the DeleteExemptionResourceOptions.Builder to create a DeleteExemptionResourceOptions object that contains the parameter values for the deleteExemptionResource method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash)

Possible values: Value must match regular expression .*
issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueID
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression .*

parameter

WithContext method only

DeleteExemptionResourceOptions

The DeleteExemptionResource options.

parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/
issueType
Required*
string
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issueId
Required*
string
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

parameters

resource
Required*
str
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/
issue_type
Required*
str
Exemption type, e.g. 'cve' or 'sn' or 'configuration'. See /va/api/v4/exempt/types for more details.
issue_id
Required*
str
Exemption ID, e.g. 'CVE-2018-9999'. See /va/api/v4/exempt/types for more details.

Possible values: Value must match regular expression /.*/

DeleteExemptionResourceOptions

The deleteExemptionResource options.

Example request

deleteExemptionResourceOptions := vulnerabilityAdvisorService.NewDeleteExemptionResourceOptions(
  "cve",
  "CVE-2020-0001",
  "image name",
)

response, err := vulnerabilityAdvisorService.DeleteExemptionResource(deleteExemptionResourceOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 200 {
  fmt.Printf("\nUnexpected response status code received from DeleteExemptionResource(): %d\n", response.StatusCode)
}
Copy to clipboard

Example request

const params = {
  resource: 'image name',
  issueType: 'cve',
  issueId: 'CVE-2020-0001',
};

try {
  await vulnerabilityAdvisorService.deleteExemptionResource(params);
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.delete_exemption_resource(
  resource='image name',
  issue_type='cve',
  issue_id='CVE-2023-0001',
)
Copy to clipboard

Example request

DeleteExemptionResourceOptions deleteExemptionResourceOptions = new DeleteExemptionResourceOptions.Builder()
  .resource("image name")
  .issueType("cve")
  .issueId("CVE-2023-0001")
  .build();

Response<Void> response = vulnerabilityAdvisorService.deleteExemptionResource(deleteExemptionResourceOptions).execute();
Copy to clipboard

Example request

curl -X 'DELETE'   'https://icr.io/va/api/v4/exempt/image/birds/issue/cve/CVE-2019-99999'   -H 'Authorization: Bearer <bearer_token>'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
404
Exemption not found.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

No Sample Response

This method does not specify any sample responses.

List the types of exemption.

GET /va/api/v4/exempt/types

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ExemptHandler(exemptHandlerOptions *ExemptHandlerOptions) (result []ExemptionTypeInfo, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ExemptHandlerWithContext(ctx context.Context, exemptHandlerOptions *ExemptHandlerOptions) (result []ExemptionTypeInfo, response *core.DetailedResponse, err error)

exemptHandler(params)

exempt_handler(
        self,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<List<ExemptionTypeInfo>> exemptHandler(ExemptHandlerOptions exemptHandlerOptions)

Request

Instantiate the ExemptHandlerOptions struct and set the fields to provide parameter values for the ExemptHandler method.

Use the ExemptHandlerOptions.Builder to create a ExemptHandlerOptions object that contains the parameter values for the exemptHandler method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

parameter

WithContext method only

parameters

Example request

exemptHandlerOptions := vulnerabilityAdvisorService.NewExemptHandlerOptions()

exemptionTypeInfo, response, err := vulnerabilityAdvisorService.ExemptHandler(exemptHandlerOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemptionTypeInfo, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

let res;
try {
  res = await vulnerabilityAdvisorService.exemptHandler({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.exempt_handler()
list_exemption_type_info = response.get_result()

print(json.dumps(list_exemption_type_info, indent=2))

Example request

ExemptHandlerOptions exemptHandlerOptions = new ExemptHandlerOptions();

Response<List<ExemptionTypeInfo>> response = vulnerabilityAdvisorService.exemptHandler(exemptHandlerOptions).execute();
List<ExemptionTypeInfo> listExemptionTypeInfo = response.getResult();

System.out.println(listExemptionTypeInfo);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/exempt/types'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response type: []ExemptionTypeInfo

Response type: ExemptionTypeInfo[]

Response type: List[ExemptionTypeInfo]

Response type: List<ExemptionTypeInfo>

Response Body

exemption.TypeInfo[]

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

[
  {
    "identifier": "cve",
    "display_name": "CVE",
    "validation_regex": "^(?:CVE-(?:\\d){4}-(?:\\d){4,})$"
  },
  {
    "identifier": "sn",
    "display_name": "Security Notice",
    "validation_regex": "^(?:(?:RHSA-(?:\\d){4}:(?:\\d){4})|(?:DSA-(?:\\d){3,}-(?:\\d){1,})|(?:usn-(?:\\d){1,}-(?:\\d){1,})|(?:ALPINE-(?:CVE-(?:\\d){4}-(?:\\d){4,})))$"
  },
  {
    "identifier": "configuration",
    "display_name": "Configuration Issue",
    "validation_regex": "^(?:(?:system_configuration:Linux\\.(?:\\d){1,2}-\\d-[a-z])|(?:application_configuration:(?:(?:[a-zA-Z/](?:(?:(?:[a-zA-Z0-9-_/])+)?[a-zA-Z0-9])?)(?:\\.(?:[a-zA-Z/](?:(?:(?:[a-zA-Z0-9-_/])+)?[a-zA-Z0-9])?))+)))$"
  }
]
Copy to clipboard

Success example

[
  {
    "identifier": "cve",
    "display_name": "CVE",
    "validation_regex": "^(?:CVE-(?:\\d){4}-(?:\\d){4,})$"
  },
  {
    "identifier": "sn",
    "display_name": "Security Notice",
    "validation_regex": "^(?:(?:RHSA-(?:\\d){4}:(?:\\d){4})|(?:DSA-(?:\\d){3,}-(?:\\d){1,})|(?:usn-(?:\\d){1,}-(?:\\d){1,})|(?:ALPINE-(?:CVE-(?:\\d){4}-(?:\\d){4,})))$"
  },
  {
    "identifier": "configuration",
    "display_name": "Configuration Issue",
    "validation_regex": "^(?:(?:system_configuration:Linux\\.(?:\\d){1,2}-\\d-[a-z])|(?:application_configuration:(?:(?:[a-zA-Z/](?:(?:(?:[a-zA-Z0-9-_/])+)?[a-zA-Z0-9])?)(?:\\.(?:[a-zA-Z/](?:(?:(?:[a-zA-Z0-9-_/])+)?[a-zA-Z0-9])?))+)))$"
  }
]
Copy to clipboard

List all of the exemptions in the given account.

GET /va/api/v4/exemptions/account

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListAccountExemptions(listAccountExemptionsOptions *ListAccountExemptionsOptions) (result []Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListAccountExemptionsWithContext(ctx context.Context, listAccountExemptionsOptions *ListAccountExemptionsOptions) (result []Exemption, response *core.DetailedResponse, err error)

listAccountExemptions(params)

list_account_exemptions(
        self,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<List<Exemption>> listAccountExemptions(ListAccountExemptionsOptions listAccountExemptionsOptions)

Request

Instantiate the ListAccountExemptionsOptions struct and set the fields to provide parameter values for the ListAccountExemptions method.

Use the ListAccountExemptionsOptions.Builder to create a ListAccountExemptionsOptions object that contains the parameter values for the listAccountExemptions method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

parameter

WithContext method only

parameters

Example request

listAccountExemptionsOptions := vulnerabilityAdvisorService.NewListAccountExemptionsOptions()

exemption, response, err := vulnerabilityAdvisorService.ListAccountExemptions(listAccountExemptionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

let res;
try {
  res = await vulnerabilityAdvisorService.listAccountExemptions({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.list_account_exemptions()
list_exemption = response.get_result()

print(json.dumps(list_exemption, indent=2))

Example request

ListAccountExemptionsOptions listAccountExemptionsOptions = new ListAccountExemptionsOptions();

Response<List<Exemption>> response = vulnerabilityAdvisorService.listAccountExemptions(listAccountExemptionsOptions).execute();
List<Exemption> listExemption = response.getResult();

System.out.println(listExemption);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/exemptions/account'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response type: []Exemption

Response type: Exemption[]

Response type: List[Exemption]

Response type: List<Exemption>

Response Body

Exemption[]

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

[
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-99999",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
    "scope": {
      "scope_type": "image",
      "namespace": "",
      "repository": "",
      "tag": ""
    }
  },
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-11111",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
    "scope": {
      "scope_type": "image",
      "namespace": "birds",
      "repository": "",
      "tag": ""
    }
  }
]
Copy to clipboard

Success example

[
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-99999",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
    "scope": {
      "scope_type": "image",
      "namespace": "",
      "repository": "",
      "tag": ""
    }
  },
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-11111",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff",
    "scope": {
      "scope_type": "image",
      "namespace": "birds",
      "repository": "",
      "tag": ""
    }
  }
]
Copy to clipboard

Delete all of the exemptions in the given account.

POST /va/api/v4/exemptions/deleteAll

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ExemptionsAccountDeleteHandler(exemptionsAccountDeleteHandlerOptions *ExemptionsAccountDeleteHandlerOptions) (result *ExemptionDeletionInfo, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ExemptionsAccountDeleteHandlerWithContext(ctx context.Context, exemptionsAccountDeleteHandlerOptions *ExemptionsAccountDeleteHandlerOptions) (result *ExemptionDeletionInfo, response *core.DetailedResponse, err error)

exemptionsAccountDeleteHandler(params)

exemptions_account_delete_handler(
        self,
        **kwargs,
    ) -> DetailedResponse

ServiceCall<ExemptionDeletionInfo> exemptionsAccountDeleteHandler(ExemptionsAccountDeleteHandlerOptions exemptionsAccountDeleteHandlerOptions)
Copy to clipboard

Request

Instantiate the ExemptionsAccountDeleteHandlerOptions struct and set the fields to provide parameter values for the ExemptionsAccountDeleteHandler method.

Use the ExemptionsAccountDeleteHandlerOptions.Builder to create a ExemptionsAccountDeleteHandlerOptions object that contains the parameter values for the exemptionsAccountDeleteHandler method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

parameter

WithContext method only

parameters

Example request

exemptionsAccountDeleteHandlerOptions := vulnerabilityAdvisorService.NewExemptionsAccountDeleteHandlerOptions()

exemptionDeletionInfo, response, err := vulnerabilityAdvisorService.ExemptionsAccountDeleteHandler(exemptionsAccountDeleteHandlerOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemptionDeletionInfo, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

let res;
try {
  res = await vulnerabilityAdvisorService.exemptionsAccountDeleteHandler({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.exemptions_account_delete_handler()
exemption_deletion_info = response.get_result()

print(json.dumps(exemption_deletion_info, indent=2))

Example request

ExemptionsAccountDeleteHandlerOptions exemptionsAccountDeleteHandlerOptions = new ExemptionsAccountDeleteHandlerOptions();

Response<ExemptionDeletionInfo> response = vulnerabilityAdvisorService.exemptionsAccountDeleteHandler(exemptionsAccountDeleteHandlerOptions).execute();
ExemptionDeletionInfo exemptionDeletionInfo = response.getResult();

System.out.println(exemptionDeletionInfo);

Example request

curl -X 'POST'   'https://icr.io/va/api/v4/exemptions/deleteAll'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response Body

exemption.DeletionInfo

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

{ "number_of_exemptions_deleted": 2 }
{ "number_of_exemptions_deleted": 2 }

List all of the exemptions for an image.

GET /va/api/v4/exemptions/image/{resource}

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListImageExemptions(listImageExemptionsOptions *ListImageExemptionsOptions) (result []Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListImageExemptionsWithContext(ctx context.Context, listImageExemptionsOptions *ListImageExemptionsOptions) (result []Exemption, response *core.DetailedResponse, err error)

listImageExemptions(params)

list_image_exemptions(
        self,
        resource: str,
        *,
        include_scope: bool = None,
        **kwargs,
    ) -> DetailedResponse
Copy to clipboard

ServiceCall<List<Exemption>> listImageExemptions(ListImageExemptionsOptions listImageExemptionsOptions)

Request

Instantiate the ListImageExemptionsOptions struct and set the fields to provide parameter values for the ListImageExemptions method.

Use the ListImageExemptionsOptions.Builder to create a ListImageExemptionsOptions object that contains the parameter values for the listImageExemptions method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Path Parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash)

Possible values: Value must match regular expression .*

Query Parameters

includeScope
boolean
Include scope on returned exemptions

Default: false

parameter

WithContext method only

ListImageExemptionsOptions

The ListImageExemptions options.

parameters

resource
Required*
string
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/
includeScope
boolean
Include scope on returned exemptions.

Default: false

parameters

resource
Required*
str
IBM Cloud Registry resource (namespace, namespace/repository, namespace/repository:tag, or namespace/repository@sha256:hash).

Possible values: Value must match regular expression /.*/
include_scope
bool
Include scope on returned exemptions.

Default: false

ListImageExemptionsOptions

The listImageExemptions options.

Example request

listImageExemptionsOptions := vulnerabilityAdvisorService.NewListImageExemptionsOptions(
  "image name",
)

exemption, response, err := vulnerabilityAdvisorService.ListImageExemptions(listImageExemptionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(exemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  resource: 'image name',
};

let res;
try {
  res = await vulnerabilityAdvisorService.listImageExemptions(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.list_image_exemptions(
  resource='image name',
)
list_exemption = response.get_result()

print(json.dumps(list_exemption, indent=2))
Copy to clipboard

Example request

ListImageExemptionsOptions listImageExemptionsOptions = new ListImageExemptionsOptions.Builder()
  .resource("image name")
  .build();

Response<List<Exemption>> response = vulnerabilityAdvisorService.listImageExemptions(listImageExemptionsOptions).execute();
List<Exemption> listExemption = response.getResult();

System.out.println(listExemption);

Example request

curl -X 'GET'   'https://icr.io/va/api/v4/exemptions/image/birds?includeScope=false'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'
Copy to clipboard

Response

Response type: []Exemption

Response type: Exemption[]

Response type: List[Exemption]

Response type: List<Exemption>

Response Body

Exemption[]

Status Code

200
OK. If the includeScope query parameter is set to true this endpoint will return a list of exemptions that have an additional field 'scope' that describes the level at which the exemption is set (namespace, repository, tag)
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

[
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-99999",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff"
  }
]
Copy to clipboard

Success example

[
  {
    "issue_type": "cve",
    "issue_id": "CVE-2019-99999",
    "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff"
  }
]
Copy to clipboard

List the exemptions for the given list of images.

POST /va/api/v4/exemptions/images

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListBulkImageExemptions(listBulkImageExemptionsOptions *ListBulkImageExemptionsOptions) (result map[string][]Exemption, response *core.DetailedResponse, err error)

(vulnerabilityAdvisor *VulnerabilityAdvisorV4) ListBulkImageExemptionsWithContext(ctx context.Context, listBulkImageExemptionsOptions *ListBulkImageExemptionsOptions) (result map[string][]Exemption, response *core.DetailedResponse, err error)

listBulkImageExemptions(params)

list_bulk_image_exemptions(
        self,
        body: List[str],
        **kwargs,
    ) -> DetailedResponse

ServiceCall<Map<String, List<Exemption>>> listBulkImageExemptions(ListBulkImageExemptionsOptions listBulkImageExemptionsOptions)

Request

Instantiate the ListBulkImageExemptionsOptions struct and set the fields to provide parameter values for the ListBulkImageExemptions method.

Use the ListBulkImageExemptionsOptions.Builder to create a ListBulkImageExemptionsOptions object that contains the parameter values for the listBulkImageExemptions method.

Custom Headers

Account
Required*
string
The unique ID for your IBM Cloud account. Run 'ibmcloud cr info' to get the ID of the target account.
Accept-Language
string
The preferred language code for this request.

Request Body

Required*

string[]

List of images

Examples:

parameter

WithContext method only

ListBulkImageExemptionsOptions

The ListBulkImageExemptions options.

parameters

body
Required*
string[]
List of images.
Examples:

parameters

body
Required*
List[str]
List of images.
Examples:

ListBulkImageExemptionsOptions

The listBulkImageExemptions options.

Example request

listBulkImageExemptionsOptions := vulnerabilityAdvisorService.NewListBulkImageExemptionsOptions(
  []string{"us.icr.io/birds/woodpecker:green", "us.icr.io/birds/grebe:crested"},
)

mapStringExemption, response, err := vulnerabilityAdvisorService.ListBulkImageExemptions(listBulkImageExemptionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(mapStringExemption, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  body: ['us.icr.io/birds/woodpecker:green', 'us.icr.io/birds/grebe:crested'],
};

let res;
try {
  res = await vulnerabilityAdvisorService.listBulkImageExemptions(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = vulnerability_advisor_service.list_bulk_image_exemptions(
  body=['us.icr.io/birds/woodpecker:green', 'us.icr.io/birds/grebe:crested'],
)
exemptions_map = response.get_result()

print(json.dumps(exemptions_map, indent=2))
Copy to clipboard

Example request

ListBulkImageExemptionsOptions listBulkImageExemptionsOptions = new ListBulkImageExemptionsOptions.Builder()
  .body(java.util.Arrays.asList("us.icr.io/birds/woodpecker:green", "us.icr.io/birds/grebe:crested"))
  .build();

Response<Map<String, List<Exemption>>> response = vulnerabilityAdvisorService.listBulkImageExemptions(listBulkImageExemptionsOptions).execute();
Map<String, List<Exemption>> mapStringListExemption = response.getResult();

System.out.println(mapStringListExemption);
Copy to clipboard

Example request

curl -X 'POST'   'https://icr.io/va/api/v4/exemptions/images'   -H 'Authorization: Bearer <bearer_token>'   -H 'accept: application/json'   -H 'Account: <account_ID>'   -H 'Content-Type: application/json'   -d '[
  "us.icr.io/birds/woodpecker:green",
  "us.icr.io/birds/grebe:crested"
]'
Copy to clipboard

Response

Response type: map[string][]Exemption

Response type: JsonObject

Response type: dict

Response type: Map<String, List<Exemption>>

Response Body

object

Status Code

200
OK
400
A required header is missing. Add the header to the request and try again.
401
You are not authorized to view the requested resource, or your IBM Cloud bearer token is invalid. Run 'ibmcloud iam oauth-tokens' to retrieve your access token and try again. If this issue persists, contact your administrator to confirm that you have access to this resource.
403
You don't have authorization to access the specified namespace. Run 'ibmcloud cr namespaces' to list your namespaces. Check that your image is in one of your namespaces.
500
An internal server error occurred
502
This service is unavailable at the moment. Try again later.
503
Unable to authenticate with IBM Cloud. Try again later.

Example responses

Status 200

{
  "us.icr.io/birds/woodpecker:green": [
    {
      "issue_type": "cve",
      "issue_id": "CVE-2019-99999",
      "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff"
    }
  ],
  "us.icr.io/birds/grebe:crested": [
    {
      "issue_type": "cve",
      "issue_id": "CVE-2019-11111",
      "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff"
    }
  ]
}
Copy to clipboard

Success example

{
  "us.icr.io/birds/woodpecker:green": [
    {
      "issue_type": "cve",
      "issue_id": "CVE-2019-99999",
      "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff"
    }
  ],
  "us.icr.io/birds/grebe:crested": [
    {
      "issue_type": "cve",
      "issue_id": "CVE-2019-11111",
      "account_id": "79c6d1c71fb1cbedc38ffc251ba2ffff"
    }
  ]
}
Copy to clipboard

Vulnerability Advisor 4 for IBM Cloud Container Registry

Introduction

SDKs

Endpoint URL

Authentication

Auditing

Error handling

Vulnerability report status codes

Related APIs

Methods

Get the vulnerability assessment for all images

Request

Custom Headers

Account

Accept-Language

Query Parameters

repository

includeIBM

includePrivate

parameter

ctx

AccountReportQueryPathOptions

Repository

IncludeIBM

IncludePrivate

parameters

repository

includeIbm

includePrivate

parameters

repository

include_ibm

include_private

AccountReportQueryPathOptions

repository

includeIbm

includePrivate

Response

Response Body

assessments

any property

ScanReportList

Assessments

ConfigurationIssues

CorrectiveAction

Description

Exempt

Meta

Type

ID

OsDistribution

DistributionID

VersionID

VersionCodeName

ScanTime

Status

Vulnerabilities

CveExempt

CveID

ExemptSecurityNoticeCount

ExemptStatus

SecurityNoticeCount

SecurityNotices

Notice

NoticeExempt

NoticeID

Summary

VulnerablePackages

CorrectiveAction

Description

FixVersion

InstalledVersion

PackageName

Summary

TotalSecurityNoticeCount

ScanReportList

assessments

configuration_issues

corrective_action

description