Sign in

v106

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-03812347972.4 KB
script

get script by path

get/w/{workspace}/scripts/get/p/{path}

Path parameters

workspacestring required
pathstring required

Query parameters

with_starred_infoboolean
get_draftboolean

When true, overlay the authed user's draft (if any) onto the deployed payload.

Response

script details

workspace_idstring
hashstring required
pathstring required
parent_hashesstring[]

The first element is the direct parent of the script, the second is the parent of the first, etc

summarystring required
descriptionstring required
contentstring required
created_bystring required
created_atstring date-time required
archivedboolean required
schemaobject
deletedboolean required
is_templateboolean required
extra_permsobject required
lockstring
lock_error_logsstring
language'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible' | 'csharp' | 'nu' | 'java' | 'ruby' | 'rlang' | 'duckdb' | 'bunnative' | 'dbt' required
kind'script' | 'failure' | 'trigger' | 'command' | 'approval' | 'preprocessor' required
starredboolean required
tagstring
draft_onlyboolean
envsstring[]
concurrent_limitinteger
concurrency_time_window_sinteger
concurrency_keystring
debounce_keystring
debounce_delay_sinteger
debounce_args_to_accumulatestring[]
max_total_debouncing_timeinteger
max_total_debounces_amountinteger
cache_ttlnumber
dedicated_workerboolean
ws_error_handler_mutedboolean
priorityinteger
restart_unless_cancelledboolean
timeoutinteger
delete_after_secsinteger

If set, delete the job's args, result and logs after this many seconds following job completion

visible_to_runner_onlyboolean
auto_kindstring
codebasestring
has_preprocessorboolean required
on_behalf_of_emailstring
on_behalf_ofstring

Authorization identity the runnable runs as: u/{username}, g/{group}, or a bare email when the username is itself email-shaped. The only stored half of the identity; on_behalf_of_email is derived from it.

modulesobject nullable

Additional script modules keyed by relative file path

labelsstring[]
inherited_labelsstring[]

Labels inherited from the parent folder, computed at read time. Read-only — edit them on the folder.

is_draftboolean required
draft_saved_atstring date-time
no_deployedboolean
draftobject