> ## Documentation Index
> Fetch the complete documentation index at: https://bunny.net/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Find Container Image

> Parses an image reference like "ghcr.io/owner/app:v1" or "owner/app" and checks whether the image tag exists in the selected registries of the user (only those of the reference's host when it has one). A reference without a tag finds nothing, not even "latest": the image's tags are suggested instead. Returns every registry that has the image tag with its id, hostname, the image namespace, name, tag and digest, and how each searched registry answered: found, not found, unauthorized (its credentials are refused) or unavailable. When none has it, suggests the image's tags from the registries that have the image, and images with a similar name.



## OpenAPI

````yaml https://api-mc.opsbunny.net/docs/public/swagger.json post /registries/images/find
openapi: 3.0.4
info:
  title: Public API
  description: 'Public API endpoints for user consumption. Release version: v1.11.0.2'
  version: '1.0'
servers:
  - url: https://api.bunny.net/mc
security:
  - AccessKey: []
paths:
  /registries/images/find:
    post:
      tags:
        - ContainerRegistries
      summary: Find Container Image
      description: >-
        Parses an image reference like "ghcr.io/owner/app:v1" or "owner/app" and
        checks whether the image tag exists in the selected registries of the
        user (only those of the reference's host when it has one). A reference
        without a tag finds nothing, not even "latest": the image's tags are
        suggested instead. Returns every registry that has the image tag with
        its id, hostname, the image namespace, name, tag and digest, and how
        each searched registry answered: found, not found, unauthorized (its
        credentials are refused) or unavailable. When none has it, suggests the
        image's tags from the registries that have the image, and images with a
        similar name.
      operationId: FindContainerImage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FindContainerImageRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FindContainerImageRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FindContainerImageRequest'
      responses:
        '200':
          description: >-
            The registries were searched: every one that has the image tag is
            listed (none when it was found nowhere), with how each searched
            registry answered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindContainerImageResponse'
        '400':
          description: The request is invalid, e.g. no registry is selected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '401':
          description: User is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '404':
          description: >-
            None of the selected registries is the user's or is for the image
            host.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '422':
          description: The image reference is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
components:
  schemas:
    FindContainerImageRequest:
      required:
        - image
        - registryIds
      type: object
      properties:
        image:
          maxLength: 512
          minLength: 1
          type: string
          description: >-
            Image reference in the docker format:
            [registry/]namespace/name[:tag], e.g. "ghcr.io/owner/app:v1" or
            "owner/app".

            Without a registry host all of the user's registries are searched.

            Without a tag nothing is found, not even "latest": the image's tags
            are suggested instead.
        registryIds:
          minItems: 1
          type: array
          items:
            type: string
          description: >-
            The registries to search: ids of the user's registries, or
            "dockerhub" / "github". At least one is required;

            ids that are not the user's registries are skipped. With a registry
            host in the image reference, only the

            selected registries of that host are searched.
      additionalProperties: false
    FindContainerImageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FoundContainerImage'
        meta:
          $ref: '#/components/schemas/ListMeta'
        cursor:
          type: string
          nullable: true
        registries:
          type: array
          items:
            $ref: '#/components/schemas/FindContainerImageRegistryResult'
          description: How each searched registry answered, in the order they were queried.
        suggestions:
          $ref: '#/components/schemas/FindContainerImageSuggestions'
      additionalProperties: false
      description: >-
        Every registry of the user that has the image tag, in the order they
        were queried

        (the user's own private registries first, then public and platform
        ones). Empty when none has it.
    ErrorDetails:
      type: object
      properties:
        title:
          type: string
          description: A short, human-readable summary of the problem type.
          readOnly: true
        status:
          type: integer
          description: The HTTP status code.
          format: int32
          readOnly: true
        detail:
          type: string
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          nullable: true
          readOnly: true
        instance:
          type: string
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          nullable: true
          readOnly: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          description: Additional validation errors for field-specific issues.
          nullable: true
          readOnly: true
        id:
          type: string
          description: >-
            The application ID, returned as an RFC 7807 extension field when
            relevant (e.g. partial save errors).

            Matches the "id" field from successful create response for
            consistency.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: RFC 7807 Problem Details response model.
    FoundContainerImage:
      required:
        - imageDigest
        - imageName
        - imageNamespace
        - imageTag
        - isPublic
        - registryHostname
        - registryId
      type: object
      properties:
        imageNamespace:
          type: string
        imageName:
          type: string
        registryId:
          type: string
        registryHostname:
          type: string
        isPublic:
          type: boolean
        imageTag:
          type: string
        imageDigest:
          type: string
      additionalProperties: false
    ListMeta:
      type: object
      properties:
        totalItems:
          type: integer
          format: int64
      additionalProperties: false
    FindContainerImageRegistryResult:
      required:
        - registryId
        - status
      type: object
      properties:
        registryId:
          type: string
        status:
          $ref: '#/components/schemas/FindContainerImageRegistryStatus'
        message:
          type: string
          description: >-
            Why the registry could not be searched; only for Unauthorized and
            Unavailable.
          nullable: true
      additionalProperties: false
    FindContainerImageSuggestions:
      type: object
      properties:
        sameImageTags:
          type: array
          items:
            $ref: '#/components/schemas/SuggestedContainerImageTags'
          description: >-
            The image with its first tags, from each registry that has the image
            but not the tag.
        similarImages:
          type: array
          items:
            $ref: '#/components/schemas/SuggestedContainerImage'
          description: >-
            Other images whose name is like the one asked for, from the
            registries' search or catalog.
      additionalProperties: false
    ValidationError:
      required:
        - message
      type: object
      properties:
        field:
          type: string
          nullable: true
        message:
          type: string
      additionalProperties: false
    FindContainerImageRegistryStatus:
      enum:
        - found
        - notFound
        - unauthorized
        - unavailable
      type: string
    SuggestedContainerImageTags:
      required:
        - imageName
        - imageNamespace
        - registryId
        - tags
      type: object
      properties:
        registryId:
          type: string
        imageNamespace:
          type: string
        imageName:
          type: string
        tags:
          type: array
          items:
            type: string
      additionalProperties: false
    SuggestedContainerImage:
      required:
        - imageName
        - imageNamespace
        - registryId
      type: object
      properties:
        registryId:
          type: string
        imageNamespace:
          type: string
        imageName:
          type: string
      additionalProperties: false
  securitySchemes:
    AccessKey:
      type: apiKey
      description: Please enter a valid personal API key.
      name: AccessKey
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.