SnykAzureReposImport

Model for creating Azure Repos import jobs (v1 API).

1. Overview

Overview

This model creates import jobs that import Azure Repos repositories 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 SnykAzureReposImport, SnykImportJob


def my_handler(snyk_azure_repos_import: SnykAzureReposImport, snyk_import_job: SnykImportJob):
    # Create an import job for an Azure Repos repository
    import_response = snyk_azure_repos_import.create(
        {
            "org_id": "4a18d42f-0706-4ad0-b127-24078731fbed",
            "integration_id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
            "target": {"owner": "my-project", "name": "my-repo", "branch": "main"},
            "files": [{"path": "package.json"}],
            "exclusion_globs": "fixtures,tests",
        }
    )

    # 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 Azure Repos repository to import:

• owner (required): Name of the project containing the repo
• name (required): Name of the repository
• branch (required): Default branch of the repo to import

Files Array

Optional list of specific manifest files to import. Each file object has:

• path: Relative path to the manifest file (e.g., “package.json”, “pom.xml”)

If not specified, Snyk will auto-detect all supported manifest files.

Exclusion Globs

A comma-separated list of up to 10 folder names to exclude from scanning (each folder name must not exceed 100 characters). If not specified, defaults to “fixtures, tests, tests, node_modules”. Use empty string to exclude no folders.

Required Permissions

• View Organization
• Add Project
• Test Project

Notes

Contact support if you need to import a non-default branch.