ScriptCollection.create¶
Beta: This API may change shape in 0.1.x. It is not a frozen 1.0 contract.
Create a script + version 1 from a local file.
Required kwarg: file_path. Optional: name, description,
message. Server: POST /api/scripts/ (multipart).
Signature¶
create(**kwargs: Any) -> Script
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
**kwargs |
Any |
no | - |
Fields¶
| Field | Type | Required |
|---|---|---|
description |
string |
no |
file |
string |
yes |
message |
string |
no |
name |
string |
yes |
project_id |
string |
yes |
Return shape¶
HTTP 201 — Created
Schema: ScriptUploadResult
| Field | Type | Required |
|---|---|---|
created_version |
boolean |
yes |
script |
ScriptSchema |
yes |
version |
ScriptVersionSchema |
yes |
Permission¶
Required permission: script:create
HTTP¶
POST /api/scripts/ (createScript)
Usage¶
script_collection.create()