---
title: Images
full: true
_openapi:
  preload:
    - ./specs/daytona-api.json
  toc:
    - depth: 2
      title: List images
      url: '#list-images'
    - depth: 2
      title: Create an image
      url: '#create-an-image'
    - depth: 2
      title: Get an image
      url: '#get-an-image'
    - depth: 2
      title: Update an image
      url: '#update-an-image'
    - depth: 2
      title: Delete an image
      url: '#delete-an-image'
    - depth: 2
      title: Get an image's build logs URL
      url: '#get-an-images-build-logs-url'
    - depth: 2
      title: Change an image format
      url: '#change-an-image-format'
    - depth: 2
      title: Create an image from a sandbox
      url: '#create-an-image-from-a-sandbox'
  structuredData:
    headings:
      - content: List images
        id: list-images
      - content: Create an image
        id: create-an-image
      - content: Get an image
        id: get-an-image
      - content: Update an image
        id: update-an-image
      - content: Delete an image
        id: delete-an-image
      - content: Get an image's build logs URL
        id: get-an-images-build-logs-url
      - content: Change an image format
        id: change-an-image-format
      - content: Create an image from a sandbox
        id: create-an-image-from-a-sandbox
    contents:
      - content: Images are returned newest first.
        heading: list-images
      - content: Optionally waits for the image to reach a requested status.
        heading: get-an-image
      - content: Naming an anonymous image makes it permanent. Named images cannot be
          renamed.
        heading: update-an-image
      - content: Deletion is refused while a sandbox, snapshot, or function depends on
          the image.
        heading: delete-an-image
      - content: Converts the image to the format the platform currently boots.
          Repeating the request is safe and returns the in-progress conversion.
        heading: change-an-image-format
      - content: 'Captures only the sandbox disk as an image: Linux images have kind
          `disk`, Windows images kind `block`, and a persistent, stopped macOS
          sandbox saves a macOS image that a later macOS create can start from.
          To capture memory, create a snapshot instead.'
        heading: create-an-image-from-a-sandbox
  methods:
    - GET
    - POST
    - GET
    - PATCH
    - DELETE
    - GET
    - POST
    - POST
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

export default function Layout(props) {
  const { OpenAPIPage } = props.components ?? {};
  return (
    <>
      {props.children}
      <OpenAPIPage document="./specs/daytona-api.json" webhooks={[]} operations={[{"path":"/images","method":"get"},{"path":"/images","method":"post"},{"path":"/images/{id}","method":"get"},{"path":"/images/{id}","method":"patch"},{"path":"/images/{id}","method":"delete"},{"path":"/images/{id}/build-logs-url","method":"get"},{"path":"/images/{id}/convert","method":"post"},{"path":"/sandboxes/{sandbox_id}/images","method":"post"}]} showTitle showDescription />
    </>
  );
}