Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tessell maintenance-window API

The maintenance-window API from Tessell — 3 operation(s) for maintenance-window.

Tessell maintenance-window API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include maintenance-window. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 7 operations across 3 paths, and defines 27 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, {server}.

7 operations 3 paths 27 schemas 1 DELETE2 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.console.tessell.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Tessell maintenance-window API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

maintenance-window 7
GET
/services/{id}/maintenance-windows
Get maintenance windows for given service
getMaintenanceWindowsForService 7 params → 200default
PATCH
/services/{id}/maintenance-windows
Update maintenance window config for given service
updateMaintenanceWindowForService 2 params body → 200default
GET
/maintenance-windows/{id}
Get maintenance window by Id
getMaintenanceWindowById 2 params → 200default
PATCH
/maintenance-windows/{id}
Update maintenance window
updateMaintenanceWindow 2 params body → 200default
POST
/maintenance-windows/{id}
Trigger maintenance window
triggerMaintenanceWindow 2 params body → 200default
POST
/maintenance-windows/{id}/tasks
Apply Maintenance Window Task
applyMaintenanceWindowTasks 2 params body → 200default
DELETE
/maintenance-windows/{id}/tasks
Remove task from existing maintenance window
cancelMaintenanceWindowTask 2 params body → 200default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are TaskDTO (15 properties), MaintenanceWindowDTO (11 properties), ApiError (7 properties), taskSummary (5 properties). Each schema is shown below with its type and property counts.

MaintenanceWindowTaskApplyAction
string
apiStatus
object
2 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
apiResponse
object
2 properties
apiPaginationInfo
object
2 properties
TaskStatus
string
The status of Task
ApplyStrategy
string
TaskType
string
The type of Task
MaintenanceWindowUpdateRequest
object
Update of a specific Maintenance Window
2 properties
TaskResponseStatus
string
TaskResponse
object
5 properties
taskSummary
object
5 properties
MaintenanceWindowType
string
The type of maintenance window
TaskResponseConflicts
object
1 property
TaskOperation
string
The operation that the Task corresponds to
apiMetadata
object
3 properties
entityType
string
Tessell Entity Type
MaintenanceWindowSummary
object
User view summary for Maintenance Window
5 properties
TessellServiceMaintenanceWindow
object
Base class for maintenance window configurations. Supports multiple cadences: Weekly, Monthly, and Quarterly. Use concrete subclasses: WeeklyMaintenanceWindow,…
3 properties 3 required
MaintenanceWindowDTO
object
User view for Maintenance Window
11 properties
MaintenanceWindowExecutionInfo
object
Execution details for Maintenance Window
3 properties
ApplyConfig
object
Application Details for any operation
4 properties
MaintenanceWindowListResponse
TaskDTO
object
User view for Task
15 properties
MaintenanceWindowTaskCancelRequest
object
Request to cancel QUEUED Maintenance Window Task
1 property
MaintenanceWindowStatus
string
The status of maintenance window
MaintenanceWindowTaskApplyRequest
object
Request to APPLY Maintenance Window Task
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-maintenance-window-api-openapi.yml Raw ↑

Other APIs Tessell publishes across the network.

Tessell activity-center API
Tessell Ad Domain API
Tessell Ad Domain Governance API
Tessell agentController API
Tessell alert-controller API
Tessell Authorization API
Tessell Availability Machine API
Tessell azure-netapp-admin-controller API
Tessell azure-netapp-service-controller API
Tessell cloud-resource API
Tessell Compute API
Tessell Compute Governance API