List images V2

client.Images.V2.List(ctx, params) (*V2ListResponse, error)

GET/accounts/{account_id}/images/v2

List up to 10000 images with up to 1000 results per page. Use the optional parameters below to get a specific range of images. Pagination is supported via continuation_token.

Metadata Filtering (Optional):

You can optionally filter images by custom metadata fields using the meta.<field>[<operator>]=<value> syntax.

Supported Operators:

eq / eq:string / eq:number / eq:boolean - Exact match
gt / gt:number - Greater than (number only)
gte / gte:number - Greater than or equal (number only)
lt / lt:number - Less than (number only)
lte / lte:number - Less than or equal (number only)
in / in:string / in:number - Match any value in list (pipe-separated)

Metadata Filter Constraints:

Maximum 5 metadata filters per request
Maximum 5 levels of nesting (e.g., meta.first.second.third.fourth.fifth)
Maximum 10 elements for list operators (in)
Supports string, number, and boolean value types
Range operators (gt, gte, lt, lte) only accept numeric values

Filter Consistency: Filters are combined with AND logic. The system does not validate whether filter combinations are logically consistent. For example, meta.priority[eq:number]=5&meta.priority[lte:number]=3 will return zero results because no value can satisfy both conditions simultaneously. It is the caller’s responsibility to ensure filter combinations make sense.

Examples:

# List all images
/images/v2

# Filter by metadata [eq]
/images/v2?meta.status[eq:string]=active

# Filter by metadata [in]
/images/v2?meta.status[in]=pending|deleted|flagged

# Filter by metadata [in:number]
/images/v2?meta.ratings[in:number]=4|5

# Filter by metadata range [gte:number]
/images/v2?meta.priority[gte:number]=1

# Filter by bounded range
/images/v2?meta.priority[gte:number]=1&meta.priority[lte:number]=5

# Filter by nested metadata
/images/v2?meta.region.name[eq]=eu-west

# Combine metadata filters with creator
/images/v2?meta.status[eq]=active&creator=user123

# Multiple metadata filters (AND logic)
/images/v2?meta.status[eq]=active&meta.priority[eq:number]=5

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

params V2ListParams

AccountID param.Field[string]

Path param: Account identifier tag.

maxLength32

ContinuationToken param.Field[string]Optional

Query param: Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint.

maxLength32

Creator param.Field[string]Optional

Query param: Internal user ID set within the creator field. Setting to empty string "" will return images where creator field is not set

Meta param.Field[V2ListParamsMeta]Optional

Query param

FieldOperator stringOptional

Optional metadata filter(s). Multiple filters can be combined with AND logic.

Operators:

eq, eq:string, eq:number, eq:boolean - Exact match
gt, gt:number - Greater than (number only)
gte, gte:number - Greater than or equal (number only)
lt, lt:number - Less than (number only)
lte, lte:number - Less than or equal (number only)
in, in:string, in:number - Match any value in pipe-separated list

Examples:

meta.status[eq]=active
meta.priority[eq:number]=5
meta.enabled[eq:boolean]=true
meta.priority[gte:number]=1
meta.score[lt:number]=100
meta.region[in]=us-east|us-west|eu-west

Note: Filter consistency is not validated. Contradictory filters (e.g., meta.priority[eq:number]=5&meta.priority[lte:number]=3) will return zero results.

PerPage param.Field[float64]Optional

Query param: Number of items per page

maximum10000

minimum10

SortOrder param.Field[V2ListParamsSortOrder]Optional

Query param: Sorting order by upload time

const V2ListParamsSortOrderAsc V2ListParamsSortOrder = "asc"

const V2ListParamsSortOrderDesc V2ListParamsSortOrder = "desc"

ReturnsExpand Collapse

type V2ListResponse struct{…}

ContinuationToken stringOptional

Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint.

maxLength32

Images []ImageOptional

ID stringOptional

Image unique identifier.

maxLength32

Creator stringOptional

Can set the creator field with an internal user ID.

maxLength1024

Filename stringOptional

Image file name.

maxLength255

Meta unknownOptional

User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes.

RequireSignedURLs boolOptional

Indicates whether the image can be a accessed only using it’s UID. If set to true, a signed token needs to be generated with a signing key to view the image.

Uploaded TimeOptional

When the media item was uploaded.

formatdate-time

Variants []stringOptional

Object specifying available variants for an image.

List images V2

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"),
  )
  v2s, err := client.Images.V2.List(context.TODO(), images.V2ListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", v2s.ContinuationToken)
}

{
  "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": {
    "continuation_token": "continuation_token",
    "images": [
      {
        "id": "id",
        "creator": "107b9558-dd06-4bbd-5fef-9c2c16bb7900",
        "filename": "logo.png",
        "meta": {
          "key": "value"
        },
        "requireSignedURLs": true,
        "uploaded": "2014-01-02T02:20:00.123Z",
        "variants": [
          "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail",
          "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero",
          "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original"
        ]
      }
    ]
  },
  "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": {
    "continuation_token": "continuation_token",
    "images": [
      {
        "id": "id",
        "creator": "107b9558-dd06-4bbd-5fef-9c2c16bb7900",
        "filename": "logo.png",
        "meta": {
          "key": "value"
        },
        "requireSignedURLs": true,
        "uploaded": "2014-01-02T02:20:00.123Z",
        "variants": [
          "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail",
          "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero",
          "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original"
        ]
      }
    ]
  },
  "success": true
}