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 service-refresh-controller API

The service-refresh-controller API from Tessell — 4 operation(s) for service-refresh-controller.

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

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

This API exposes 6 operations across 4 paths, and defines 21 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

6 operations 4 paths 21 schemas 1 DELETE1 GET3 PATCH1 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 service-refresh-controller API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 6

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

service-refresh-controller 6
PATCH
/services/{id}/refresh
Refresh service with parent service's snapshot or pitr.
refreshService 2 params body → 200default
GET
/services/{id}/schedules/refresh
Fetch all the refresh schedules for a service
getRefreshSchedules 3 params → 200default
POST
/services/{id}/schedules/refresh
Create refresh schedule for a service
createRefreshSchedule 2 params body → 200201default
PATCH
/services/{service-id}/schedules/refresh/{id}
Update the refresh schedule
updateRefreshSchedule 3 params body → 200default
DELETE
/services/{service-id}/schedules/refresh/{id}
Delete the refresh schedule
deleteRefreshSchedule 3 params → 200default
PATCH
/services/{service-id}/schedules/refresh/{id}/{action}
Update the refresh schedule status
updateRefreshScheduleStatus 4 params → 200default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are RefreshScheduleDTO (12 properties), ApiError (7 properties), RefreshServicePayload (6 properties), taskSummary (5 properties). Each schema is shown below with its type and property counts.

apiStatus
object
2 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
apiResponse
object
2 properties
WeekDay
string
Week Days
apiPaginationInfo
object
2 properties
taskSummary
object
5 properties
RefreshScheduleStatus
RefreshScheduleRecurrenceInfo
object
3 properties 1 required
RefreshScheduleMetadata
object
2 properties
GetRefreshSchedulesResponse
BackupType
string
Backup Content Type
PrePostScriptInfo
object
2 properties
CloneSourceType
string
Source type for clone/refresh operation
apiMetadata
object
3 properties
RefreshScheduleInfo
object
1 property
ScriptInfo
object
4 properties
TimeFormat
object
Clock time format value in hour and minute.
2 properties 2 required
RefreshServicePayload
object
6 properties
CreateUpdateRefreshSchedulePayload
object
4 properties
RefreshScheduleRefreshMode
RefreshScheduleDTO
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-service-refresh-controller-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