SnykDockerHubImport

Model for creating Docker Hub import jobs (v1 API).

1. Overview

Overview

This model creates import jobs that import Docker Hub container images into Snyk for scanning. After creation, use SnykImportJob to check the import status.

Uses the Snyk v1 API endpoint: POST /org/{orgId}/integrations/{integrationId}/import

Usage

import clearskies
from clearskies_snyk.models.v1 import SnykDockerHubImport, SnykImportJob


def my_handler(snyk_dockerhub_import: SnykDockerHubImport, snyk_import_job: SnykImportJob):
    # Create an import job for a Docker Hub image
    import_response = snyk_dockerhub_import.create(
        {
            "org_id": "4a18d42f-0706-4ad0-b127-24078731fbed",
            "integration_id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
            "target": {"name": "organization/repository:tag"},
        }
    )

    # Check import job status
    org_id = import_response.org_id
    integration_id = import_response.integration_id
    job = snyk_import_job.find(
        f"org_id={org_id}&integration_id={integration_id}&id={import_response.id}"
    )

Target Object

The target object specifies the Docker Hub image to import:

• name (required): Image name including tag prefixed by organization name Format: organization/repository:tag Example: "myorg/myapp:latest"

Required Permissions

• View Organization
• Add Project
• Test Project