This API v3 documentation is currently still on progress. For any issue, please contact support@runcloud.io

Add new deployment script

POST

/atomic/{{atomicProjectId}}/scripts

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

name

string

required

Name of deployment script

scriptAction

string

required

Which part this code will be run "clone", "composer-install", or "make-live"

location

string

required

When this script will be run "before" or "after" scriptAction value

username

string

required

System user username that will run this script

script

string

required

Content of the script

webApplications

array[integer]

required

IDs of web application that use this script

Example

{
    "name":"first depcom",
    "scriptAction":"composer-install",
    "location":"before",
    "username":"runcloud",
    "script":"echo 'test'",
    "webApplications":[582]    
    }

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://manage.runcloud.io/api/v3/atomic/{{atomicProjectId}}/scripts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name":"first depcom",
    "scriptAction":"composer-install",
    "location":"before",
    "username":"runcloud",
    "script":"echo '\''test'\''",
    "webApplications":[582]    
    }'

Responses

🟢200Success

application/json

Body

message

string

required

Example

{
    "message": "Script first depcom has been successfully created."
}

Modified at 2024-10-16 09:06:16

List deployment scripts in atomic project

Update deployment script