Prepare a container image

client.Containers.Images.Prepare(ctx, params) (*ImagePrepareResponse, error)

POST/accounts/{account_id}/containers/image-preparations

Idempotently starts or observes preparation of the runtime artifacts required to run one digest-pinned managed container image on Cloudflare’s network. Returns 202 while durable preparation continues and 200 when the image is ready or preparation has reached a terminal error.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

params ImagePrepareParams

AccountID param.Field[string]

Path param: Account identifier.

Image param.Field[string]

Body param: Image url.

ReturnsExpand Collapse

type ImagePrepareResponse struct{…}

Durable preparation state for a container image.

Image string

Image url.

Status ImagePrepareResponseStatus

Current durable preparation state for a container image.

One of the following:

const ImagePrepareResponseStatusPending ImagePrepareResponseStatus = "pending"

const ImagePrepareResponseStatusReady ImagePrepareResponseStatus = "ready"

const ImagePrepareResponseStatusError ImagePrepareResponseStatus = "error"

ArtifactDigest stringOptional

Digest of the prepared runtime artifact when status is ready.

Reason stringOptional

Human-readable pending or terminal error detail.

Prepare a container image

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/containers"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Containers.Images.Prepare(context.TODO(), containers.ImagePrepareParams{
    AccountID: cloudflare.F("account-123"),
    Image: cloudflare.F("image"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Image)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "image": "image",
    "status": "pending",
    "artifact_digest": "artifact_digest",
    "reason": "reason"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "image": "image",
    "status": "pending",
    "artifact_digest": "artifact_digest",
    "reason": "reason"
  },
  "success": true
}