scripts
Creates, updates, deletes, gets or lists a scripts resource.
Overview
| Name | scripts |
| Type | Resource |
| Id | cloudflare.workers_for_platforms.scripts |
Fields
The following fields are returned by SELECT queries:
- get
Worker Details Response (Workers for Platforms).
| Name | Datatype | Description |
|---|---|---|
created_on | string (date-time) | When the script was created. (example: 2017-01-01T00:00:00Z) |
dispatch_namespace | string | Name of the Workers for Platforms dispatch namespace. (example: my-dispatch-namespace) |
modified_on | string (date-time) | When the script was last modified. (example: 2017-01-01T00:00:00Z) |
script | object |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | account_id, dispatch_namespace, script_name | Fetch information about a script uploaded to a Workers for Platforms namespace. | |
update | replace | account_id, dispatch_namespace, script_name | bindings_inherit | Upload a worker module to a Workers for Platforms namespace. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/. |
delete | delete | account_id, dispatch_namespace, script_name | force | Delete a worker from a Workers for Platforms namespace. This call has no response body on a successful delete. |
create_assets_upload_session | exec | account_id, dispatch_namespace, script_name, manifest | 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/. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
dispatch_namespace | string | The Workers-for-Platforms dispatch namespace. |
script_name | string | The Worker script name. |
bindings_inherit | string | When set to "strict", the upload will fail if any inherit type bindings cannot be resolved against the previous version of the script. Without this, unresolvable inherit bindings are silently dropped. |
force | boolean | 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. |
SELECT examples
- get
Fetch information about a script uploaded to a Workers for Platforms namespace.
SELECT
created_on,
dispatch_namespace,
modified_on,
script
FROM cloudflare.workers_for_platforms.scripts
WHERE account_id = '{{ account_id }}' -- required
AND dispatch_namespace = '{{ dispatch_namespace }}' -- required
AND script_name = '{{ script_name }}' -- required
;
REPLACE examples
- update
Upload a worker module to a Workers for Platforms namespace. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.
REPLACE cloudflare.workers_for_platforms.scripts
SET
-- No updatable properties
WHERE
account_id = '{{ account_id }}' --required
AND dispatch_namespace = '{{ dispatch_namespace }}' --required
AND script_name = '{{ script_name }}' --required
AND bindings_inherit = '{{ bindings_inherit}}'
RETURNING
errors,
messages,
result,
success;
DELETE examples
- delete
Delete a worker from a Workers for Platforms namespace. This call has no response body on a successful delete.
DELETE FROM cloudflare.workers_for_platforms.scripts
WHERE account_id = '{{ account_id }}' --required
AND dispatch_namespace = '{{ dispatch_namespace }}' --required
AND script_name = '{{ script_name }}' --required
AND force = '{{ force }}'
;
Lifecycle Methods
- create_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/.
EXEC cloudflare.workers_for_platforms.scripts.create_assets_upload_session
@account_id='{{ account_id }}' --required,
@dispatch_namespace='{{ dispatch_namespace }}' --required,
@script_name='{{ script_name }}' --required
@@json=
'{
"manifest": "{{ manifest }}"
}'
;