Workers

Scripts

Scripts endpoint reference.

List

Fetch a list of uploaded workers.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.

php

$response = $client->workers()->scripts()->list('ACCOUNT_ID');

View this operation on the Cloudflare API Reference

Download

Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.

php

$response = $client->workers()->scripts()->download('ACCOUNT_ID', 'SCRIPT_NAME');

View this operation on the Cloudflare API Reference

Upload

Upload a worker module. You can find more about the multipart metadata on Cloudflare Docs.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.

php

$response = $client->workers()->scripts()->upload('ACCOUNT_ID', 'SCRIPT_NAME');

View this operation on the Cloudflare API Reference

Update Content

Put script content without touching config or metadata

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.

php

$response = $client->workers()->scripts()->updateContent('ACCOUNT_ID', 'SCRIPT_NAME');

View this operation on the Cloudflare API Reference

Get Content

Fetch script content only.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.

php

$response = $client->workers()->scripts()->getContent('ACCOUNT_ID', 'SCRIPT_NAME');

View this operation on the Cloudflare API Reference

Get Script Settings

Get script-level settings when using Worker Versions. Includes Logpush and Tail Consumers.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.

php

$response = $client->workers()->scripts()->getScriptSettings('ACCOUNT_ID', 'SCRIPT_NAME');

View this operation on the Cloudflare API Reference

Update Script Settings

Patch script-level settings when using Worker Versions. Includes Logpush and Tail Consumers.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.
`values`	`array`	Yes		Script settings values.

php

$response = $client->workers()->scripts()->updateScriptSettings('ACCOUNT_ID', 'SCRIPT_NAME', []);

View this operation on the Cloudflare API Reference

Get Settings

Get metadata and config, such as bindings or usage model

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.

php

$response = $client->workers()->scripts()->getSettings('ACCOUNT_ID', 'SCRIPT_NAME');

View this operation on the Cloudflare API Reference

Update Settings

Patch metadata or config, such as bindings or usage model

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.
`values`	`array`	Yes		Settings values.

php

$response = $client->workers()->scripts()->updateSettings('ACCOUNT_ID', 'SCRIPT_NAME', []);

View this operation on the Cloudflare API Reference

Get Usage Model

Fetches the Usage Model for a given Worker.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.

php

$response = $client->workers()->scripts()->getUsageModel('ACCOUNT_ID', 'SCRIPT_NAME');

View this operation on the Cloudflare API Reference

Update Usage Model

Updates the Usage Model for a given Worker. Requires a Workers Paid subscription.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.
`usageModel`	`string`	Yes		Usage model.

php

$response = $client->workers()->scripts()->updateUsageModel('ACCOUNT_ID', 'SCRIPT_NAME', 'USAGE_MODEL');

View this operation on the Cloudflare API Reference

Delete

Delete your worker. This call has no response body on a successful delete.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`scriptName`	`string`	Yes		Name of the script, used in URLs and route configuration.
`force`	`bool`	No	`false`	If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.

php

$response = $client->workers()->scripts()->delete('ACCOUNT_ID', 'SCRIPT_NAME', true);

View this operation on the Cloudflare API Reference

Edit this pageorReport an issue

Environment

Environment endpoint reference.

Subdomain

Subdomain endpoint reference.