Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

CreateImage registers pushed OCI content or disk content derived from a snapshot or sandbox.

POST/v1/images
CreateImage registers pushed OCI content or disk content derived from a snapshot or sandbox.

Connection and access

API connection and authentication guidance

https://connect.docker.com/sandboxes — The API base URL. Append the /v1 paths while preserving this URL's path prefix.

Use one of these alternatives. Requirements within an alternative apply together.

  • bearer

Parameters

Idempotency-Key header

Replay key. Reusing it with a different payload fails with failedPrecondition; accepted keys are retained for at least 24 hours.

Type: string

Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.
All schema constraints and annotations
{
  "description": "Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.",
  "title": "Idempotency-Key",
  "type": "string"
}

Request and responses

Request

application/json

Schema: CreateImageRequest

Response 201

Success

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "const": "no-store",
    "type": "string"
  }
}
ETag

The etag of the resource this response carries, which the next mutation of it sends as If-Match.

{
  "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
  "schema": {
    "type": "string"
  }
}
All constraints apply

Schema: Image

All schema constraints and annotations
{
  "not": {
    "properties": {
      "status": {
        "enum": [
          "pending",
          "waitingForPush",
          "preparing"
        ]
      }
    },
    "required": [
      "status"
    ]
  }
}
All schema constraints and annotations
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Image"
    },
    {
      "not": {
        "properties": {
          "status": {
            "enum": [
              "pending",
              "waitingForPush",
              "preparing"
            ]
          }
        },
        "required": [
          "status"
        ]
      }
    }
  ]
}

Response 202

Accepted. The resource is still progressing; read it or follow its events until completion.

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "const": "no-store",
    "type": "string"
  }
}
ETag

The etag of the resource this response carries, which the next mutation of it sends as If-Match.

{
  "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
  "schema": {
    "type": "string"
  }
}
All constraints apply

Schema: Image

status · required
All schema constraints and annotations
{
  "enum": [
    "pending",
    "waitingForPush",
    "preparing"
  ]
}
All schema constraints and annotations
{
  "properties": {
    "status": {
      "enum": [
        "pending",
        "waitingForPush",
        "preparing"
      ]
    }
  },
  "required": [
    "status"
  ]
}
All schema constraints and annotations
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Image"
    },
    {
      "properties": {
        "status": {
          "enum": [
            "pending",
            "waitingForPush",
            "preparing"
          ]
        }
      },
      "required": [
        "status"
      ]
    }
  ]
}

Response 409

Creation conflicts with an existing resource (ALREADY_EXISTS).

The Idempotency-Key was already used with a different payload.

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "enum": [
      "no-store"
    ],
    "type": "string"
  }
}

Schema: Error

failedPrecondition

{
  "code": "failedPrecondition",
  "message": "The Idempotency-Key was already used with a different payload."
}

Response default

The structured Error body identifies the failure with a stable code and optional typed details.

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "enum": [
      "no-store"
    ],
    "type": "string"
  }
}

Schema: Error

Schema example

{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}

Referenced schemas

#/components/schemas/CreateImageRequest

#/components/schemas/Error

#/components/schemas/Image

Complete operation contract
{
  "description": "CreateImage registers pushed OCI content or disk content derived from a snapshot or sandbox.",
  "operationId": "createImage",
  "parameters": [
    {
      "description": "Replay key. Reusing it with a different payload fails with failedPrecondition; accepted keys are retained for at least 24 hours.",
      "in": "header",
      "name": "Idempotency-Key",
      "schema": {
        "description": "Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.",
        "title": "Idempotency-Key",
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CreateImageRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "201": {
      "content": {
        "application/json": {
          "schema": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Image"
              },
              {
                "not": {
                  "properties": {
                    "status": {
                      "enum": [
                        "pending",
                        "waitingForPush",
                        "preparing"
                      ]
                    }
                  },
                  "required": [
                    "status"
                  ]
                }
              }
            ]
          }
        }
      },
      "description": "Success",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "const": "no-store",
            "type": "string"
          }
        },
        "ETag": {
          "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "202": {
      "content": {
        "application/json": {
          "schema": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Image"
              },
              {
                "properties": {
                  "status": {
                    "enum": [
                      "pending",
                      "waitingForPush",
                      "preparing"
                    ]
                  }
                },
                "required": [
                  "status"
                ]
              }
            ]
          }
        }
      },
      "description": "Accepted. The resource is still progressing; read it or follow its events until completion.",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "const": "no-store",
            "type": "string"
          }
        },
        "ETag": {
          "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "409": {
      "content": {
        "application/json": {
          "examples": {
            "failedPrecondition": {
              "summary": "The Idempotency-Key was already used with a different payload.",
              "value": {
                "code": "failedPrecondition",
                "message": "The Idempotency-Key was already used with a different payload."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Creation conflicts with an existing resource (ALREADY_EXISTS).\n\nThe Idempotency-Key was already used with a different payload.",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "enum": [
              "no-store"
            ],
            "type": "string"
          }
        }
      }
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details.",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "enum": [
              "no-store"
            ],
            "type": "string"
          }
        }
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "CreateImage registers pushed OCI content or disk content derived from a snapshot or sandbox.",
  "tags": [
    "Images"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-error-responses": [
    {
      "code": "FAILED_PRECONDITION",
      "description": "The Idempotency-Key was already used with a different payload."
    }
  ],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "imagesWrite"
  ],
  "x-sbx-resource-response": {
    "$ref": "#/components/schemas/Image"
  },
  "x-sbx-serving-surface": "management"
}