Skip to content
Proud to collaborate with Microsoft for Startups

deploy.database.deprovision ​

Tear down a provisioned database: delete the Cloud SQL instance (cascades) and its credentials secret. Idempotent.

Delete the Cloud SQL instance (cascades db/users) and credentials secret.

Overview ​

PropertyValue
Workflow typeDag
LibraryApp-deployments
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID.
deployment_target_uuiduuidNo—Deployment target (for correlation).
connection_uuiduuidYes—GCP connection UUID.
project_idstringNo—GCP project override.
regionstringNo—Cloud SQL region.
instance_idstringYes—Cloud SQL instance to delete.
secret_idstringNo—Credentials secret to delete; skipped when omitted.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID.
deployment_target_uuiduuidNo—Deployment target UUID.
instance_idstringNo—Cloud SQL instance id.
secret_idstringNo—Credentials secret id.
connection_uuiduuidNo—GCP connection UUID (carried through).
project_idstringNo—GCP project (carried through).
regionstringNo—Cloud SQL region (carried through).
workflow_run_uuiduuidNo—DAG run UUID stamped by the engine.
delete_instancejsonNo—Result of the gcp.sql.instance.delete step.
delete_secretjsonNo—Result of the gcp.secretmanager.secret.delete step (when secret_id set).
statusstringNo—Deprovision status.
failure_reasonstringNo—Engine failure reason.
failure_typestringNo——
failed_actionstringNo——
failed_stepjsonNo—Failed DAG step envelope.
failed_layerjsonNo—Failed DAG layer envelope.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.

DAG Layers ​

#LayerStepsCompensation
1deprovisiongcp.sql.instance.delete, gcp.secretmanager.secret.delete—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
gcp.sql.instance.deletedelete_instance
gcp.secretmanager.secret.deletedelete_secret

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "deploy.database.deprovision",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value",
    "instance_id": "value"
  }
}