Cloudflare/images
@webframp/cloudflare/imagesv2026.07.19.1
01README
Cloudflare Images — upload, transform, deliver, and manage image pipelines
02Release Notes
2026.07.19.1
Added: Initial code-generated release of @webframp/cloudflare/images with 31 methods covering the Cloudflare images API surface.
03Models
@webframp/cloudflare/imagesv2026.07.19.1cloudflare/images.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiToken | string | Cloudflare API token |
| accountId | string | Cloudflare account ID |
fn cloudflare_images_upload_an_image_via_url()
Upload an image
fn list_signing_keys()
List Signing Keys
fn update_cloudflare_images_keys_add_signing_key(signing_key_name: string)
Create a new Signing Key
| Argument | Type | Description |
|---|---|---|
| signing_key_name | string |
fn delete_signing_key(signing_key_name: string)
Delete Signing Key
| Argument | Type | Description |
|---|---|---|
| signing_key_name | string |
fn get_cloudflare_images_images_usage_statistics()
Images usage statistics
fn list_variants()
List variants
fn create_a_variant(neverRequireSignedURLs?: unknown, options: unknown)
Create a variant
| Argument | Type | Description |
|---|---|---|
| neverRequireSignedURLs? | unknown | |
| options | unknown |
fn get_cloudflare_images_variants_variant_details(variant_id: string)
Variant details
| Argument | Type | Description |
|---|---|---|
| variant_id | string |
fn update_a_variant(variant_id: string, neverRequireSignedURLs?: unknown, options: unknown)
Update a variant
| Argument | Type | Description |
|---|---|---|
| variant_id | string | |
| neverRequireSignedURLs? | unknown | |
| options | unknown |
fn delete_a_variant(variant_id: string)
Delete a variant
| Argument | Type | Description |
|---|---|---|
| variant_id | string |
fn get_cloudflare_images_variants_variant_details_flat(variant_id: string)
Variant details (flat)
| Argument | Type | Description |
|---|---|---|
| variant_id | string |
fn get_cloudflare_images_image_details(image_id: string)
Image details
| Argument | Type | Description |
|---|---|---|
| image_id | string |
fn update_image(image_id: string, creator?: string, metadata?: object, requireSignedURLs?: boolean)
Update image
| Argument | Type | Description |
|---|---|---|
| image_id | string | |
| creator? | string | Can set the creator field with an internal user ID. |
| metadata? | object | User modifiable key-value store. Can be used for keeping references to anothe... |
| requireSignedURLs? | boolean | Indicates whether the image can be accessed using only its UID. If set to `tr... |
fn delete_image(image_id: string)
Delete image
| Argument | Type | Description |
|---|---|---|
| image_id | string |
fn list_images_v2(continuation_token?: string, per_page?: number, sort_order?: enum, creator?: string, meta_field_operator?: string)
List images V2
| Argument | Type | Description |
|---|---|---|
| continuation_token? | string | |
| per_page? | number | |
| sort_order? | enum | |
| creator? | string | |
| meta_field_operator? | string | 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[ |
fn create_authenticated_direct_upload_url_v_2()
Create authenticated direct upload URL V2
fn list_migrations(offset?: number, limit?: number)
List sourcing kit migrations
| Argument | Type | Description |
|---|---|---|
| offset? | number | |
| limit? | number |
fn create_migration(conflictBehaviour?: unknown, excludedContentTypes?: array, pathPrefix?: string, rootDirectory?: string, sourceId: string)
Create a sourcing kit migration
| Argument | Type | Description |
|---|---|---|
| conflictBehaviour? | unknown | |
| excludedContentTypes? | array | Content types to skip during migration. |
| pathPrefix? | string | Prefix to prepend to image custom IDs. |
| rootDirectory? | string | Only import objects under this prefix in the source bucket. |
| sourceId | string | The identifier of the source to migrate from. |
fn get_migration(migration_id: string)
Get sourcing kit migration
| Argument | Type | Description |
|---|---|---|
| migration_id | string |
fn delete_migration(migration_id: string)
Delete a sourcing kit migration
| Argument | Type | Description |
|---|---|---|
| migration_id | string |
fn get_migration_progress(migration_id: string)
Get migration progress
| Argument | Type | Description |
|---|---|---|
| migration_id | string |
fn update_cloudflare_images_sourcingkit_abort_migration(migration_id: string)
Abort a migration
| Argument | Type | Description |
|---|---|---|
| migration_id | string |
fn update_cloudflare_images_sourcingkit_start_migration(migration_id: string)
Start a migration
| Argument | Type | Description |
|---|---|---|
| migration_id | string |
fn list_migration_logs(migration_id: string, offset?: number, limit?: number)
List migration logs
| Argument | Type | Description |
|---|---|---|
| migration_id | string | |
| offset? | number | |
| limit? | number |
fn list_sources(offset?: number, limit?: number, name?: string)
List sourcing kit sources
| Argument | Type | Description |
|---|---|---|
| offset? | number | |
| limit? | number | |
| name? | string |
fn create_source(account?: string, bucket: string, name: string, secret: object, vendor: unknown)
Create a sourcing kit source
| Argument | Type | Description |
|---|---|---|
| account? | string | Account identifier for the bucket (required for R2 vendor). |
| bucket | string | The name of the storage bucket. |
| name | string | A human-readable name for the source. |
| secret | object | Storage credentials for accessing the bucket. Shape depends on vendor. |
| vendor | unknown |
fn create_cloudflare_images_sourcingkit_precheck_source_connectivity(account?: string, bucket: string, region?: string, secret: object, vendor: unknown)
Precheck source connectivity
| Argument | Type | Description |
|---|---|---|
| account? | string | Account identifier for the bucket (required for R2 vendor). |
| bucket | string | The name of the storage bucket. |
| region? | string | The region hint for the bucket (S3 only). |
| secret | object | Storage credentials for accessing the bucket. |
| vendor | unknown |
fn get_source(source_id: string)
Get sourcing kit source
| Argument | Type | Description |
|---|---|---|
| source_id | string |
fn update_source(source_id: string, name: string)
Update a sourcing kit source
| Argument | Type | Description |
|---|---|---|
| source_id | string | |
| name | string | Updated name for the source. |
fn delete_source(source_id: string)
Delete a sourcing kit source
| Argument | Type | Description |
|---|---|---|
| source_id | string |
fn get_source_connectivity(source_id: string)
Get source connectivity status
| Argument | Type | Description |
|---|---|---|
| source_id | string |
Resources
cloudflare_images_upload_an_image_via_url(infinite)— Upload an image
list_signing_keys(infinite)— List Signing Keys
cloudflare_images_keys_add_signing_key(infinite)— Create a new Signing Key
cloudflare_images_images_usage_statistics(infinite)— Images usage statistics
list_variants(infinite)— List variants
a_variant(infinite)— Create a variant
cloudflare_images_variants_variant_details(infinite)— Variant details
cloudflare_images_variants_variant_details_flat(infinite)— Variant details (flat)
cloudflare_images_image_details(infinite)— Image details
image(infinite)— Update image
list_images_v2(infinite)— List images V2
authenticated_direct_upload_url_v_2(infinite)— Create authenticated direct upload URL V2
list_migrations(infinite)— List sourcing kit migrations
migration(infinite)— Create a sourcing kit migration
migration_progress(infinite)— Get migration progress
cloudflare_images_sourcingkit_abort_migration(infinite)— Abort a migration
cloudflare_images_sourcingkit_start_migration(infinite)— Start a migration
list_migration_logs(infinite)— List migration logs
list_sources(infinite)— List sourcing kit sources
source(infinite)— Create a sourcing kit source
cloudflare_images_sourcingkit_precheck_source_connectivity(infinite)— Precheck source connectivity
source_connectivity(infinite)— Get source connectivity status
04Stats
A
100 / 100
Downloads
0
Archive size
14.1 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels