Create Assets Upload Session

client.workersForPlatforms.dispatch.namespaces.scripts.assetUpload.create(, , ?): AssetUploadCreateResponse { buckets, jwt }

POST/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/assets-upload-session

Start uploading a collection of assets for use in a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.

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

scriptName: string

Name of the script, used in URLs and route configuration.

params: AssetUploadCreateParams { account_id, dispatch_namespace, manifest }

account_id: string

Path param: Identifier.

maxLength32

dispatch_namespace: string

Path param: Name of the Workers for Platforms dispatch namespace.

manifest: Record<string, Manifest>

Body param: A manifest ([path]: {hash, size}) map of files to upload. As an example, /blog/hello-world.html would be a valid path key.

hash: string

The hash of the file.

size: number

The size of the file in bytes.

ReturnsExpand Collapse

AssetUploadCreateResponse { buckets, jwt }

buckets?: Array<Array<string>>

The requests to make to upload assets.

jwt?: string

A JWT to use as authentication for uploading assets.

Create Assets Upload Session

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const assetUpload = await client.workersForPlatforms.dispatch.namespaces.scripts.assetUpload.create(
  'this-is_my_script-01',
  {
    account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    dispatch_namespace: 'my-dispatch-namespace',
    manifest: { foo: { hash: 'hash', size: 0 } },
  },
);

console.log(assetUpload.buckets);

{
  "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,
  "result": {
    "buckets": [
      [
        "string"
      ]
    ],
    "jwt": "jwt"
  }
}

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,
  "result": {
    "buckets": [
      [
        "string"
      ]
    ],
    "jwt": "jwt"
  }
}