Maintenance And Upgrade

Manage scheduled maintenance and version upgrades for a service. View and set maintenance windows, list maintenance activities, apply or schedule (reschedule) them, and trigger database and Kubernetes version upgrades.

Read Maintenance Windows

get

Retrieve a list of available maintenance windows

Authorizations

X-API-KeystringRequired

Responses

200

application/json

display_namestringOptional

idstringOptional

namestringOptional

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/provisioning/v1/maintenance-windows

GET /provisioning/v1/maintenance-windows HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "display_name": "text",
    "id": "text",
    "name": "text"
  }
]

Set Service Maintenance Window

post

Set the maintenance window the service.

Authorizations

X-API-KeystringRequired

Path parameters

service_idstringRequired

The ID for the service.

Body

namestringOptional

Responses

200

No content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/provisioning/v1/services/{service_id}/maintenance-window

POST /provisioning/v1/services/{service_id}/maintenance-window HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

No content

List Maintenance Activities

get

Retrieve the list of maintenance activities for a specific service.

Authorizations

X-API-KeystringRequired

Path parameters

service_idstringRequired

The ID for the service.

Query parameters

include_completedbooleanOptional

Include completed/failed/cancelled activities (default: true)

Responses

200

application/json

auto_apply_afterstringOptional

classificationstring · enumOptionalPossible values:

completed_atstringOptional

created_bystringOptional

created_onstringOptional

current_versionstringOptional

deferral_countintegerOptional

deferred_untilstringOptional

descriptionstringOptional

expected_impactstring · enumOptionalPossible values:

expected_impact_descriptionstringOptional

expected_impact_labelstringOptional

ExpectedImpactLabel / ExpectedImpactDescription are the backend-owned display strings for ExpectedImpact — the UI renders them verbatim instead of mapping the enum itself.

forced_apply_bystringOptional

idstringOptional

is_criticalbooleanOptional

metadataobjectOptional

prioritystring · enumOptionalPossible values:

reschedule_countintegerOptional

scheduled_atstringOptional

scheduled_windowstringOptional

service_idstringOptional

started_atstringOptional

statestring · enumOptionalPossible values:

target_completion_datestringOptional

target_versionstringOptional

updated_onstringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/provisioning/v1/services/{service_id}/maintenance

GET /provisioning/v1/services/{service_id}/maintenance HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "auto_apply_after": "text",
    "classification": "infrastructure",
    "completed_at": "text",
    "created_by": "text",
    "created_on": "text",
    "current_version": "text",
    "deferral_count": 1,
    "deferred_until": "text",
    "description": "text",
    "expected_impact": "no_downtime",
    "expected_impact_description": "text",
    "expected_impact_label": "text",
    "forced_apply_by": "text",
    "id": "text",
    "is_critical": true,
    "metadata": {},
    "priority": "recommended",
    "reschedule_count": 1,
    "scheduled_at": "text",
    "scheduled_window": "text",
    "service_id": "text",
    "started_at": "text",
    "state": "available",
    "target_completion_date": "text",
    "target_version": "text",
    "updated_on": "text"
  }
]

Apply Maintenance Activities

post

Immediately execute maintenance activities for a service. If the request body contains an empty activity_ids array, all active activities are applied. Activities are executed sequentially (infrastructure first, then security, then database). If the service is not ready, activities are rescheduled to the next maintenance window.

Authorizations

X-API-KeystringRequired

Path parameters

service_idstringRequired

The ID for the service.

Bodystring[]

string[]Optional

Responses

200

application/json

auto_apply_afterstringOptional

classificationstring · enumOptionalPossible values:

completed_atstringOptional

created_bystringOptional

created_onstringOptional

current_versionstringOptional

deferral_countintegerOptional

deferred_untilstringOptional

descriptionstringOptional

expected_impactstring · enumOptionalPossible values:

expected_impact_descriptionstringOptional

expected_impact_labelstringOptional

ExpectedImpactLabel / ExpectedImpactDescription are the backend-owned display strings for ExpectedImpact — the UI renders them verbatim instead of mapping the enum itself.

forced_apply_bystringOptional

idstringOptional

is_criticalbooleanOptional

metadataobjectOptional

prioritystring · enumOptionalPossible values:

reschedule_countintegerOptional

scheduled_atstringOptional

