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

Create Supervisor Job

POST

/v2/servers/{{serverId}}/supervisors

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

label

string

required

Label of the job

username

string

required

System User that will be running this job

command

string

required

Command you wanted to run

numprocs

integer

required

Number of background job to run for this job

autoStart

boolean

optional

Auto start once supervisors start running, default is false

autoRestart

boolean

optional

Auto restart if job failed, default is false

binary

string

optional

Use one of the available binary selection, default value is /home/runcloud/queue.php

Example

{
    "label": "my-first-job",
    "username": "runcloud",
    "numprocs": 5,
    "autoStart": true,
    "autoRestart": true,
    "binary": "/RunCloud/Packages/php74rc/bin/php",
    "command": "/home/runcloud/queue.php"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://manage.runcloud.io/api/v2/servers/{{serverId}}/supervisors' \
--header 'Content-Type: application/json' \
--data-raw '{
    "label": "my-first-job",
    "username": "runcloud",
    "numprocs": 5,
    "autoStart": true,
    "autoRestart": true,
    "binary": "/RunCloud/Packages/php74rc/bin/php",
    "command": "/home/runcloud/queue.php"
}'

Responses

🟢200Success

application/json

Body

integer

required

label

string

required

username

string

required

numprocs

integer

required

autoStart

boolean

required

autoRestart

boolean

required