Skip to navigation

Create script

View as Markdown

Creates a script and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required. Anything this script refers to must already exist.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
signatureobjectRequired
The script's name, description, input arguments and result schema. The name is the key the script is referenced by.
codestringRequired>=1 character
Script code. Inputs are available by their argument names, and the last line must be an expression whose value is returned.
versionobjectRequired
Document version. On update, send back the num from your last read.
secretslist of objectsOptional
Secrets the script can read by name.

Response

The created script
idstringOptionalRead-only
Unique identifier of the script, assigned by the server.
signatureobjectOptional
The script's name, description, input arguments and result schema. The name is the key the script is referenced by.
languagestringOptionalRead-only
Programming language of the script. Set to PYTHON for scripts created through this API.
codestringOptional>=1 character
Script code. Inputs are available by their argument names, and the last line must be an expression whose value is returned.
secretslist of objectsOptional
Secrets the script can read by name.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error