Cloudsuo
Home

Schedule

POST
/schedule.create

Authorization

Authorization

Request Body

application/json

scheduleId?string
name*string
description?string|null
cronExpression*string
appName?string
serviceName?string|null
shellType?string
Value in"bash" | "sh"
scheduleType?string
Value in"application" | "compose" | "server" | "dokploy-server"
command*string
script?string|null
applicationId?string|null
composeId?string|null
serverId?string|null
organizationId?string|null
enabled?boolean
timezone?string|null
createdAt?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/schedule.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "cronExpression": "string",    "command": "string"  }'
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}
POST
/schedule.update

Authorization

Authorization

Request Body

application/json

scheduleId*string
Length1 <= length
name*string
description?string|null
cronExpression*string
appName?string
serviceName?string|null
shellType?string
Value in"bash" | "sh"
scheduleType?string
Value in"application" | "compose" | "server" | "dokploy-server"
command*string
script?string|null
applicationId?string|null
composeId?string|null
serverId?string|null
organizationId?string|null
enabled?boolean
timezone?string|null
createdAt?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/schedule.update" \  -H "Content-Type: application/json" \  -d '{    "scheduleId": "string",    "name": "string",    "cronExpression": "string",    "command": "string"  }'
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}
POST
/schedule.delete

Authorization

Authorization

Request Body

application/json

scheduleId*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/schedule.delete" \  -H "Content-Type: application/json" \  -d '{    "scheduleId": "string"  }'
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}
GET
/schedule.list

Authorization

Authorization

Query Parameters

id*string
scheduleType*string
Value in"application" | "compose" | "server" | "dokploy-server"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/schedule.list?id=string&scheduleType=application"
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}
GET
/schedule.one

Authorization

Authorization

Query Parameters

scheduleId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/schedule.one?scheduleId=string"
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}
POST
/schedule.runManually

Authorization

Authorization

Request Body

application/json

scheduleId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/schedule.runManually" \  -H "Content-Type: application/json" \  -d '{    "scheduleId": "string"  }'
{}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Rollback

Previous Page

Security

Next Page