Dokploy

Schedule

POST
/schedule.create

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

scheduleId?string
name*string
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
userId?string|null
enabled?boolean
timezone?string|null
createdAt?string
[key: string]?never

Response Body

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"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/schedule.update

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

scheduleId*string
Length1 <= length
name*string
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
userId?string|null
enabled?boolean
timezone?string|null
createdAt?string
[key: string]?never

Response Body

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"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/schedule.delete

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

scheduleId*string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/schedule.delete" \  -H "Content-Type: application/json" \  -d '{    "scheduleId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/schedule.list

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

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

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/schedule.list?id=string&scheduleType=application"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
GET
/schedule.one

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Query Parameters

scheduleId*string

Response Body

application/json

application/json

curl -X GET "https://your-dokploy-instance.com/api/schedule.one?scheduleId=string"
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}
POST
/schedule.runManually

Authorization

x-api-key

x-api-key<token>

API key authentication. Use YOUR-GENERATED-API-KEY

In: header

Request Body

application/json

scheduleId*string
Length1 <= length
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://your-dokploy-instance.com/api/schedule.runManually" \  -H "Content-Type: application/json" \  -d '{    "scheduleId": "string"  }'
{}
{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Rollback

Previous Page

Security

Next Page