ContainerRegistryImportPolicy

This document uses the REST API. For more details, see the Authentication for API page.

Create a dry run job for a container registry import policy (Early Access)

post

Creates an asynchronous dry run job to test a container registry import policy

Required permissions

• Edit integrations (org.integration.edit)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

Org ID

integration_idstring · uuidRequired

Container Registry Integration ID

Query parameters

versionstringRequired

Requested API version

Example: 2025-11-05Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

application/vnd.api+json

Responses

202

Dry run job created successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

409

Conflict: The requested operation conflicts with the current state of the resource in some way.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/orgs/{org_id}/container_import/{integration_id}/policy/dry_run

HTTPcURLJavaScriptPython

POST /rest/orgs/{org_id}/container_import/{integration_id}/policy/dry_run?version=2025-11-05 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 220

{
  "data": {
    "attributes": {
      "policy": {
        "delete_images": true,
        "import_policy": {
          "name": "text",
          "policy": {},
          "sub_policies": [
            {}
          ],
          "type": "text"
        },
        "name": "text",
        "schedule_frequency_hours": 1
      }
    },
    "type": "container_registry_import_policy"
  }
}

{
  "data": {
    "attributes": {
      "status": "pending"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "dry_run_job"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get a dry run job (Early Access)

get

Retrieves the status and results of a dry run job

Required permissions

• Edit integrations (org.integration.edit)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

Org ID

integration_idstring · uuidRequired

Container Registry Integration ID

job_idstring · uuidRequired

Dry run job ID

Query parameters

versionstringRequired

Requested API version

Example: 2025-11-05Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

200

Dry run job retrieved successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/container_import/{integration_id}/policy/dry_run/{job_id}

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/container_import/{integration_id}/policy/dry_run/{job_id}?version=2025-11-05 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "completed_at": "2025-12-27T13:31:09.893Z",
      "error_message": "text",
      "policy": {
        "delete_images": true,
        "import_policy": {
          "name": "text",
          "policy": {},
          "sub_policies": [
            {}
          ],
          "type": "text"
        },
        "name": "text",
        "schedule_frequency_hours": 1
      },
      "result": {
        "images_to_delete": [
          {
            "repository": "text",
            "tags": [
              {
                "observed_at": "2025-12-27T13:31:09.893Z",
                "tag": "text"
              }
            ]
          }
        ],
        "images_to_import": [
          {
            "repository": "text",
            "tags": [
              {
                "observed_at": "2025-12-27T13:31:09.893Z",
                "tag": "text"
              }
            ]
          }
        ],
        "total_images_processed": 1
      },
      "started_at": "2025-12-27T13:31:09.893Z",
      "status": "pending"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "dry_run_job"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}