Update script details
/scripts/{slug}Changes a script's name, description or visibility without adding a version. The slug stays the same when the name changes.
Scope | Heavy call | Long poll | CLI |
|---|---|---|---|
| No | No | None |
Guidance
Send only the fields to change. An empty object changes nothing and returns the script.
Renaming never moves the slug, so refs such as
my-ema@3in runs and studies keep working.Making a script
publiclets other accounts run it byyour-username/slugwithout seeing its source. Making itprivateagain stops that.A name you already use for another script of the same kind answers
409 conflict, and nothing changes.The path takes the bare slug only. When one of your studies shares the slug, add
kind.
Path parameters
Name | Type | Description |
|---|---|---|
| string | Your script's bare slug |
Query parameters
Name | Type | Required | Default | Description |
|---|---|---|---|---|
| string | No | None |
|
Request body
Every field is optional.
Field | Type | Required | Description |
|---|---|---|---|
| string | No | New display name |
| string | No | New description |
| string | No |
|
Response
200 with the Script at its latest version, without files.
Status codes
Status | Code | Meaning |
|---|---|---|
| - | The change was made, or there was nothing to change |
|
| The path is not a bare slug, the body is not JSON, |
|
| You cannot change this script |
|
| You have no script with that slug |
|
| A study shares the slug, so add |
