Skip to content

Upload asset

client.pages.assets.upload(, ?): AssetUploadResponse { errors, messages, success }

POST/pages/assets/upload

Upload one or more files to the Pages asset store. Each file is identified by its content hash and is uploaded using the same JSON shape as the Cloudflare KV bulk write API. Used as part of the Pages Direct Upload workflow.

Authenticate with the JWT obtained from the upload-token endpoint: GET /accounts/{account_id}/pages/projects/{project_name}/upload-token

Security

ParametersExpand Collapse

params: AssetUploadParams { body }

body: Array<Body>

base64: boolean

Whether value is base64 encoded.

key: string

File content hash used as the object key in the Pages asset store.

metadata: Metadata { contentType }

contentType: string

MIME type for the uploaded file.

value: string

File content. When base64 is true, this value is base64 encoded.

ReturnsExpand Collapse

AssetUploadResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Upload asset

import Cloudflare from 'cloudflare';

const client = new Cloudflare();

const response = await client.pages.assets.upload({
  body: [
    {
      base64: true,
      key: 'b026324c6904b2a9cb4b88d6d61c81d1',
      metadata: { contentType: 'text/plain' },
      value: 'SGVsbG8sIFdvcmxkIQ==',
    },
  ],
});

console.log(response.errors);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "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"
      }
    }
  ],
  "success": true
}