hub apps list
Optionalapps?: { credentials
Successfully authenticated. The session ID is returned in a cookie named token and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
clear cookies and clear token (if applicable)
all concurrency groups
concurrency group removed
concurrency key for given job
a config
a list of worker group configs
Delete config
worker group
Update a worker group
get license id (empty if not ee)
Optionalapp?: stringquery scripts app
Optionalkind?: stringquery scripts kind
Optionallimit?: numberquery limit
query text
script details
hub flows list
Optionalflows?: { user to add to instance group
user added to instance group
create instance group
Optionalsummary?: stringinstance group created
instance group deleted
instance group
instance group list
user to remove from instance group
user removed from instance group
update instance group
instance group updated
Optionalkind?: stringquery integrations kind
integrations details
the timestamp of the db that can be used to compute the drift
code endpoint
oauth token
client name
get
Optionalextra_Optionalscopes?: string[]list of oauth connects clients
list of oauth and saml login clients
Optionalsaml?: stringPartially filled script
Optionalcode?: stringOptionalstate?: stringSuccessfully authenticated. The session ID is returned in a cookie named token and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
openapi yaml file content
test metadata
status
schedule
List of 5 estimated upcoming execution events (in UTC)
script details
script details
Optionallockfile?: stringOptionalschema?: unknownOptionalsummary?: stringOptionalapp?: stringquery scripts app
Optionalkind?: stringquery scripts kind
Optionallimit?: numberquery limit
hub scripts list
Optionalasks?: { script content
status
value set
Optionalvalue?: unknownstatus
status
status
status
status
test license key
status
test object storage config
status
test smtp payload
status
is backend up to date
accept invite
Optionalusername?: stringstatus
free all runnables
Optionaldescription?: stringuser info
Optionalcompany?: stringOptionalname?: stringuser created
decline invite
status
user deleted
user email
user
status
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpernumber of items to return for a given page (default 30, max 100)
user
list all workspace invites
free usage
new username
user renamed
set password
password set
delete token
new token
token created
Optionalexcludetruncated token
tutorial progress
Optionalprogress?: numberprogress update
Optionalprogress?: numbertutorial progress
new user info
Optionalis_user updated
free usage
user renamed
user email
git version of backend
acl to add
Optionalwrite?: booleangranular acl added
acls
acl to add
granular acl removed
app created
app deleted
app exists
app details with draft
app details
app details
app details
app history
App deployment message
Optionaldeployment_success
Optionalcreatedmask to filter exact matching user creator
Optionalorderorder by desc order (default true)
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpathmask to filter exact matching path
Optionalpathmask to filter matching starting path
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalstarred(default false) show only the starred items
All apps
app list
app secret
app updated
update app
Optionalforce_Optionalforce_Optionalforce_Optionalpath?: stringOptionalraw_Optionalcache_Optionallock?: stringOptionalpath?: stringjob uuid
app details
resource value
Optionalactionfilter on type of operation
Optionalafter?: stringfilter on created after (exclusive) timestamp
Optionalbefore?: stringfilter on created before (exclusive) timestamp
Optionaloperation?: stringfilter on exact or prefix name of operation
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalresource?: stringfilter on exact or prefix name of resource
Optionalusername?: stringfilter on exact username of user
a list of audit logs
captured flow preview
capture does not exist for this flow
flow preview capture created
flow preview captured
Optionalallget jobs from all workspaces (only valid if request come from the admins workspace)
Optionalargs?: stringfilter on jobs containing those args as a json subset (@> in postgres)
OptionalconcurrencyOptionalcreatedmask to filter exact matching user creator
Optionalcreatedfilter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
Optionalcreatedfilter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
Optionalhashas null parent
Optionalisis the job a flow step
Optionalisis not a scheduled job
Optionalisis the job skipped
Optionaljobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
Optionallabel?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
Optionalpage?: numberwhich page to return (start at 1, default 1)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalresult?: stringfilter on jobs containing those result as a json subset (@> in postgres)
OptionalrowOptionalrunning?: booleanfilter on running jobs
Optionalschedulemask to filter by schedule path
Optionalscheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
Optionalscriptmask to filter exact matching path
Optionalscriptmask to filter exact matching path
Optionalscriptmask to filter matching starting path
Optionalstartedfilter on started after (exclusive) timestamp
Optionalstartedfilter on started before (inclusive) timestamp
Optionalsuccess?: booleanfilter on successful jobs
Optionaltag?: stringfilter on jobs with a given tag/worker group
time
Optionalvalue?: unknowndraft created
draft deleted
Optionallimit?: numberquery limit
query text
resource type details
OptionalrequestOptionalfavorite_Optionalpath?: stringstar item
OptionalrequestOptionalfavorite_Optionalpath?: stringunstar item
archiveFlow
Optionalarchived?: booleanflow archived
Partially filled flow
flow created
flow delete
flow details
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpernumber of items to return for a given page (default 30, max 100)
input history for completed jobs with this flow path
Optionalcreatedmask to filter exact matching user creator
Optionalorderorder by desc order (default true)
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpathmask to filter exact matching path
Optionalpathmask to filter matching starting path
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalshow(default false) show also the archived files. when multiple archived hash share the same path, only the ones with the latest create_at are displayed.
Optionalstarred(default false) show only the starred items
All flow
list of flow paths
flow list
Workspace error handler enabled
Optionalmuted?: booleanerror handler toggled
Partially filled flow
flow updated
owner user to folder
owner added to folder
create folder
Optionalextra_Optionalowners?: string[]folder created
folder deleted
folder
Optionalonlyonly list the folders the user is member of (default false)
folder list
added owner to folder
Optionalwrite?: booleanowner removed from folder
update folder
Optionalextra_Optionalowners?: string[]folder updated
added user to group
Optionalusername?: stringuser added to group
create group
Optionalsummary?: stringgroup created
group deleted
Optionalonlyonly list the groups the user is member of (default false)
group list
added user to group
Optionalusername?: stringuser removed from group
updated group
Optionalsummary?: stringgroup updated
Input
OptionalrunnableOptionalrunnableInput created
Input deleted
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpernumber of items to return for a given page (default 30, max 100)
OptionalrunnableOptionalrunnableInput history for completed jobs
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpernumber of items to return for a given page (default 30, max 100)
OptionalrunnableOptionalrunnableSaved Inputs for a Runnable
UpdateInput
Input updated
args
Optionalstorage?: stringConfirmation
OptionalresourceOptionals3Optionalstorage?: stringChunk of the downloaded file
OptionalresourceOptionals3The downloaded file
S3 resource to connect to
Optionals3_Connection settings
Optionalconnection_Optionalmarker?: stringOptionalprefix?: stringOptionalstorage?: stringList of file keys
Optionalnext_Optionalrestricted_Optionallimit?: numberOptionaloffset?: numberOptionalsearchOptionalsearchOptionalsortOptionalsortOptionalstorage?: stringCsv Preview
Optionalstorage?: stringFileMetadata
OptionalcsvOptionalcsvOptionalfileOptionalfileOptionalreadOptionalreadOptionalstorage?: stringFilePreview
Optionallimit?: numberOptionaloffset?: numberOptionalsearchOptionalsearchOptionalsortOptionalsortOptionalstorage?: stringParquet Preview
Optionalstorage?: stringConfirmation
S3 resource to connect to
Optionals3_Connection settings
Optionalkey?: stringOptionalsecret?: stringOptionalstorage?: stringConnection settings
OptionalfileOptionalfileFile content
OptionalresourceOptionals3Optionalstorage?: stringFile upload status
S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
Optionals3_Connection settings
S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
Optionals3_Connection settings
Optionalkey?: stringOptionalsecret?: stringOptionalaws_Optionalaws_S3 resource path to use. If empty, the S3 resource defined in the workspace settings will be used
Optionals3_Connection settings
parameters for statistics retrieval
Optionalfrom_Optionaltimeseries_Optionalto_job details
Optionalmetrics_Optionalscalar_Optionaltimeseries_completed count
job details
Optionalargs?: stringfilter on jobs containing those args as a json subset (@> in postgres)
Optionalcreatedmask to filter exact matching user creator
Optionalhashas null parent
Optionalisis the job a flow step
Optionalisis not a scheduled job
Optionalisis the job skipped
Optionaljobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
Optionallabel?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
Optionalorderorder by desc order (default true)
Optionalpage?: numberwhich page to return (start at 1, default 1)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalresult?: stringfilter on jobs containing those result as a json subset (@> in postgres)
Optionalschedulemask to filter by schedule path
Optionalscriptmask to filter exact matching path
Optionalscriptmask to filter exact matching path
Optionalscriptmask to filter matching starting path
Optionalstartedfilter on started after (exclusive) timestamp
Optionalstartedfilter on started before (inclusive) timestamp
Optionalsuccess?: booleanfilter on successful jobs
Optionaltag?: stringfilter on jobs with a given tag/worker group
All completed jobs
job resumed
flow user state updated
new value
flow user state updated
Optionalapprover?: stringjob signature
Optionalallget jobs from all workspaces (only valid if request come from the admins workspace)
Optionalargs?: stringfilter on jobs containing those args as a json subset (@> in postgres)
Optionalcreatedmask to filter exact matching user creator
Optionalcreatedfilter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
Optionalcreatedfilter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
Optionalhashas null parent
Optionalisis the job a flow step
Optionalisis not a scheduled job
Optionalisis the job skipped
Optionaljobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
Optionallabel?: stringmask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
Optionalpage?: numberwhich page to return (start at 1, default 1)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalresult?: stringfilter on jobs containing those result as a json subset (@> in postgres)
Optionalrunning?: booleanfilter on running jobs
Optionalschedulemask to filter by schedule path
Optionalscheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
Optionalscriptmask to filter exact matching path
Optionalscriptmask to filter exact matching path
Optionalscriptmask to filter matching starting path
Optionalstartedfilter on started after (exclusive) timestamp
Optionalstartedfilter on started before (inclusive) timestamp
Optionalsuccess?: booleanfilter on successful jobs
Optionaltag?: stringfilter on jobs with a given tag/worker group
All jobs
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalqueueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
script args
job result
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
OptionalqueueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
script args
job result
uuids of canceled jobs
Optionalallget jobs from all workspaces (only valid if request come from the admins workspace)
queue count
Optionalallget jobs from all workspaces (only valid if request come from the admins workspace)
Optionalargs?: stringfilter on jobs containing those args as a json subset (@> in postgres)
Optionalcreatedmask to filter exact matching user creator
Optionalisis not a scheduled job
Optionaljobfilter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
Optionalorderorder by desc order (default true)
Optionalpage?: numberwhich page to return (start at 1, default 1)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalresult?: stringfilter on jobs containing those result as a json subset (@> in postgres)
Optionalrunning?: booleanfilter on running jobs
Optionalschedulemask to filter by schedule path
Optionalscheduledfilter on jobs scheduled_for before now (hence waitinf for a worker)
Optionalscriptmask to filter exact matching path
Optionalscriptmask to filter exact matching path
Optionalscriptmask to filter matching starting path
Optionalstartedfilter on started after (exclusive) timestamp
Optionalstartedfilter on started before (inclusive) timestamp
Optionalsuccess?: booleanfilter on successful jobs
Optionalsuspended?: booleanfilter on suspended jobs
Optionaltag?: stringfilter on jobs with a given tag/worker group
All queued jobs
for branchall or loop, the iteration at which the flow should restart
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
Optionalinvisiblemake the run invisible to the the flow owner (default false)
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
flow args
Optionalscheduledwhen to schedule this job (leave empty for immediate run)
Optionalscheduledschedule the script to execute in the number of seconds starting now
step id to restart the flow from
Optionaltag?: stringOverride the tag to use
job created
job result
Optionalapprover?: stringurl endpoints
raw script content
dependency job result
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
Optionalinvisiblemake the run invisible to the the flow owner (default false)
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
flow args
Optionalscheduledwhen to schedule this job (leave empty for immediate run)
Optionalscheduledschedule the script to execute in the number of seconds starting now
Optionaltag?: stringOverride the tag to use
job created
OptionalcacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
Optionalinvisiblemake the run invisible to the the script owner (default false)
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
Partially filled args
Optionalscheduledwhen to schedule this job (leave empty for immediate run)
Optionalscheduledschedule the script to execute in the number of seconds starting now
Optionaltag?: stringOverride the tag to use
job created
OptionalcacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
Optionalinvisiblemake the run invisible to the the script owner (default false)
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
script args
Optionalscheduledwhen to schedule this job (leave empty for immediate run)
Optionalscheduledschedule the script to execute in the number of seconds starting now
Optionaltag?: stringOverride the tag to use
job created
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
Optionalinvisiblemake the run invisible to the the script owner (default false)
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
preview
job created
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
Optionalinvisiblemake the run invisible to the the script owner (default false)
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
preview
job created
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalqueueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
script args
job result
OptionalcacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
Optionalpayload?: stringThe base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
encodeURIComponent(btoa(JSON.stringify({a: 2})))
OptionalqueueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
Optionaltag?: stringOverride the tag to use
job result
OptionalcacheOverride the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
OptionalincludeList of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
OptionaljobThe job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
OptionalparentThe parent job that is at the origin and responsible for the execution of this script if any
OptionalqueueThe maximum size of the queue for which the request would get rejected if that job would push it above that limit
script args
Optionaltag?: stringOverride the tag to use
job result
preview
job created
Optionalapprover?: stringjob canceled
Optionalapprover?: stringjob canceled
job details
result
Optionalgetresult
Optionalstarted?: booleanOptionalsuccess?: booleanOptionalapprover?: stringflow debug info details
job log
job details
get root job id
OptionallogOptionalrunning?: booleanjob details
Optionalcompleted?: booleanOptionalflow_Optionallog_Optionalmem_Optionalnew_Optionalrunning?: booleanreason
Optionalreason?: stringjob canceled
reason
Optionalreason?: stringpersistent job scaled down to zero
reason
Optionalreason?: stringjob canceled
Optionalapprover?: stringOptionalpayload?: stringThe base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
encodeURIComponent(btoa(JSON.stringify({a: 2})))
job resumed
Optionalapprover?: stringjob resumed
code endpoint
slack token
code endpoint
Optionalrefresh_account set
disconnected client
disconnected slack
variable path
token refreshed
new oidc token
new raw app
raw app created
app deleted
app exists
Optionalcreatedmask to filter exact matching user creator
Optionalorderorder by desc order (default true)
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpathmask to filter exact matching path
Optionalpathmask to filter matching starting path
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalstarred(default false) show only the starred items
All raw apps
updateraw app
Optionalpath?: stringOptionalsummary?: stringOptionalvalue?: stringapp updated
new resource
Optionalupdateresource created
resource deleted
does resource exists
resource value
Optionaljobjob id
resource value
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalresourceresource_types to list from, separated by ',',
Optionalresourceresource_types to not list from, separated by ',',
resource list
resource list names
resource list
new resource_type
resource_type created
resource_type deleted
does resource_type exist
resource_type deleted
resource_type list
resource_type list
updated resource_type
resource_type updated
updated resource
resource updated
updated resource
Optionalvalue?: unknownresource value updated
new schedule
schedule created
schedule deleted
schedule exists
Optionalargs?: stringfilter on jobs containing those args as a json subset (@> in postgres)
OptionalisOptionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpath?: stringfilter by path
Optionalpernumber of items to return for a given page (default 30, max 100)
schedule list
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpernumber of items to return for a given page (default 30, max 100)
schedule list
Handler description
Optionalextra_Optionalnumber_Optionalnumber_Optionalpath?: stringOptionalworkspace_default error handler set
updated schedule enable
schedule enabled set
updated schedule
schedule updated
script archived
script path
script details
Optionallock?: stringOptionallock_does it exists
script details
script history
Script deployment message
Optionaldeployment_success
Optionalcreatedmask to filter exact matching user creator
Optionalfirstmask to filter scripts whom first direct parent has exact hash
Optionalhide(default false) hide the scripts without an exported main function
Optionalis(default regardless) if true show only the templates if false show only the non templates if not defined, show all regardless of if the script is a template
Optionalkinds?: string(default regardless) script kinds to filter, split by comma
Optionallastmask to filter scripts whom last parent in the chain has exact hash. Beware that each script stores only a limited number of parents. Hence the last parent hash for a script is not necessarily its top-most parent. To find the top-most parent you will have to jump from last to last hash until finding the parent
Optionalorderorder by desc order (default true)
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalparentis the hash present in the array of stored parent hashes for this script. The same warning applies than for last_parent_hash. A script only store a limited number of direct parent
Optionalpathmask to filter exact matching path
Optionalpathmask to filter matching starting path
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalshow(default false) show also the archived files. when multiple archived hash share the same path, only the ones with the latest create_at are ed.
Optionalstarred(default false) show only the starred items
All scripts
list of script paths
script list
script content
script content
Workspace error handler enabled
Optionalmuted?: booleanerror handler toggled
delete user
is owner
user
new user
edited user
Optionalalreadynew variable
variable created
variable deleted
new variable
encrypted value
variable
Optionaldecryptask to decrypt secret if this variable is secret (if not secret no effect, default: true)
Optionalincludeask to include the encrypted value if secret and decrypt secret is not true (default: false)
variable
variable
variable list
contextual variable list
Optionalalreadyupdated variable
variable updated
WorkspaceInvite
Optionalusername?: stringstatus
status
OptionalrequestOptionalnew_Optionalnew_status
OptionalrequestOptionalnew_status
status
Optionaldefault_status
OptionalrequestWorkspace default app
status
WorkspaceInvite
status
WorkspaceInvite
Optionalauto_Optionalinvite_Optionaloperator?: booleanstatus
WorkspaceCopilotConfig
Optionalopenai_status
Workspace default app
Optionaldefault_status
Optionaldeploy_status
WorkspaceErrorHandler
Optionalerror_Optionalerror_Optionalerror_status
Workspace Git sync settings
Optionalgit_status
LargeFileStorage info
Optionallarge_status
WorkspaceInvite
Optionalslack_status
WorkspaceWebhook
Optionalwebhook?: stringstatus
status
New encryption key
status
status
status
Optionaldeploy_status
status
Optionalauto_Optionalauto_Optionalauto_Optionalcustomer_Optionaldefault_Optionaldefault_Optionaldeploy_Optionalerror_Optionalerror_Optionalgit_Optionallarge_Optionalopenai_Optionalplan?: stringOptionalslack_Optionalslack_Optionalslack_Optionalwebhook?: stringOptionalworkspace_status
WorkspaceInvite
status
status
status
user
status
Optionalseats?: numberOptionalusage?: numberpath to hub script to run and its corresponding args
Optionalchannel?: stringOptionalhub_Optionaltest_status
Optionaljob_automatic billing
Optionalseats?: numberstatus
Workspace default app
Optionalvalue?: stringstatus
usage
list of custom tags
whether a worker with the tag exists
list of default tags
is the default tags per workspace
Optionalpage?: numberwhich page to return (start at 1, default 1)
Optionalpernumber of items to return for a given page (default 30, max 100)
Optionalpingnumber of seconds the worker must have had a last ping more recent of (default to 300)
a list of workers
metrics
domain allowed or not
new token
token created
status
id of workspace
status
status
status
workspace with associated username
app