/schedules (POST)

POST

/schedules

curl --request POST \
  --url https://example.com/api/v1/schedules \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "target": "app_container", "appId": "example", "serverId": "example", "command": "example", "shell": "bash", "cron": "example", "timezone": "example" }'

Request Body ^required

Media type application/json

object

name

required

string

>= 1 characters <= 80 characters

target

required

Any of:

string

string

Allowed values: app_container

string

string

Allowed values: service

string

string

Allowed values: server

appId

string

serverId

string

command

required

string

>= 1 characters <= 4096 characters

shell

Any of:

string

string

Allowed values: bash

string

string

Allowed values: sh

cron

required

string

>= 9 characters <= 64 characters

timezone

string

<= 64 characters

Responses

201

Default Response

Media type application/json

object

id

required

string

name

required

string

target

required

Any of:

string

string

Allowed values: app_container

string

string

Allowed values: service

string

string

Allowed values: server

appId

required

Any of:

string

string

null

null

serverId

required

Any of:

string

string

null

null

command

required

string

shell

required

string

cron

required

string

timezone

required

string

enabled

required

boolean

createdAt

required

string format: date-time

Example

{
  "target": "app_container"
}

400

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}