Schedule

POST

/schedule.create

Schedule create

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`scheduleId`string

`name`
Required
string

`cronExpression`
Required
string

`appName`string

`serviceName`string | null

`shellType`string

Value in: "bash" | "sh"

`scheduleType`string

Value in: "application" | "compose" | "server" | "dokploy-server"

`command`
Required
string

`script`string | null

`applicationId`string | null

`composeId`string | null

`serverId`string | null

`userId`string | null

`enabled`boolean

`createdAt`string

curl -X POST "https://your-dokploy-instance.com/api/schedule.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduleId": "string",
    "name": "string",
    "cronExpression": "string",
    "appName": "string",
    "serviceName": "string",
    "shellType": "bash",
    "scheduleType": "application",
    "command": "string",
    "script": "string",
    "applicationId": "string",
    "composeId": "string",
    "serverId": "string",
    "userId": "string",
    "enabled": true,
    "createdAt": "string"
  }'

Successful response

{}

POST

/schedule.update

Schedule update

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`scheduleId`
Required
string

Minimum length: 1

`name`
Required
string

`cronExpression`
Required
string

`appName`string

`serviceName`string | null

`shellType`string

Value in: "bash" | "sh"

`scheduleType`string

Value in: "application" | "compose" | "server" | "dokploy-server"

`command`
Required
string

`script`string | null

`applicationId`string | null

`composeId`string | null

`serverId`string | null

`userId`string | null

`enabled`boolean

`createdAt`string

curl -X POST "https://your-dokploy-instance.com/api/schedule.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduleId": "string",
    "name": "string",
    "cronExpression": "string",
    "appName": "string",
    "serviceName": "string",
    "shellType": "bash",
    "scheduleType": "application",
    "command": "string",
    "script": "string",
    "applicationId": "string",
    "composeId": "string",
    "serverId": "string",
    "userId": "string",
    "enabled": true,
    "createdAt": "string"
  }'

Successful response

{}

POST

/schedule.delete

Schedule delete

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`scheduleId`
Required
string

curl -X POST "https://your-dokploy-instance.com/api/schedule.delete" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduleId": "string"
  }'

Successful response

{}

GET

/schedule.list

Schedule list

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`id`
Required
string

`scheduleType`
Required
string

Value in: "application" | "compose" | "server" | "dokploy-server"

curl -X GET "https://your-dokploy-instance.com/api/schedule.list?id=string&scheduleType=application" \
  -H "Authorization: <token>"

Successful response

{}

GET

/schedule.one

Schedule one

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`scheduleId`
Required
string

curl -X GET "https://your-dokploy-instance.com/api/schedule.one?scheduleId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST

/schedule.runManually

Schedule run Manually

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`scheduleId`
Required
string

Minimum length: 1

curl -X POST "https://your-dokploy-instance.com/api/schedule.runManually" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduleId": "string"
  }'

Successful response

{}

Body

Authorization<token>

scheduleIdstring

nameRequiredstring

cronExpressionRequiredstring

appNamestring

serviceNamestring | null

shellTypestring

scheduleTypestring

commandRequiredstring

scriptstring | null

applicationIdstring | null

composeIdstring | null

serverIdstring | null

userIdstring | null

enabledboolean

createdAtstring

Response

TypeScript

Body

Authorization<token>

scheduleIdRequiredstring

nameRequiredstring

cronExpressionRequiredstring

appNamestring

serviceNamestring | null

shellTypestring

scheduleTypestring

commandRequiredstring

scriptstring | null

applicationIdstring | null

composeIdstring | null

serverIdstring | null

userIdstring | null

enabledboolean

createdAtstring

Response

TypeScript

Body

Authorization<token>

scheduleIdRequiredstring

Response

TypeScript

Query

Authorization<token>

idRequiredstring

scheduleTypeRequiredstring

Response

TypeScript

Query

Authorization<token>

scheduleIdRequiredstring

Response

TypeScript

Body

Authorization<token>

scheduleIdRequiredstring

Response

TypeScript

`Authorization`<token>

`scheduleId`string

`name`
Required
string

`cronExpression`
Required
string

`appName`string

`serviceName`string | null

`shellType`string

`scheduleType`string

`command`
Required
string

`script`string | null

`applicationId`string | null

`composeId`string | null

`serverId`string | null

`userId`string | null

`enabled`boolean

`createdAt`string

`Authorization`<token>

`scheduleId`
Required
string

`name`
Required
string

`cronExpression`
Required
string

`appName`string

`serviceName`string | null

`shellType`string

`scheduleType`string

`command`
Required
string

`script`string | null

`applicationId`string | null

`composeId`string | null

`serverId`string | null

`userId`string | null

`enabled`boolean

`createdAt`string

`Authorization`<token>

`scheduleId`
Required
string

`Authorization`<token>

`id`
Required
string

`scheduleType`
Required
string

`Authorization`<token>

`scheduleId`
Required
string

`Authorization`<token>

`scheduleId`
Required
string