scheduled_windowstringOptional

service_idstringOptional

started_atstringOptional

statestring · enumOptionalPossible values:

target_completion_datestringOptional

target_versionstringOptional

updated_onstringOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/provisioning/v1/services/{service_id}/maintenance/apply

POST /provisioning/v1/services/{service_id}/maintenance/apply HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

[
  {
    "auto_apply_after": "text",
    "classification": "infrastructure",
    "completed_at": "text",
    "created_by": "text",
    "created_on": "text",
    "current_version": "text",
    "deferral_count": 1,
    "deferred_until": "text",
    "description": "text",
    "expected_impact": "no_downtime",
    "expected_impact_description": "text",
    "expected_impact_label": "text",
    "forced_apply_by": "text",
    "id": "text",
    "is_critical": true,
    "metadata": {},
    "priority": "recommended",
    "reschedule_count": 1,
    "scheduled_at": "text",
    "scheduled_window": "text",
    "service_id": "text",
    "started_at": "text",
    "state": "available",
    "target_completion_date": "text",
    "target_version": "text",
    "updated_on": "text"
  }
]

Schedule Maintenance Activities

post

Schedule maintenance activities for a service at a specific maintenance window. If the request body contains an empty activity_ids array, all active activities are scheduled. Also serves as reschedule/defer: a previously scheduled activity can be moved to a different window. Rejected if any active activity for the service is past its forced_apply_by deadline.

Authorizations

X-API-KeystringRequired

Path parameters

service_idstringRequired

The ID for the service.

Body

activity_idsstring[]Optional

namestringOptional

Responses

200

application/json

auto_apply_afterstringOptional

classificationstring · enumOptionalPossible values:

completed_atstringOptional

created_bystringOptional

created_onstringOptional

current_versionstringOptional

deferral_countintegerOptional

deferred_untilstringOptional

descriptionstringOptional

expected_impactstring · enumOptionalPossible values:

expected_impact_descriptionstringOptional

expected_impact_labelstringOptional

ExpectedImpactLabel / ExpectedImpactDescription are the backend-owned display strings for ExpectedImpact — the UI renders them verbatim instead of mapping the enum itself.

forced_apply_bystringOptional

idstringOptional

is_criticalbooleanOptional

metadataobjectOptional

prioritystring · enumOptionalPossible values:

reschedule_countintegerOptional

scheduled_atstringOptional

scheduled_windowstringOptional

service_idstringOptional

started_atstringOptional

statestring · enumOptionalPossible values:

target_completion_datestringOptional

target_versionstringOptional

updated_onstringOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/provisioning/v1/services/{service_id}/maintenance/schedule

POST /provisioning/v1/services/{service_id}/maintenance/schedule HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "activity_ids": [
    "text"
  ],
  "name": "text"
}

[
  {
    "auto_apply_after": "text",
    "classification": "infrastructure",
    "completed_at": "text",
    "created_by": "text",
    "created_on": "text",
    "current_version": "text",
    "deferral_count": 1,
    "deferred_until": "text",
    "description": "text",
    "expected_impact": "no_downtime",
    "expected_impact_description": "text",
    "expected_impact_label": "text",
    "forced_apply_by": "text",
    "id": "text",
    "is_critical": true,
    "metadata": {},
    "priority": "recommended",
    "reschedule_count": 1,
    "scheduled_at": "text",
    "scheduled_window": "text",
    "service_id": "text",
    "started_at": "text",
    "state": "available",
    "target_completion_date": "text",
    "target_version": "text",
    "updated_on": "text"
  }
]

Upgrade Database Version

post

Upgrade Database Version

Authorizations

X-API-KeystringRequired

Path parameters

service_idstringRequired

service id

Body

versionstringOptional

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/provisioning/v1/services/{service_id}/upgrade/database

POST /provisioning/v1/services/{service_id}/upgrade/database HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "version": "text"
}

No content

Upgrade Kubernetes Version

post

Upgrade Kubernetes Version

Authorizations

X-API-KeystringRequired

Path parameters

service_idstringRequired

service id

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post/provisioning/v1/services/{service_id}/upgrade/kubernetes_version

POST /provisioning/v1/services/{service_id}/upgrade/kubernetes_version HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

PreviousServices NextCopilot

Last updated 21 days ago

Was this helpful?