Skip to main content
A newer release of this product is available.

Retrieve a schedule

Contributors
PDFs

GET /cluster/schedules/{uuid}

Retrieves a schedule.

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Schedule UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

cluster

cluster

The cluster that owns the schedule. Defaults to the local cluster.

cron

cron

Details for schedules of type cron.

interval

string

An ISO-8601 duration formatted string.

name

string

Schedule Name. Required in the URL or POST body.

type

string

Schedule type

uuid

string

Job schedule UUID
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "cluster": {
    "name": "cluster1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "cron": {
    "days": [
      "integer"
    ],
    "hours": [
      "integer"
    ],
    "minutes": [
      "integer"
    ],
    "months": [
      "integer"
    ],
    "weekdays": [
      "integer"
    ]
  },
  "interval": "P1DT2H3M4S",
  "name": "string",
  "type": "string",
  "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

cluster

The cluster that owns the schedule. Defaults to the local cluster.

Name Type Description

name

string

Cluster name

uuid

string

Cluster UUID

cron

Details for schedules of type cron.

Name Type Description

days

array[integer]

The days of the month the schedule runs. Leave empty for all.

hours

array[integer]

The hours of the day the schedule runs. Leave empty for all.

minutes

array[integer]

The minutes the schedule runs. Required on POST for a cron schedule.

months

array[integer]

The months of the year the schedule runs. Leave empty for all.

weekdays

array[integer]

The weekdays the schedule runs. Leave empty for all.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.