Snyk Container

opencollection: 1.0.0
info:
  name: Snyk Container API
  version: Mon Oct 14 2024 20:00:00 GMT-0400 (Eastern Daylight Time)
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Container Projects
    type: folder
  items:
  - info:
      name: List Container Projects
      type: http
    http:
      method: GET
      url: https://api.snyk.io/rest/orgs/:org_id/projects
      params:
      - name: org_id
        value: ''
        type: path
        description: The unique identifier of the Snyk organization
      - name: version
        value: ''
        type: query
        description: API version date string (e.g. 2024-10-15)
      - name: types
        value: ''
        type: query
        description: Filter by project type (e.g. dockerfileFromScm, containerRegistryImage)
      - name: limit
        value: ''
        type: query
        description: Number of results per page (max 100)
      - name: starting_after
        value: ''
        type: query
        description: Cursor for pagination — items after this cursor
    docs: List all container scanning projects within an organization, optionally filtered by type.
  - info:
      name: Get Container Project
      type: http
    http:
      method: GET
      url: https://api.snyk.io/rest/orgs/:org_id/projects/:project_id
      params:
      - name: org_id
        value: ''
        type: path
      - name: project_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
    docs: Retrieve details of a specific container scanning project.
  - info:
      name: Delete Container Project
      type: http
    http:
      method: DELETE
      url: https://api.snyk.io/rest/orgs/:org_id/projects/:project_id
      params:
      - name: org_id
        value: ''
        type: path
      - name: project_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
    docs: Delete a container scanning project.
  - info:
      name: Get Project SBOM
      type: http
    http:
      method: GET
      url: https://api.snyk.io/rest/orgs/:org_id/projects/:project_id/sbom
      params:
      - name: org_id
        value: ''
        type: path
      - name: project_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
      - name: format
        value: ''
        type: query
        description: SBOM format
    docs: Generate and retrieve an SBOM (Software Bill of Materials) for a container project.
- info:
    name: Issues
    type: folder
  items:
  - info:
      name: List Container Issues
      type: http
    http:
      method: GET
      url: https://api.snyk.io/rest/orgs/:org_id/issues
      params:
      - name: org_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
      - name: scan_item.type
        value: ''
        type: query
        description: Filter issues by scan item type
      - name: scan_item.id
        value: ''
        type: query
        description: Filter issues by project ID
      - name: severity
        value: ''
        type: query
        description: Filter by severity level
      - name: status
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: List vulnerability issues found in container scans for an organization, with filtering by severity, status, and
      type.
  - info:
      name: List Package Issues
      type: http
    http:
      method: GET
      url: https://api.snyk.io/rest/orgs/:org_id/packages/issues
      params:
      - name: org_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
      - name: purl
        value: ''
        type: query
        description: Package URL (purl) to filter issues
    docs: List known vulnerabilities for packages found in container images.
- info:
    name: Targets
    type: folder
  items:
  - info:
      name: List Targets
      type: http
    http:
      method: GET
      url: https://api.snyk.io/rest/orgs/:org_id/targets
      params:
      - name: org_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: List all targets (container registries, image sources) for an organization.
  - info:
      name: Create Target
      type: http
    http:
      method: POST
      url: https://api.snyk.io/rest/orgs/:org_id/targets
      params:
      - name: org_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Create a new container registry target for scanning.
  - info:
      name: Get Target
      type: http
    http:
      method: GET
      url: https://api.snyk.io/rest/orgs/:org_id/targets/:target_id
      params:
      - name: org_id
        value: ''
        type: path
      - name: target_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
    docs: Retrieve details of a specific container scan target.
  - info:
      name: Delete Target
      type: http
    http:
      method: DELETE
      url: https://api.snyk.io/rest/orgs/:org_id/targets/:target_id
      params:
      - name: org_id
        value: ''
        type: path
      - name: target_id
        value: ''
        type: path
      - name: version
        value: ''
        type: query
    docs: Remove a container scan target.
bundled: true