Skip to main content

Modify a schedule

Contributors
PDFs

PUT /accounts/{account_id}/k8s/v1/apps/{app_id}/schedules/{schedule_id}

Replaces the entire stored resource with the supplied JSON request body while preserving key values that are not user-modifiable.

Parameters

Name Type In Required Description

account_id

string

path

True

ID of the containing account resource

  • example: {{.Account}}

app_id

string

path

True

ID of the containing app resource

schedule_id

string

path

True

ID of the schedule collection to list

Request Body

Replaces the entire stored resource with the supplied JSON request body while preserving key values that are not user-modifiable.

Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-schedule"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

  • "1.1"

  • "1.2"

  • "1.3"

id

string

False

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

name

string

False

JSON string containing a name of the schedule. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

enabled

string

False

JSON string indicating if a schedule is active. Defined values are:

  • "true" - The schedule is active

  • "false" - The schedule is not active If not specified, the default value is "true".

granularity

string

False

JSON string indicating the granularity of the schedule. Defined values are:

  • "hourly"

  • "daily"

  • "weekly"

  • "monthly"

  • "custom"

minute

string

False

JSON string containing a numeric value indicating the minute of the hour (0 - 59) to execute the schedule. Defined values are:

  • Defined regex is: "^[0-9]|[1-5][0-9]$" This field is present if granularity is set to "hourly", "daily", "weekly", or "monthly". It will be returned with value "0" for custom schedules.

hour

string

False

JSON string containing a numeric value indicating the hour of the day (0 - 23) to execute the schedule. Defined values are:

  • Defined regex is: "^[0-9]|[1][0-9]|[2][0-3]$" This field is present if granularity is set to "daily", "weekly", or "monthly".

dayOfWeek

string

False

JSON string containing a numeric value indicating the day of the week (0-7) to execute the schedule. Defined values are:

  • Defined regex is: "^[0-7]$" This field is only present if granularity is set to "weekly".

dayOfMonth

string

False

JSON string containing a numeric value indicating the day of the month (1-31) to execute the schedule. Defined values are:

  • Defined regex is: "^[1-9]|[1-2][0-9]|[3][0-1]$" This field is only present if granularity is set to "monthly".

recurrenceRule

string

False

JSON string containing an RFC-5545 Section 3.8.5.3. Recurrence Rule. For the DTSTART parameter, only UTC timestamps (denoted by the "Z" suffix) are supported, and only timestamps before the current time are supported. For the RECUR rule parts, "FREQ" and "INTERVAL" are the only rule parts supported. For the FREQ rule part, "MINUTELY" and "HOURLY" are the only values supported. This field is only present if granularity is set to "custom".

snapshotRetention

string

True

JSON string containing a positive numeric value indicating how many snapshots to retain. Zero indicates that snapshots should be deleted after taking a backup. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

  • Defined regex is: "^(0|([1-9][0-9]*))$"

backupRetention

string

True

JSON string containing a positive numeric value indicating how many backups to retain. Zero indicates that no backups should be created. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

  • Defined regex is: "^(0|([1-9][0-9]*))$"

bucketID

string

False

JSON string containing an optional bucket ID indicating where the backup must be stored on create. If not specified, a system-selected bucket will be used. Defined values are:

  • Conforms to the Astra Identifier Schema

replicate

string

False

JSON string indicating if the schedule triggers AppMirror replication for each snapshot. Only takes effect if the application has an AppMirror relationship defined. Defined values are:

  • "true" - The schedule triggers AppMirror replication

  • "false" - The schedule does not trigger AppMirror replication If not specified, the default value is "false".

metadata

type_astra_metadata_update

False

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.
Example request 
{
  "type": "application/astra-schedule",
  "version": "1.3",
  "granularity": "daily",
  "minute": "0",
  "hour": "0",
  "snapshotRetention": "12",
  "backupRetention": "12"
}

Response

Status: 204, Indicates if the schedule resource was updated.

Response

Status: 401, Unauthorized
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

invalidFields

array[invalidFields]

False

List of invalid request body fields
Example response 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 409, Conflict
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

invalidFields

array[invalidFields]

False

List of invalid request body fields
Example response 
{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

Response

Status: 403, Forbidden
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Error

Status: 404, Not found
Name Type Required Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False
Example error response 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

type_astra_label

Name Type Required Description

name

string

True

value

string

True

type_astra_metadata_update

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name Type Required Description

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

invalidParams

Name Type Required Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

invalidFields

Name Type Required Description

name

string

True

Name of the invalid request body field

reason

string

True

Reason why the request body field is invalid