API reference
Every HTTP endpoint of the db-sqlserver module: authentication, IAM action, parameters, bodies and status codes.
Generated from the module's code when its image was built — do not edit. Paths are relative to https://api.example.com.
Docs
GET /docs/db-sqlserver/manifest.json
- Authentication: required
- Operation name:
DocsManifest_db-sqlserver
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
GET /docs/db-sqlserver/{path}
- Authentication: required
- Operation name:
DocsFile_db-sqlserver
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
SQL Server Compute Plans
GET /boundaries/{boundaryId}/resources/sqlservercomputeplans
List all available sqlservercomputeplans
- Authentication: required
- Operation name:
ListSQLServerComputePlans
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | PagedListResponse<SqlServerResourcePlanDto> |
401 |
Not signed in, or the token is invalid | |
500 |
Internal error | ProblemDetails |
GET /boundaries/{boundaryId}/resources/sqlservercomputeplans/{resourceId}
Get a specific sqlservercomputeplan by ID
- Authentication: required
- Operation name:
GetSQLServerComputePlan
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | SqlServerResourcePlanDto |
401 |
Not signed in, or the token is invalid | |
404 |
Not found | |
500 |
Internal error | ProblemDetails |
SQL Server Databases
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/connectionstring
Get the internal connection string for a SQL Server instance
- Authentication: required
- IAM action:
sqlservercluster/readSecrets— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/readSecrets at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/connectionstring/external
Get the external (LoadBalancer) connection string for a SQL Server instance
- Authentication: required
- IAM action:
sqlservercluster/readSecrets— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/readSecrets at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/external-ip
Get the externally reachable address of a SQL Server instance's ingress
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/health
Check if a SQL Server instance is healthy
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/license
Set or rotate the product key for a paid-edition SQL Server instance
- Authentication: required
- IAM action:
sqlservercluster/manageLicense— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
Request body: SetLicenseRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/manageLicense at the evaluated scope |
SQL Server Editor
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/history
List recent editor activity for an instance (most recent first).
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
limit |
query | integer |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/query
Classify, authorize, and (optionally) execute a T-SQL batch against a SQL Server instance.
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
Request body: EditorQueryRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/schemas
List schemas, tables, views, columns, and primary keys.
- Authentication: required
- IAM action:
sqlservercluster/schemaRead— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/schemaRead at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows
List rows in a table (PK-ordered, OFFSET/FETCH paging).
- Authentication: required
- IAM action:
sqlservercluster/dataRead— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
schema |
path | string |
Yes |
table |
path | string |
Yes |
limit |
query | integer |
No |
offset |
query | integer |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/dataRead at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows
Insert a row via structured payload.
- Authentication: required
- IAM action:
sqlservercluster/dataWrite— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
schema |
path | string |
Yes |
table |
path | string |
Yes |
Request body: RowMutationRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/dataWrite at the evaluated scope |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows/{pkValue}
Delete a row by single-column primary key.
- Authentication: required
- IAM action:
sqlservercluster/dataWrite— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
schema |
path | string |
Yes |
table |
path | string |
Yes |
pkValue |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/dataWrite at the evaluated scope |
PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows/{pkValue}
Update a row by single-column primary key.
- Authentication: required
- IAM action:
sqlservercluster/dataWrite— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
schema |
path | string |
Yes |
table |
path | string |
Yes |
pkValue |
path | string |
Yes |
Request body: RowMutationRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/dataWrite at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows:bulk
Update multiple rows in one transaction.
- Authentication: required
- IAM action:
sqlservercluster/dataWrite— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
schema |
path | string |
Yes |
table |
path | string |
Yes |
Request body: BulkUpdateRowsRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/dataWrite at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows:bulk-delete
Delete multiple rows in one transaction by single-column primary key.
- Authentication: required
- IAM action:
sqlservercluster/dataWrite— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
schema |
path | string |
Yes |
table |
path | string |
Yes |
Request body: BulkDeleteRowsRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/dataWrite at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows:bulk-insert
Insert multiple rows in one transaction.
- Authentication: required
- IAM action:
sqlservercluster/dataWrite— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
name |
path | string |
Yes |
schema |
path | string |
Yes |
table |
path | string |
Yes |
Request body: BulkInsertRowsRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/dataWrite at the evaluated scope |
SqlServer
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters
List all sqlserverclusters in a resource group
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path - Operation name:
ListSqlServers
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/config
Get list configuration for sqlserverclusters
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path - Operation name:
GetSqlServersConfig
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
resourceGroupName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}
Delete a sqlserver
- Authentication: required
- IAM action:
sqlservercluster/delete— evaluated at the resource in the path - Operation name:
DeleteSqlServer
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/delete at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}
Get a specific sqlserver
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path - Operation name:
GetSqlServer
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}
Partially update an existing sqlserver using JSON Merge Patch
- Authentication: required
- IAM action:
sqlservercluster/write— evaluated at the resource in the path - Operation name:
PatchSqlServer
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: any
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/write at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}
Create a new sqlserver
- Authentication: required
- IAM action:
sqlservercluster/write— evaluated at the resource in the path - Operation name:
CreateSqlServer
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: SqlServerInstanceDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/write at the evaluated scope |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}
Update an existing sqlserver
- Authentication: required
- IAM action:
sqlservercluster/write— evaluated at the resource in the path - Operation name:
UpdateSqlServer
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: SqlServerInstanceDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/write at the evaluated scope |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/actions/{action}
Execute a lifecycle action (start, stop, restart) on a sqlserver
- Authentication: required
- IAM action:
sqlservercluster/write— evaluated at the resource in the path - Operation name:
ExecuteSqlServerAction
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
action |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/write at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/scale
Get current scale of a sqlserver
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path - Operation name:
GetSqlServerScale
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/scale
Scale a sqlserver
- Authentication: required
- IAM action:
sqlservercluster/scale— evaluated at the resource in the path - Operation name:
ScaleSqlServer
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: ScaleRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/scale at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots
List snapshots of a sqlserver
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path - Operation name:
ListSqlServerSnapshots
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots
Create a snapshot of a sqlserver
- Authentication: required
- IAM action:
sqlservercluster/createSnapshot— evaluated at the resource in the path - Operation name:
CreateSqlServerSnapshot
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: CreateSnapshotRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/createSnapshot at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots/pitr-window
The point-in-time recovery window of a sqlserver
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path - Operation name:
GetSqlServerPitrWindow
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots/{snapshotId}
Delete a snapshot of a sqlserver
- Authentication: required
- IAM action:
sqlservercluster/deleteSnapshot— evaluated at the resource in the path - Operation name:
DeleteSqlServerSnapshot
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
snapshotId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/deleteSnapshot at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots/{snapshotId}/restore
Restore a sqlserver from a snapshot
- Authentication: required
- IAM action:
sqlservercluster/restoreSnapshot— evaluated at the resource in the path - Operation name:
RestoreSqlServerFromSnapshot
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
snapshotId |
path | uuid |
Yes |
Request body: RestoreSnapshotRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/restoreSnapshot at the evaluated scope |
GET /boundaries/{boundaryId}/resources/sqlserverclusters
List all sqlserverclusters across all resource groups
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path - Operation name:
ListAllSqlServers
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/sqlserverclusters/config
Get list configuration for all sqlserverclusters
- Authentication: required
- IAM action:
sqlservercluster/read— evaluated at the resource in the path - Operation name:
GetAllSqlServersConfig
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold sqlservercluster/read at the evaluated scope |
Other endpoints
GET /readyz
- Authentication: none — anonymous callers are accepted
- Operation name:
StackshipReadiness
Responses
| Status | Meaning | Body |
|---|
Schemas
BulkDeleteRowsRequest
| Property | Type | Nullable |
|---|---|---|
pkValues |
string [] |
No |
BulkInsertRowsRequest
| Property | Type | Nullable |
|---|---|---|
rows |
map (any) [] |
No |
BulkRowUpdate
| Property | Type | Nullable |
|---|---|---|
pkValue |
string |
No |
values |
map (any) |
No |
BulkUpdateRowsRequest
| Property | Type | Nullable |
|---|---|---|
updates |
BulkRowUpdate [] |
No |
CreateSnapshotRequest
| Property | Type | Nullable |
|---|---|---|
description |
string |
Yes |
ttlHours |
integer |
Yes |
EditorQueryRequest
| Property | Type | Nullable |
|---|---|---|
defaultSchema |
string |
No |
maxRows |
integer |
Yes |
mode |
ExecutionMode |
No |
priorCorrelationId |
uuid |
Yes |
readOnly |
boolean |
No |
sql |
string |
No |
statementTimeoutMs |
integer |
Yes |
ExecutionMode
One of: Review, DryRun, Commit.
PagedListResponse<SqlServerResourcePlanDto>
| Property | Type | Nullable |
|---|---|---|
items |
SqlServerResourcePlanDto [] |
No |
pagination |
PaginationMeta |
No |
PaginationMeta
| Property | Type | Nullable |
|---|---|---|
hasNextPage |
boolean |
No |
hasPreviousPage |
boolean |
No |
page |
integer |
No |
pageSize |
integer |
No |
totalItems |
integer |
No |
totalPages |
integer |
No |
RestoreSnapshotRequest
| Property | Type | Nullable |
|---|---|---|
targetTime |
date-time |
Yes |
RowMutationRequest
| Property | Type | Nullable |
|---|---|---|
values |
map (any) |
No |
ScaleRequest
| Property | Type | Nullable |
|---|---|---|
targetScale |
integer |
No |
SqlServerInstanceDto
| Property | Type | Nullable |
|---|---|---|
allowedCidrs |
string |
Yes |
backupConfigured |
boolean |
No |
backupRetentionPolicy |
string |
Yes |
backupSchedule |
string |
Yes |
boundary |
string |
No |
boundaryId |
uuid |
No |
clusterId |
uuid |
No |
clusterName |
string |
No |
collation |
string |
Yes |
collection |
string |
No |
computePlan |
string |
Yes |
cpuLimit |
string |
Yes |
cpuRequest |
string |
Yes |
createdAt |
date-time |
No |
databaseName |
string |
Yes |
edition |
string |
No |
enableLoadBalancer |
boolean |
No |
id |
uuid |
No |
image |
string |
Yes |
instances |
integer |
Yes |
licenseConfigured |
boolean |
No |
licenseKey |
string |
Yes |
memoryLimit |
string |
Yes |
memoryRequest |
string |
Yes |
monitoringEnabled |
boolean |
No |
name |
string |
No |
networkPolicy |
string |
Yes |
phase |
string |
Yes |
primaryEndpoint |
string |
Yes |
publicEndpoint |
string |
Yes |
readyReplicas |
integer |
Yes |
region |
string |
No |
resourceGroup |
string |
No |
resourcePlanId |
string |
Yes |
sqlVersion |
string |
Yes |
status |
string |
No |
storageClass |
string |
Yes |
storageSize |
string |
Yes |
tags |
map (string) |
No |
SqlServerResourcePlanDto
| Property | Type | Nullable |
|---|---|---|
cpuLimit |
string |
No |
cpuRequest |
string |
No |
description |
string |
No |
id |
string |
No |
isProductionReady |
boolean |
No |
memoryLimit |
string |
No |
memoryRequest |
string |
No |
name |
string |
No |
replicas |
integer |
No |
storageClass |
string |
No |
storageSize |
string |
No |
verdict |
string |
No |
verdictReason |
string |
Yes |