List variants

client.Images.V1.Variants.List(ctx, query) (*Variant, error)

GET/accounts/{account_id}/images/v1/variants

Lists existing variants.

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

Accepted Permissions (at least one required)

Images ReadImages Write

ParametersExpand Collapse

query V1VariantListParams

AccountID param.Field[string]

Account identifier tag.

maxLength32

ReturnsExpand Collapse

type Variant struct{…}

Variants VariantVariantsOptional

Hero VariantVariantsHeroOptional

ID string

maxLength99

Options VariantVariantsHeroOptions

Allows you to define image resizing sizes for different use cases.

Fit VariantVariantsHeroOptionsFit

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

const VariantVariantsHeroOptionsFitScaleDown VariantVariantsHeroOptionsFit = "scale-down"

const VariantVariantsHeroOptionsFitContain VariantVariantsHeroOptionsFit = "contain"

const VariantVariantsHeroOptionsFitCover VariantVariantsHeroOptionsFit = "cover"

const VariantVariantsHeroOptionsFitCrop VariantVariantsHeroOptionsFit = "crop"

const VariantVariantsHeroOptionsFitPad VariantVariantsHeroOptionsFit = "pad"

Height float64

Maximum height in image pixels.

minimum1

Metadata VariantVariantsHeroOptionsMetadata

What EXIF data should be preserved in the output image.

One of the following:

const VariantVariantsHeroOptionsMetadataKeep VariantVariantsHeroOptionsMetadata = "keep"

const VariantVariantsHeroOptionsMetadataCopyright VariantVariantsHeroOptionsMetadata = "copyright"

const VariantVariantsHeroOptionsMetadataNone VariantVariantsHeroOptionsMetadata = "none"

Width float64

Maximum width in image pixels.

minimum1

NeverRequireSignedURLs boolOptional

Indicates whether the variant can access an image without a signature, regardless of image access control.

List variants

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/images"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  variant, err := client.Images.V1.Variants.List(context.TODO(), images.V1VariantListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", variant.Variants)
}

{
  "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": {
    "variants": {
      "hero": {
        "id": "hero",
        "options": {
          "fit": "scale-down",
          "height": 768,
          "metadata": "none",
          "width": 1366
        },
        "neverRequireSignedURLs": true
      }
    }
  },
  "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": {
    "variants": {
      "hero": {
        "id": "hero",
        "options": {
          "fit": "scale-down",
          "height": 768,
          "metadata": "none",
          "width": 1366
        },
        "neverRequireSignedURLs": true
      }
    }
  },
  "success": true
}