Skip to content

update rc openapi spec #3338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cmilesb merged 1 commit into from
May 18, 2026
+303 −0
Merged

update rc openapi spec #3338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
303 changes: 303 additions & 0 deletions content/operate/rc/api/api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7236,6 +7236,75 @@
}
}
},
"/subscriptions/{subscriptionId}/databases/{databaseId}/traffic/resume": {
"post": {
"tags": [
"Databases - Pro"
],
"summary": "Resume Pro database traffic",
"description": "Resumes traffic for the specified Pro database.",
"operationId": "resumeBdbTraffic",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription ID.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "databaseId",
"in": "path",
"description": "Database ID.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"204": {
"description": "Traffic resumed"
},
"401": {
"description": "Unauthorized - Authentication failed for requested resource"
},
"403": {
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
},
"404": {
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
},
"408": {
"description": "Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period"
},
"409": {
"description": "Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name)"
},
"429": {
"description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)"
},
"500": {
"description": "Internal system error - If this error persists, please contact customer support"
},
"503": {
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
}
}
}
},
"/subscriptions/{subscriptionId}/databases/{databaseId}/import": {
"get": {
"tags": [
Expand Down Expand Up @@ -7972,6 +8041,75 @@
}
}
},
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/traffic/resume": {
"post": {
"tags": [
"Databases - Essentials"
],
"summary": "Resume Essentials database traffic",
"description": "Resumes traffic for the specified Essentials database.",
"operationId": "resumeBdbTraffic_1",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription ID.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "databaseId",
"in": "path",
"description": "Database ID.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"204": {
"description": "Traffic resumed"
},
"401": {
"description": "Unauthorized - Authentication failed for requested resource"
},
"403": {
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
},
"404": {
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
},
"408": {
"description": "Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period"
},
"409": {
"description": "Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name)"
},
"429": {
"description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)"
},
"500": {
"description": "Internal system error - If this error persists, please contact customer support"
},
"503": {
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
}
}
}
},
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/import": {
"get": {
"tags": [
Expand Down Expand Up @@ -9691,6 +9829,76 @@
}
}
},
"/subscriptions/{subscriptionId}/databases/{databaseId}/traffic": {
"get": {
"tags": [
"Databases - Pro"
],
"summary": "Get Pro database traffic",
"description": "Gets traffic information for the specified Pro database. If the database was not a source in a redirect endpoints operation, a not found error will be returned.",
"operationId": "getDatabaseTraffic",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription ID.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "databaseId",
"in": "path",
"description": "Database ID.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseTrafficStateResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Authentication failed for requested resource"
},
"403": {
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
},
"404": {
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
},
"429": {
"description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)"
},
"500": {
"description": "Internal system error - If this error persists, please contact customer support"
},
"503": {
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
}
}
}
},
"/subscriptions/{subscriptionId}/databases/{databaseId}/slow-log": {
"get": {
"tags": [
Expand Down Expand Up @@ -10312,6 +10520,76 @@
}
}
},
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/traffic": {
"get": {
"tags": [
"Databases - Essentials"
],
"summary": "Get Essentials database traffic",
"description": "Gets traffic information for the specified Essentials database. If the database was not a source in a redirect endpoints operation, a not found error will be returned.",
"operationId": "getDatabaseTraffic_1",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Subscription ID.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "databaseId",
"in": "path",
"description": "Database ID.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
},
"412": {
"description": "Precondition Failed - Feature flag for this flow is off"
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseTrafficStateResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Authentication failed for requested resource"
},
"403": {
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
},
"404": {
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
},
"429": {
"description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)"
},
"500": {
"description": "Internal system error - If this error persists, please contact customer support"
},
"503": {
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
}
}
}
},
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/slow-log": {
"get": {
"tags": [
Expand Down Expand Up @@ -12740,6 +13018,31 @@
},
"description": "Active-Active VPC peering update request message"
},
"DatabaseTrafficStateResponse": {
"type": "object",
"properties": {
"bdbId": {
"type": "integer",
"format": "int32"
},
"trafficStatus": {
"type": "string"
},
"canResume": {
"type": "boolean"
},
"resumeInProgress": {
"type": "boolean"
},
"stopReason": {
"type": "string"
},
"resumeEligibleAt": {
"type": "string",
"format": "date-time"
}
}
},
"DataPersistenceEntry": {
"type": "object",
"properties": {
Expand Down
Loading