{ "openapi": "3.0.0", "info": { "description": "## Introduction\n\n**The IBM Cloud Databases v5 API** is a supplemental layer that adds the capability to manage IBM Cloud Databases through a REST API. The API is designed to provide users and developers the ability to examine their database deployments, upgrade deployments, manage users, manage connections, monitor tasks, and work with backups.\n \nPrior versions of the API documentation can be found at: \n- [IBM Cloud Databases v4 API](https://cloud.ibm.com/apidocs/cloud-databases-api/cloud-databases-api-v4) \n\n## Endpoint URLs\n\nThe API is available at these public endpoints:\n- https://api.us-south.databases.cloud.ibm.com/v5/ibm/\n- https://api.eu-de.databases.cloud.ibm.com/v5/ibm/\n- https://api.jp-tok.databases.cloud.ibm.com/v5/ibm/\n- https://api.osl01.databases.cloud.ibm.com/v5/ibm/\n- https://api.au-syd.databases.cloud.ibm.com/v5/ibm/\n- https://api.us-east.databases.cloud.ibm.com/v5/ibm/\n- https://api.eu-gb.databases.cloud.ibm.com/v5/ibm/\n- https://api.seo01.databases.cloud.ibm.com/v5/ibm/\n- https://api.che01.databases.cloud.ibm.com/v5/ibm/\n\nThe API is also available at these private endpoints:\n- https://api.us-south.private.databases.cloud.ibm.com/v5/ibm/\n- https://api.eu-de.private.databases.cloud.ibm.com/v5/ibm/\n- https://api.jp-tok.private.databases.cloud.ibm.com/v5/ibm/\n- https://api.osl01.private.databases.cloud.ibm.com/v5/ibm/\n- https://api.au-syd.private.databases.cloud.ibm.com/v5/ibm/\n- https://api.us-east.private.databases.cloud.ibm.com/v5/ibm/\n- https://api.eu-gb.private.databases.cloud.ibm.com/v5/ibm/\n- https://api.seo01.private.databases.cloud.ibm.com/v5/ibm/\n- https://api.che01.private.databases.cloud.ibm.com/v5/ibm/\n \nYou must use the endpoint from the same region as your deployment. A deployment's endpoint is also available on its _Overview_ tab or in any generated service credentials.\n\n## Authentication\n\nAccess to the API uses token authentication, by using the header `Authorization: Bearer `. The token must be [IAM-issued](https://cloud.ibm.com/docs/account?topic=account-manapikey). You can send in an IAM API key directly as the token or [use the API key to generate an IAM Bearer Token](https://cloud.ibm.com/docs/account?topic=account-iamtoken_from_apikey).\n\nTo call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see [Managing access for IBM Cloud](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-iam).\n\n## Error Handling\n\nThe IBM Cloud Databases API uses standard HTTP response codes to indicate whether a method completed successfully. A `200` response always indicates success. A `4xx` type response is some sort of failure, and a `500` type response usually indicates an internal system error. Any of these responses might be accompanied by a JSON formatted body that contains more detailed error information.\n\n## Event tracking\n\nYou can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method. \n\nFor more information about how to track Certificate Manager activity, see [Auditing events for IBM Cloud](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-activity-tracker).\n\n## Deployment IDs and CRNs\n\nDeployment IDs are CRNs on the IBM Cloud Databases v5 API platform. When you use the CRN, remember to URL encode the CRN value as it might include the forward-slash (/) `%2F` character. For example,\n```\ncrn:v1:bluemix:public:databases-for-redis:us-south:a/274074dce64e9c423ffc238516c755e1:29caf0e7-120f-4da8-9551-3abf57ebcfc7::\n```\nbecomes\n```\ncrn:v1:bluemix:public:databases-for-redis:us-south:a%2F274074dce64e9c423ffc238516c755e1:29caf0e7-120f-4da8-9551-3abf57ebcfc7::\n``` \nwhen URL encoded.\n\n## Pagination\n\nNo endpoint currently returns paginated data.\n\n## Rate Limiting\n\nNo endpoint currently implements rate limiting.\n\n## Related APIs\n\nThis API does not support listing your deployments. You can retrieve a list of all service instances (including your database deployments) from the Resource Controller and the [Resource Controller API](https://cloud.ibm.com/apidocs/resource-controller).\n\nSpecifically, the [`GET /resource_instances endpoint](https://cloud.ibm.com/apidocs/resource-controller#get-a-list-of-all-resource-instances) either with no query parameters or with a `resource_plan_id` can be used to list your deployments.\n\nThis API does not support provisioning and decommissioning of database deployments. Those functions are the responsibility of the Resource Controller and the [Resource Controller API](https://cloud.ibm.com/apidocs/resource-controller).\n\nSpecifically the [`POST /resource_instances` endpoint](https://cloud.ibm.com/apidocs/resource-controller#create-provision-a-new-resource-instance) with appropriate `resource_plan_id` (such as `databases-for-postgresql-standard` or `databases-for-redis-standard`) can be used to create a new database instance. Consult the Cloud Databases [provisioning documentation page](https://cloud.ibm.com/docs/services/cloud-databases?topic=cloud-databases-provisioning) for details of plan ids and other settings.", "version": "5.0.0", "title": "The IBM Cloud Databases API", "x-alternate-name": "Cloud Databases", "contact": { "email": "support@compose.com" }, "x-logo": { "url": "https://res.cloudinary.com/dyyck73ly/image/upload/v1524733320/4b06ebe-compose-logo.png", "backgroundColor": null }, "x-codegen-config": { "improvedNameFormattingV2": true, "go": { "apiPackage": "github.com/IBM/cloud-databases-go-sdk" }, "python": { "apiPackage": "ibm_cloud_databases" } }, "x-github": "https://github.ibm.com/cloud-api-docs/databases-for-postgresql", "x-github-issues": "https://github.ibm.com/cloud-api-docs/databases-for-postgresql/issues/new", "x-last-updated": "2023-04-14" }, "servers": [ { "url": "https://api.{region}.databases.cloud.ibm.com/v5/{platform}", "variables": { "platform": { "enum": [ "compose", "ibm" ], "default": "ibm" }, "region": { "enum": [ "us-south", "eu-de", "jp-tok", "au-syd", "us-east", "eu-gb", "seo01", "che01" ], "default": "us-south" } } } ], "tags": [ { "name": "Deployments", "description": "Managing your deployments" }, { "name": "Database Users", "description": "Managing your database users" }, { "name": "Database Configuration", "description": "Managing your database configuration" }, { "name": "Remotes", "description": "Managing your database read-only remote replicas" }, { "name": "Tasks", "description": "Managing your tasks" }, { "name": "Backups", "description": "Managing your backups" }, { "name": "Connections", "description": "Managing your connections" }, { "name": "Scaling", "description": "Scaling your database deployment" }, { "name": "Autoscaling", "description": "Conditions that govern autoscaling behavior on your deployment" }, { "name": "Management", "description": "Performing maintenance or clean-up tasks on your deployment." }, { "name": "Security", "description": "Securing your database deployment" }, { "name": "Capability", "description": "Returns capability information" } ], "paths": { "/capability/{capability_id}": { "post": { "tags": [ "Capability" ], "summary": "Discover capability information.", "description": "Returns capability information based on the parameters provided. Also returns request parameters or defaults if request parameters are blank.", "operationId": "createCapability", "x-ibm-permissions": { "actions": [ { "name": "POST v5/ibm/capability/:capability_id" } ] }, "parameters": [ { "name": "capability_id", "in": "path", "required": true, "description": "Capability ID", "schema": { "type": "string", "enum": [ "autoscaling", "encryption", "endpoints", "groups", "flavors", "locations", "point_in_time_recovery", "remotes", "restores", "versions" ] } } ], "requestBody": { "description": "Parameters for discovering capability.", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deployment": { "type": "object", "description": "Either `deployment` or `backup`, not both. The `deployment` object can only be used with its supported `capability_id`.", "properties": { "type": { "type": "string", "description": "Type of database", "example": "PostgreSQL" }, "version": { "type": "string", "description": "database version", "example": "10" }, "platform": { "type": "string", "description": "classic or satellite", "example": "satellite" }, "location": { "type": "string", "description": "where the database is located", "example": "us-south" }, "plan": { "type": "string", "description": "database plan", "example": "standard" } } }, "backup": { "type": "object", "description": "Either `deployment` or `backup`, not both. The `backup` object can only be used with its supported `capability_id`.", "properties": { "type": { "type": "string", "description": "Type of database", "example": "PostgreSQL" }, "version": { "type": "string", "description": "database version", "example": "10" }, "platform": { "type": "string", "description": "classic or satellite", "example": "satellite" }, "location": { "type": "string", "description": "where the database is located", "example": "us-south" } } }, "options": { "type": "object", "properties": { "target_platform": { "type": "string", "description": "classic or satellite", "example": "classic" }, "target_location": { "type": "string", "description": "Target location", "example": "us-east" }, "host_flavor": { "type": "string", "description": "which host_flavor groups to return", "example": "multitenant" } } } } }, "example": { "deployment": { "type": "postgresql", "version": "10", "platform": "classic", "location": "us-south" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/capability/point_in_time_recovery \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"deployment\": {\n \"type\": \"postgresql\",\n \"version\": \"14\",\n \"platform\": \"classic\",\n \"location\": \"us-south\"\n },\n \"options\": {\n \"target_platform\": \"classic\",\n \"target_location\": \"jp-tok\"\n }\n }'" ] } ] } ] } }, "responses": { "200": { "description": "capability information", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "$ref": "#/components/schemas/Capability" } } }, "examples": { "PitrCapabilityTrue": { "$ref": "#/components/examples/PitrCapabilityTrue" }, "CapabilityAutoscalingFalse": { "$ref": "#/components/examples/CapabilityAutoscalingFalse" }, "CapabilityLocationsHasStrings": { "$ref": "#/components/examples/CapabilityLocationsHasStrings" } } } } }, "403": { "description": "Invalid token", "content": { "application/json": { "examples": { "InvalidToken": { "$ref": "#/components/examples/InvalidToken" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "PitrUnprocessableEntity": { "$ref": "#/components/examples/PitrUnprocessableEntity" } } } } } } } }, "/deployments/{id}/capability/{capability_id}": { "get": { "tags": [ "Capability" ], "summary": "Discover capability information from a deployment.", "description": "Returns capability information based on the deployment provided. Also returns url parameters or defaults if request parameters are blank.", "operationId": "getDeploymentCapability", "x-ibm-permissions": { "actions": [ { "name": "GET v5/ibm/deployments/:deployment_id/capability/:capability_id" } ] }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "capability_id", "in": "path", "required": true, "description": "Capability ID", "schema": { "type": "string", "enum": [ "autoscaling", "encryption", "endpoints", "groups", "locations", "point_in_time_recovery", "remotes", "versions" ] } }, { "name": "target_platform", "in": "query", "description": "Target platform. Required for Point In Time Recovery.", "examples": { "platform": { "summary": "Target platform example", "value": "target_platform=classic" } }, "schema": { "type": "string" } }, { "name": "target_location", "in": "query", "description": "Target location. Required for Point In Time Recovery.", "examples": { "location": { "summary": "Target location example", "value": "target_location=us-east" } }, "schema": { "type": "string" } }, { "name": "host_flavor", "in": "query", "description": "When a host_flavor of 'multitenant' is included with the request, IBM Cloud Database's new shared compute groups will be returned", "examples": { "location": { "summary": "Host flavor example", "value": "host_flavor=multitenant" } }, "schema": { "type": "string" } }, { "name": "include_hidden", "in": "query", "required": false, "description": "Include hidden versions. Only applicable for versions capability.", "schema": { "type": "boolean", "example": true } }, { "name": "include_beta", "in": "query", "required": false, "description": "Include beta versions. Only applicable for versions capability.", "schema": { "type": "boolean", "example": true } } ], "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/capability/{capability_id} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ] } }, "responses": { "200": { "description": "capability information", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "$ref": "#/components/schemas/Capability" } } }, "examples": { "PitrCapabilityTrue": { "$ref": "#/components/examples/PitrCapabilityTrue" }, "CapabilityAutoscalingFalse": { "$ref": "#/components/examples/CapabilityAutoscalingFalse" } } } } }, "403": { "description": "Invalid token", "content": { "application/json": { "examples": { "InvalidToken": { "$ref": "#/components/examples/InvalidToken" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "PitrUnprocessableEntity": { "$ref": "#/components/examples/PitrUnprocessableEntity" } } } } } } } }, "/backups/{backup_id}/capability/{capability_id}": { "get": { "x-sdk-exclude": true, "tags": [ "Capability" ], "summary": "Discover capability information from a backup.", "description": "Returns capability information based on the backup provided. Also returns url parameters or defaults if request parameters are blank.", "operationId": "backupCapability", "x-ibm-permissions": { "actions": [ { "name": "GET v5/ibm/backups/:backup_id/capability/:capability_id" } ] }, "parameters": [ { "name": "backup_id", "in": "path", "required": true, "description": "Backup ID", "schema": { "type": "string" } }, { "name": "capability_id", "in": "path", "required": true, "description": "Capability ID", "schema": { "type": "string", "enum": [ "restores" ] } }, { "name": "target_platform", "in": "query", "description": "Target platform.", "examples": { "platform": { "summary": "Target platform example", "value": "target_platform=classic" } }, "schema": { "type": "string" } }, { "name": "target_location", "in": "query", "description": "Target location.", "examples": { "location": { "summary": "Target location example", "value": "target_location=us-easst" } }, "schema": { "type": "string" } }, { "name": "host_flavor", "in": "query", "description": "When a host_flavor of 'multitenant' is included with the request, IBM Cloud Database's new shared compute groups will be returned", "examples": { "location": { "summary": "Host flavor example", "value": "host_flavor=multitenant" } }, "schema": { "type": "string" } } ], "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/backups/{backup_id}/capability/{capability_id} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ] } }, "responses": { "200": { "description": "capability information", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "$ref": "#/components/schemas/Capability" } } }, "examples": { "CapabilityAutoscalingFalse": { "$ref": "#/components/examples/RestoreCapabilityTrue" } } } } }, "403": { "description": "Invalid token", "content": { "application/json": { "examples": { "InvalidToken": { "$ref": "#/components/examples/InvalidToken" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "RestoresUnprocessableEntity": { "$ref": "#/components/examples/RestoresUnprocessableEntity" } } } } } } } }, "/deployables": { "get": { "tags": [ "Deployments" ], "summary": "List all deployable databases", "description": "Returns a list of all the types and associated major versions of database deployments that can be provisioned.", "operationId": "listDeployables", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployables" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployables \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listDeployablesOptions := cloudDatabasesService.NewListDeployablesOptions()\n", "\n", "listDeployablesResponse, response, err := cloudDatabasesService.ListDeployables(listDeployablesOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(listDeployablesResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "cloudDatabasesService.listDeployables({})\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "list_deployables_response = cloud_databases_service.list_deployables().get_result()\n", "\n", "print(json.dumps(list_deployables_response, indent=2))" ] } ] } ] } }, "responses": { "200": { "description": "Deployable database objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "deployables": { "type": "array", "items": { "$ref": "#/components/schemas/Deployables" } } }, "example": { "deployables": [ { "type": "elasticsearch", "versions": [ { "version": "6.7", "status": "stable", "is_preferred": true, "transitions": [] }, { "version": "5.6", "status": "stable", "is_preferred": false, "transitions": [ { "application": "elasticsearch", "method": "restore", "from_version": "5.6", "to_version": "6.7" } ] } ] } ] } } } } }, "403": { "description": "Invalid token" } } } }, "/regions": { "get": { "tags": [ "Deployments" ], "summary": "List all deployable regions", "description": "Returns a list of all the regions that deployments can be provisioned into from the current region. Used to determine region availability for read-only replicas", "operationId": "listRegions", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/regions" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/regions \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listRegionsOptions := cloudDatabasesService.NewListRegionsOptions()\n", "\n", "listRegionsResponse, response, err := cloudDatabasesService.ListRegions(listRegionsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(listRegionsResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "cloudDatabasesService.listRegions({})\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "list_regions_response = cloud_databases_service.list_regions().get_result()\n", "\n", "print(json.dumps(list_regions_response, indent=2))" ] } ] } ] } }, "responses": { "200": { "description": "A regions object", "content": { "application/json": { "schema": { "type": "object", "properties": { "regions": { "type": "array", "items": { "type": "string" }, "description": "An array of region ids" } }, "example": { "regions": [ "eu-gb", "us-south" ] } } } } }, "403": { "description": "Invalid token" } } } }, "/deployments/{id}": { "get": { "tags": [ "Deployments" ], "summary": "Get deployment information", "description": "Gets the full data that is associated with a deployment. This data includes the ID, name, database type, and version.", "operationId": "getDeploymentInfo", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getDeploymentInfoOptions := cloudDatabasesService.NewGetDeploymentInfoOptions(\n", " deploymentID,\n", ")\n", "\n", "getDeploymentInfoResponse, response, err := cloudDatabasesService.GetDeploymentInfo(getDeploymentInfoOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(getDeploymentInfoResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.getDeploymentInfo(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "get_deployment_info_response = cloud_databases_service.get_deployment_info(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(get_deployment_info_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A deployment response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deployment": { "$ref": "#/components/schemas/Deployment" } }, "example": { "deployment": { "id": "crn:v1:staging:public:databases-for-enterprisedb:us-south:a/b9552134280015ebfde430a819fa4bb3:5589ecbf-de5f-4eac-9917-df0dd7e706c8::", "name": "crn:v1:staging:public:databases-for-enterprisedb:us-south:a/b9552134280015ebfde430a819fa4bb3:5589ecbf-de5f-4eac-9917-df0dd7e706c8::", "type": "enterprisedb", "platform": "classic", "platform_options": { "disk_encryption_key_crn": "", "backup_encryption_key_crn": "" }, "version": "12", "admin_usernames": { "database": "admin" }, "enable_private_endpoints": false, "enable_public_endpoints": true, "disablements": [] } } } } } }, "403": { "description": "Invalid token" } } } }, "/deployments/{id}/tasks": { "get": { "tags": [ "Tasks" ], "summary": "List currently running tasks on a deployment", "description": "Obtain a list of tasks currently running or recently run on a deployment. Tasks are ephemeral. Records of successful tasks are shown for 24-48 hours, and unsuccessful tasks are shown for 7-8 days.", "operationId": "listDeploymentTasks", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/tasks" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/tasks \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listDeploymentTasksOptions := cloudDatabasesService.NewListDeploymentTasksOptions(\n", " deploymentID,\n", ")\n", "\n", "tasks, response, err := cloudDatabasesService.ListDeploymentTasks(listDeploymentTasksOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(tasks, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.listDeploymentTasks(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "tasks = cloud_databases_service.list_deployment_tasks(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(tasks, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "An array of tasks", "content": { "application/json": { "schema": { "title": "Tasks", "type": "object", "properties": { "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/Task" }, "example": [ { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b", "resource_type": "backup", "description": "Backing up database on-demand", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:31:30Z" } ] } } } } } }, "403": { "description": "Invalid token" } } } }, "/tasks/{id}": { "get": { "tags": [ "Tasks" ], "summary": "Get information about a task", "description": "Get information about a task and its status. Tasks themselves are persistent so old tasks can be consulted as well as running tasks.", "operationId": "getTask", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/tasks/:task_id" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/tasks/{id} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getTaskOptions := cloudDatabasesService.NewGetTaskOptions(\n", " taskIDLink,\n", ")\n", "\n", "getTaskResponse, response, err := cloudDatabasesService.GetTask(getTaskOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(getTaskResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: taskIdLink,\n", "};\n", "\n", "cloudDatabasesService.getTask(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "get_task_response = cloud_databases_service.get_task(\n", " id=task_id_link,\n", ").get_result()\n", "\n", "print(json.dumps(get_task_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Task ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b", "resource_type": "backup", "description": "Backing up database on-demand", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:31:30Z" } } } } } }, "303": { "description": "A completed task redirects to the associated resource.", "headers": { "Location": { "schema": { "type": "string" }, "description": "Location where the related resource can be found" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b", "resource_type": "backup", "description": "Backing up database on-demand", "status": "completed", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 100, "created_at": "2018-03-28T10:31:30Z" } } } } } }, "403": { "description": "Invalid token" } } } }, "/backups/{backup_id}": { "get": { "tags": [ "Backups" ], "summary": "Get information about a backup", "description": "Get information about a backup, such as creation date.", "operationId": "getBackupInfo", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/backups/:backup_id" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/backups/{backup_id} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getBackupInfoOptions := cloudDatabasesService.NewGetBackupInfoOptions(\n", " backupIDLink,\n", ")\n", "\n", "getBackupInfoResponse, response, err := cloudDatabasesService.GetBackupInfo(getBackupInfoOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(getBackupInfoResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " backupId: backupIdLink,\n", "};\n", "\n", "cloudDatabasesService.getBackupInfo(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "get_backup_info_response = cloud_databases_service.get_backup_info(\n", " backup_id=backup_id_link,\n", ").get_result()\n", "\n", "print(json.dumps(get_backup_info_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "backup_id", "in": "path", "required": true, "description": "Backup ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A backup response", "content": { "application/json": { "schema": { "type": "object", "properties": { "backup": { "$ref": "#/components/schemas/Backup" } }, "example": { "backup": { "id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/274074dce64e9c423ffc238516c755e1:afa742a3-6f83-4f6e-a06e-b5c501e9e87a:backup:87635880-b11c-4359-9d06-41fd9f90feaf", "deployment_id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/274074dce64e9c423ffc238516c755e1:afa742a3-6f83-4f6e-a06e-b5c501e9e87a::", "type": "scheduled", "status": "completed", "is_downloadable": false, "is_restorable": true, "created_at": "2019-06-10T14:31:40.000Z" } } } } } }, "403": { "description": "Invalid token" } } } }, "/deployments/{id}/backups": { "get": { "tags": [ "Backups" ], "summary": "List currently available backups from a deployment", "description": "Get details of all currently available backups from a deployment.", "operationId": "listDeploymentBackups", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/backups" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/backups \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listDeploymentBackupsOptions := cloudDatabasesService.NewListDeploymentBackupsOptions(\n", " deploymentID,\n", ")\n", "\n", "backups, response, err := cloudDatabasesService.ListDeploymentBackups(listDeploymentBackupsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(backups, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.listDeploymentBackups(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "backups = cloud_databases_service.list_deployment_backups(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(backups, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "An array of backups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backups" } } } }, "403": { "description": "Invalid token" } } }, "post": { "tags": [ "Backups" ], "summary": "Initiate an on-demand backup", "description": "Signal the platform to create an on-demand backup for the specified deployment. The returned task can be polled to track progress of the backup as it takes place.", "operationId": "startOndemandBackup", "x-ibm-permissions": { "actions": [ { "name": "POST /v5/ibm/deployments/:deployment_id/backups" } ] }, "x-ibm-events": { "events": [ { "name": ".backup-ondemand.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/backups \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "startOndemandBackupOptions := cloudDatabasesService.NewStartOndemandBackupOptions(\n", " deploymentID,\n", ")\n", "\n", "startOndemandBackupResponse, response, err := cloudDatabasesService.StartOndemandBackup(startOndemandBackupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(startOndemandBackupResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.startOndemandBackup(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "start_ondemand_backup_response = cloud_databases_service.start_ondemand_backup(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(start_ondemand_backup_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b", "resource_type": "backup", "description": "Backing up database on-demand", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:30:30Z" } } } } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/point_in_time_recovery_data": { "get": { "tags": [ "Backups" ], "summary": "Get earliest point-in-time-recovery timestamp", "description": "Returns the earliest available time for point-in-time-recovery in ISO8601 UTC format. PostgreSQL, EnterpriseDB, MySQL and MongoDB Enterprise only.", "operationId": "getPITRData", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/point_in_time_recovery_data" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/point_in_time_recovery_data \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getPitRdataOptions := cloudDatabasesService.NewGetPitRdataOptions(\n", " deploymentID,\n", ")\n", "\n", "pointInTimeRecoveryData, response, err := cloudDatabasesService.GetPitRdata(getPitRdataOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(pointInTimeRecoveryData, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.getPitRdata(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "point_in_time_recovery_data = cloud_databases_service.get_pit_rdata(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(point_in_time_recovery_data, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The earliest point-in-time-recovery time", "content": { "application/json": { "schema": { "type": "object", "properties": { "point_in_time_recovery_data": { "$ref": "#/components/schemas/PointInTimeRecoveryData" } } }, "example": { "point_in_time_recovery_data": { "earliest_point_in_time_recovery_time": "2019-09-09T23:16:00Z" } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } } }, "/deployments/{id}/groups": { "get": { "tags": [ "Scaling" ], "summary": "List currently available scaling groups from a deployment", "description": "Scaling groups represent the various resources that are allocated to a deployment. This command allows for the retrieval of all of the groups for a particular deployment.", "operationId": "listDeploymentScalingGroups", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/groups" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listDeploymentScalingGroupsOptions := cloudDatabasesService.NewListDeploymentScalingGroupsOptions(\n", " deploymentID,\n", ")\n", "\n", "groups, response, err := cloudDatabasesService.ListDeploymentScalingGroups(listDeploymentScalingGroupsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(groups, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.listDeploymentScalingGroups(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "groups = cloud_databases_service.list_deployment_scaling_groups(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(groups, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "An array of scaling groups", "content": { "application/json": { "schema": { "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } } } } } }, "403": { "description": "Invalid token" } } } }, "/deployables/{type}/groups": { "get": { "tags": [ "Scaling" ], "summary": "Get default scaling groups for a new deployment", "description": "Scaling groups represent the various resources allocated to a deployment. When a new deployment is created, there are a set of defaults for each database type. This endpoint returns them for a particular database.", "operationId": "getDefaultScalingGroups", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployables/:type/groups" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployables/{type}/groups \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getDefaultScalingGroupsOptions := cloudDatabasesService.NewGetDefaultScalingGroupsOptions(\n", " \"postgresql\",\n", ")\n", "\n", "groups, response, err := cloudDatabasesService.GetDefaultScalingGroups(getDefaultScalingGroupsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(groups, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " type: 'postgresql',\n", "};\n", "\n", "cloudDatabasesService.getDefaultScalingGroups(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "groups = cloud_databases_service.get_default_scaling_groups(\n", " type='postgresql',\n", ").get_result()\n", "\n", "print(json.dumps(groups, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "type", "in": "path", "required": true, "description": "Database type name", "schema": { "type": "string", "enum": [ "postgresql", "etcd" ], "example": "postgresql" } }, { "name": "host_flavor", "in": "query", "required": false, "description": "When a host_flavor of 'multitenant' is included with the request, IBM Cloud Database's new shared compute default groups will be returned", "schema": { "type": "string", "enum": [ "multitenant" ], "example": "multitenant" } } ], "responses": { "200": { "description": "An array of scaling groups", "content": { "application/json": { "schema": { "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } } } } } }, "403": { "description": "Invalid token" } } } }, "/deployments/{id}/groups/{group_id}": { "patch": { "tags": [ "Scaling" ], "summary": "Set scaling values on a specified group.", "description": "Set scaling value on a specified group. Can only be performed on is_adjustable=true groups. Values set are for the group as a whole and resources are distributed amongst the group. Values must be greater than or equal to the minimum size and must be a multiple of the step size.", "operationId": "setDeploymentScalingGroup", "x-ibm-permissions": { "actions": [ { "name": "PATCH /v5/ibm/deployments/:deployment_id/groups/:group_id" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups/{group_id} \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"memory\": {\"allocation_mb\": 4096}}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "setMemoryGroupMemoryModel := &clouddatabasesv5.SetMemoryGroupMemory{\n", " AllocationMb: core.Int64Ptr(int64(114688)),\n", "}\n", "\n", "setDeploymentScalingGroupRequestModel := &clouddatabasesv5.SetDeploymentScalingGroupRequestSetMemoryGroup{\n", " Memory: setMemoryGroupMemoryModel,\n", "}\n", "\n", "setDeploymentScalingGroupOptions := cloudDatabasesService.NewSetDeploymentScalingGroupOptions(\n", " deploymentID,\n", " scalingGroupIDLink,\n", " setDeploymentScalingGroupRequestModel,\n", ")\n", "\n", "setDeploymentScalingGroupResponse, response, err := cloudDatabasesService.SetDeploymentScalingGroup(setDeploymentScalingGroupOptions)\n", "if err != nil {\n", " handleError(setDeploymentScalingGroupResponse, response, err)\n", "}\n", "b, _ := json.MarshalIndent(setDeploymentScalingGroupResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const setMemoryGroupMemoryModel = {\n", " allocation_mb: 114688,\n", "};\n", "\n", "const setDeploymentScalingGroupRequestModel = {\n", " memory: setMemoryGroupMemoryModel,\n", "};\n", "\n", "const params = {\n", " id: deploymentId,\n", " groupId: scalingGroupIdLink,\n", " setDeploymentScalingGroupRequest: setDeploymentScalingGroupRequestModel,\n", "};\n", "\n", "cloudDatabasesService.setDeploymentScalingGroup(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "set_memory_group_memory_model = SetMemoryGroupMemory(\n", " allocation_mb=114688,\n", ")\n", "\n", "set_deployment_scaling_group_request_model = SetDeploymentScalingGroupRequestSetMemoryGroup(\n", " memory=set_memory_group_memory_model,\n", ")\n", "\n", "set_deployment_scaling_group_response = cloud_databases_service.set_deployment_scaling_group(\n", " id=deployment_id,\n", " group_id=scaling_group_id_link,\n", " set_deployment_scaling_group_request=set_deployment_scaling_group_request_model\n", ").get_result()\n", "\n", "print(json.dumps(set_deployment_scaling_group_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "required": true, "description": "Group Id", "schema": { "type": "string" } } ], "requestBody": { "description": "Scaling group settings", "required": true, "content": { "application/json": { "schema": { "properties": { "group": { "$ref": "#/components/schemas/GroupScaling" } } }, "example": { "memory": { "allocation_mb": 4096 } } } } }, "responses": { "202": { "description": "A task which is being run to scale the deployment", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b", "resource_type": "configuration", "description": "Scaling database deployment", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:20:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/groups/{group_id}/autoscaling": { "get": { "tags": [ "Autoscaling" ], "summary": "Get the autoscaling configuration from a deployment", "description": "The Autoscaling configuration represents the various conditions that control autoscaling for a deployment. This command allows for the retrieval of all autoscaling conditions for a particular deployment.", "operationId": "getAutoscalingConditions", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/groups/:group_id/autoscaling" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups/{group_id}/autoscaling \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getAutoscalingConditionsOptions := cloudDatabasesService.NewGetAutoscalingConditionsOptions(\n", " deploymentID,\n", " autoScalingGroupID,\n", ")\n", "\n", "autoscalingGroup, response, err := cloudDatabasesService.GetAutoscalingConditions(getAutoscalingConditionsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(autoscalingGroup, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", " groupId: autoScalingGroupId,\n", "};\n", "\n", "cloudDatabasesService.getAutoscalingConditions(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "autoscaling_group = cloud_databases_service.get_autoscaling_conditions(\n", " id=deployment_id,\n", " group_id=auto_scaling_group_id,\n", ").get_result()\n", "\n", "print(json.dumps(autoscaling_group, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "required": true, "description": "Group ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "An object containing autoscaling conditions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoscalingGroup" }, "example": { "autoscaling": { "disk": { "scalers": { "capacity": { "enabled": false, "free_space_remaining_percent": 10 }, "io_utilization": { "enabled": true, "over_period": "30m", "above_percent": 45 } }, "rate": { "increase_percent": 20, "scale_period_seconds": 900, "limit_mb_per_member": 3670016, "units": "mb" } }, "memory": { "scalers": { "io_utilization": { "enabled": false, "over_period": "5m", "above_percent": 90 } }, "rate": { "increase_percent": 10, "period_seconds": 900, "limit_mb_per_member": 125952, "units": "mb" } } } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "Autoscaling" ], "summary": "Set the autoscaling configuration from a deployment", "description": "Enable, disable, or set the conditions for autoscaling on your deployment. Memory, disk, and CPU (if available) can be set separately and are not all required.", "operationId": "setAutoscalingConditions", "x-ibm-permissions": { "actions": [ { "name": "PATCH /v5/ibm/deployments/:deployment_id/groups/:group_id/autoscaling" } ] }, "x-ibm-events": { "events": [ { "name": ".autoscaling.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups/{group_id}/autoscaling \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"autoscaling\": { \"memory\": {\"scalers\": {\"io_utilization\": {\"enabled\": true, \"over_period\": \"5m\",\"above_percent\": 90}},\"rate\": {\"increase_percent\": 10.0, \"period_seconds\": 300,\"limit_mb_per_member\": 125952,\"units\": \"mb\"}}}}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "autoscalingMemoryGroupMemoryScalersIoUtilizationModel := &clouddatabasesv5.AutoscalingMemoryGroupMemoryScalersIoUtilization{\n", " Enabled: core.BoolPtr(true),\n", " OverPeriod: core.StringPtr(\"5m\"),\n", " AbovePercent: core.Int64Ptr(int64(90)),\n", "}\n", "\n", "autoscalingMemoryGroupMemoryScalersModel := &clouddatabasesv5.AutoscalingMemoryGroupMemoryScalers{\n", " IoUtilization: autoscalingMemoryGroupMemoryScalersIoUtilizationModel,\n", "}\n", "\n", "autoscalingMemoryGroupMemoryRateModel := &clouddatabasesv5.AutoscalingMemoryGroupMemoryRate{\n", " IncreasePercent: core.Float64Ptr(float64(10.0)),\n", " PeriodSeconds: core.Int64Ptr(int64(300)),\n", " LimitMbPerMember: core.Float64Ptr(float64(114432)),\n", " Units: core.StringPtr(\"mb\"),\n", "}\n", "\n", "autoscalingMemoryGroupMemoryModel := &clouddatabasesv5.AutoscalingMemoryGroupMemory{\n", " Scalers: autoscalingMemoryGroupMemoryScalersModel,\n", " Rate: autoscalingMemoryGroupMemoryRateModel,\n", "}\n", "\n", "autoscalingSetGroupAutoscalingModel := &clouddatabasesv5.AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup{\n", " Memory: autoscalingMemoryGroupMemoryModel,\n", "}\n", "\n", "setAutoscalingConditionsOptions := cloudDatabasesService.NewSetAutoscalingConditionsOptions(\n", " deploymentID,\n", " autoScalingGroupID,\n", " autoscalingSetGroupAutoscalingModel,\n", ")\n", "\n", "setAutoscalingConditionsResponse, response, err := cloudDatabasesService.SetAutoscalingConditions(setAutoscalingConditionsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(setAutoscalingConditionsResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const autoscalingMemoryGroupMemoryScalersIoUtilizationModel = {\n", " enabled: true,\n", " over_period: '5m',\n", " above_percent: 90,\n", "};\n", "\n", "const autoscalingMemoryGroupMemoryScalersModel = {\n", " io_utilization: autoscalingMemoryGroupMemoryScalersIoUtilizationModel,\n", "};\n", "\n", "const autoscalingMemoryGroupMemoryRateModel = {\n", " increase_percent: 10.0,\n", " period_seconds: 300,\n", " limit_mb_per_member: 114432,\n", " units: 'mb',\n", "};\n", "\n", "const autoscalingMemoryGroupMemoryModel = {\n", " scalers: autoscalingMemoryGroupMemoryScalersModel,\n", " rate: autoscalingMemoryGroupMemoryRateModel,\n", "};\n", "\n", "const autoscalingSetGroupAutoscalingModel = {\n", " memory: autoscalingMemoryGroupMemoryModel,\n", "};\n", "\n", "const params = {\n", " id: deploymentId,\n", " groupId: autoScalingGroupId,\n", " autoscaling: autoscalingSetGroupAutoscalingModel,\n", "};\n", "\n", "cloudDatabasesService.setAutoscalingConditions(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "autoscaling_memory_group_memory_scalers_io_utilization_model = AutoscalingMemoryGroupMemoryScalersIoUtilization(\n", " enabled=True,\n", " over_period='5m',\n", " above_percent=90,\n", ")\n", "\n", "autoscaling_memory_group_memory_scalers_model = AutoscalingMemoryGroupMemoryScalers(\n", " io_utilization=autoscaling_memory_group_memory_scalers_io_utilization_model,\n", ")\n", "\n", "autoscaling_memory_group_memory_rate_model = AutoscalingMemoryGroupMemoryRate(\n", " increase_percent=10.0,\n", " period_seconds=300,\n", " limit_mb_per_member=114432,\n", " units='mb',\n", ")\n", "\n", "autoscaling_memory_group_memory_model = AutoscalingMemoryGroupMemory(\n", " scalers=autoscaling_memory_group_memory_scalers_model,\n", " rate=autoscaling_memory_group_memory_rate_model,\n", ")\n", "\n", "autoscaling_set_group_autoscaling_model = AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup(\n", " memory=autoscaling_memory_group_memory_model,\n", ")\n", "\n", "set_autoscaling_conditions_response = cloud_databases_service.set_autoscaling_conditions(\n", " id=deployment_id,\n", " group_id=auto_scaling_group_id,\n", " autoscaling=autoscaling_set_group_autoscaling_model,\n", ").get_result()\n", "\n", "print(json.dumps(set_autoscaling_conditions_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "required": true, "description": "Group ID", "schema": { "type": "string" } } ], "requestBody": { "description": "Autoscaling configuration", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoscalingSetGroup" }, "example": { "autoscaling": { "memory": { "scalers": { "io_utilization": { "enabled": true, "over_period": "5m", "above_percent": 90 } }, "rate": { "increase_percent": 10, "period_seconds": 300, "limit_mb_per_member": 125952, "units": "mb" } } } } } } }, "responses": { "202": { "description": "A task which is being run to configure autoscaling", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423a4ef238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4d36-92f3-b5c96544393b", "resource_type": "configuration", "description": "Synthesized autoscaling", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "created_at": "2019-10-17T14:15:52.393Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "404": { "description": "Not Found" } } } }, "/deployments/{id}/users/{user_type}": { "post": { "tags": [ "Database Users" ], "summary": "Creates a user based on user type", "description": "Creates a user in the database that can access the database through a connection.", "operationId": "createDatabaseUser", "x-ibm-permissions": { "actions": [ { "name": "POST /v5/ibm/deployments/:deployment_id/users/:user_type" } ] }, "x-ibm-events": { "events": [ { "name": ".user.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type} \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"user\": {\"username\": \"user\", \"password\": \"v3ry-1-secUre-pAssword-2\"}}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "createDatabaseUserRequestUserModel := &clouddatabasesv5.CreateDatabaseUserRequestUser{\n", " Username: &username,\n", " Password: &password,\n", "}\n", "\n", "createDatabaseUserOptions := cloudDatabasesService.NewCreateDatabaseUserOptions(\n", " deploymentID,\n", " userType,\n", ")\n", "createDatabaseUserOptions.SetUser(createDatabaseUserRequestUserModel)\n", "\n", "createDatabaseUserResponse, response, err := cloudDatabasesService.CreateDatabaseUser(createDatabaseUserOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(createDatabaseUserResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const createDatabaseUserRequestUserModel = {\n", " username: username,\n", " password: password,\n", "};\n", "\n", "const params = {\n", " id: deploymentId,\n", " userType: userType,\n", " user: createDatabaseUserRequestUserModel,\n", "};\n", "\n", "cloudDatabasesService.createDatabaseUser(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "create_database_user_request_user_model = CreateDatabaseUserRequestUser(\n", " username=username,\n", " password=password,\n", ")\n", "\n", "create_database_user_response = cloud_databases_service.create_database_user(\n", " id=deployment_id,\n", " user_type=user_type,\n", " user=create_database_user_request_user_model,\n", ").get_result()\n", "\n", "print(json.dumps(create_database_user_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "user_type", "in": "path", "required": true, "description": "User type", "schema": { "type": "string" }, "examples": { "database": { "summary": "database type" }, "ops_manager": { "summary": "allows management, monitoring, and backing up deployments" }, "read_only_replica": { "summary": "Allows only read-only connections. Available only on EnterpriseDB and PostgreSQL." } } } ], "requestBody": { "description": "Parameters for creating the user", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" } } }, "example": { "user": { "username": "user", "password": "v3ry-1-secUre-pAssword-2" } } } } }, "responses": { "202": { "description": "A task which is being run to create the user", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393b", "resource_type": "user", "description": "Creating user for database", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:21:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/users/{user_type}/{username}": { "patch": { "tags": [ "Database Users" ], "summary": "Update a user's password or role.", "description": "Sets the password or role of a specified user. Updating roles is only supported for Redis 6.0 or greater.", "operationId": "updateUser", "x-ibm-permissions": { "actions": [ { "name": "PATCH /v5/ibm/deployments/:deployment_id/users/:user_type/:user_id" } ] }, "x-ibm-events": { "events": [ { "name": ".user-password.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{username} \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"user\": {\"password\": \"v3ry-1-secUre-pAssword-2\"}}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "aPasswordSettingUserModel := &clouddatabasesv5.APasswordSettingUser{\n", " Password: &newPassword,\n", "}\n", "\n", "changeUserPasswordOptions := cloudDatabasesService.NewChangeUserPasswordOptions(\n", " deploymentID,\n", " userType,\n", " username,\n", ")\n", "changeUserPasswordOptions.SetUser(aPasswordSettingUserModel)\n", "\n", "changeUserPasswordResponse, response, err := cloudDatabasesService.ChangeUserPassword(changeUserPasswordOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(changeUserPasswordResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const aPasswordSettingUserModel = {\n", " password: newPassowrd,\n", "};\n", "\n", "const params = {\n", " id: deploymentId,\n", " userType: userType,\n", " username: username,\n", " user: aPasswordSettingUserModel,\n", "};\n", "\n", "cloudDatabasesService.changeUserPassword(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "a_password_setting_user_model = APasswordSettingUser(\n", " password=new_password,\n", ")\n", "\n", "change_user_password_response = cloud_databases_service.change_user_password(\n", " id=deployment_id,\n", " user_type=user_type,\n", " username=username,\n", " user=a_password_setting_user_model,\n", ").get_result()\n", "\n", "print(json.dumps(change_user_password_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "user_type", "in": "path", "required": true, "description": "User type", "schema": { "type": "string" }, "example": "database" }, { "name": "username", "in": "path", "required": true, "description": "User ID", "schema": { "type": "string" }, "example": "user" } ], "requestBody": { "description": "User Details", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserUpdate" } } }, "example": { "user": { "password": "v3ry-1-secUre-pAssword-2" } } } } }, "responses": { "202": { "description": "A task which is being run to set the user password", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393b", "resource_type": "password", "description": "Setting user password for database", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:22:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } }, "delete": { "tags": [ "Database Users" ], "summary": "Deletes a user based on user type", "description": "Removes a user from the deployment.", "operationId": "deleteDatabaseUser", "x-ibm-permissions": { "actions": [ { "name": "DELETE /v5/ibm/deployments/:deployment_id/users/:user_type/:user_id" } ] }, "x-ibm-events": { "events": [ { "name": ".user.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{username} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteDatabaseUserOptions := cloudDatabasesService.NewDeleteDatabaseUserOptions(\n", " deploymentID,\n", " userType,\n", " username,\n", ")\n", "\n", "deleteDatabaseUserResponse, response, err := cloudDatabasesService.DeleteDatabaseUser(deleteDatabaseUserOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(deleteDatabaseUserResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", " userType: userType,\n", " username: username,\n", "};\n", "\n", "cloudDatabasesService.deleteDatabaseUser(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "delete_database_user_response = cloud_databases_service.delete_database_user(\n", " id=deployment_id,\n", " user_type=user_type,\n", " username=username,\n", ").get_result()\n", "\n", "print(json.dumps(delete_database_user_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "user_type", "in": "path", "required": true, "description": "User type", "schema": { "type": "string" }, "example": "database" }, { "name": "username", "in": "path", "required": true, "description": "Username", "schema": { "type": "string" }, "example": "user" } ], "responses": { "202": { "description": "A task which is being run to delete the user", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96555393b", "resource_type": "user", "description": "Deleting user from database", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-99bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 10, "created_at": "2018-03-28T10:23:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type}": { "get": { "tags": [ "Connections" ], "summary": "Discover connection information for a deployment for a user with an endpoint type.", "description": "Discover connection information for a deployment for a user with an endpoint type.", "operationId": "getConnection", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/users/:user_type/:user_id/connections/:endpoint_type" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getConnectionOptions := cloudDatabasesService.NewGetConnectionOptions(\n", " deploymentID,\n", " userType,\n", " \"exampleUserID\",\n", " \"public\",\n", ")\n", "getConnectionOptions.SetCertificateRoot(\"exampleCertRoot\")\n", "\n", "connection, response, err := cloudDatabasesService.GetConnection(getConnectionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(connection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", " userType: userType,\n", " userId: 'exampleUserID',\n", " endpointType: 'public',\n", " certificateRoot: 'exampleCertRoot'\n", "};\n", "\n", "cloudDatabasesService.getConnection(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "connection = cloud_databases_service.get_connection(\n", " id=deployment_id,\n", " user_type=user_type,\n", " user_id='exampleUserID',\n", " endpoint_type='public',\n", " certificate_root='exampleCertRoot',\n", ").get_result()\n", "\n", "print(json.dumps(connection, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "user_type", "in": "path", "required": true, "description": "User type", "schema": { "type": "string" }, "example": "database" }, { "name": "user_id", "in": "path", "required": true, "description": "User ID", "schema": { "type": "string" } }, { "name": "endpoint_type", "in": "path", "required": true, "description": "Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched.", "schema": { "type": "string", "enum": [ "public", "private" ] } }, { "name": "certificate_root", "in": "query", "description": "Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A Connection", "content": { "application/json": { "schema": { "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } }, "examples": { "postgresql": { "value": { "connection": { "postgres": { "composed": [ "postgres://admin:$PASSWORD@1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32121/ibmclouddb?sslmode=verify-full" ], "type": "uri", "scheme": "postgres", "hosts": [ { "hostname": "1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 32121 } ], "path": "/ibmclouddb", "query_options": { "sslmode": "verify-full" }, "authentication": { "method": "direct", "username": "admin", "password": "$PASSWORD" }, "database": "ibmclouddb", "certificate": { "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "PGPASSWORD=$PASSWORD PGSSLROOTCERT=0b22f14b-7ba2-11e8-b8e9-568642342d40 psql 'host=1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud port=32121 dbname=ibmclouddb user=admin sslmode=verify-full" ], "type": "cli", "environment": { "PGPASSWORD": "$PASSWORD" }, "bin": "psql", "arguments": [ [ "host=1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud port=32121 dbname=ibmclouddb user=admin sslmode=verify-full" ] ], "certificate": { "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } }, "redis": { "value": { "connection": { "rediss": { "composed": [ "rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "type": "uri", "scheme": "rediss", "hosts": [ { "hostname": "6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud", "port": 32658 } ], "path": "/0", "query_options": null, "authentication": { "method": "direct", "username": "admin", "password": "$PASSWORD" }, "database": 0, "certificate": { "name": "014c4682-b21d-11e8-b42a-6eef56314b76", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "REDIS_CERTFILE=014c4682-b21d-11e8-b42a-6eef56314b76 redli -u rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "type": "cli", "environment": { "REDIS_CERTFILE\"": "014c4682-b21d-11e8-b42a-6eef56314b76" }, "bin": "redli", "arguments": [ "-u", "rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "certificate": { "name": "014c4682-b21d-11e8-b42a-6eef56314b76", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } }, "elasticsearch": { "value": { "connection": { "cli": { "arguments": [ "-u", "ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD", "https://d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "bin": "curl", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "CURL_CA_BUNDLE=0b22f14b-7ba2-11e8-b8e9-568642342d40 curl -u ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD https://d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "environment": { "CURL_CA_BUNDLE": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "type": "cli" }, "https": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "https://ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:8dc6926bb16c0d52c56cede36cd101481def910fdfdfec3da766da4f9545ff78@d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "hosts": [ { "hostname": "d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31821 } ], "path": "", "query_options": {}, "scheme": "https", "type": "uri" } } } }, "rabbitmq": { "value": { "connection": { "amqps": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "amqps://ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368:$PASSWORD@1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31683" ], "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31683 } ], "path": "", "query_options": {}, "scheme": "amqps", "type": "uri" }, "cli": { "arguments": [ "--username=ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368", "--password=$PASSWORD", "--ssl", "--ssl-ca-cert-file=0b22f14b-7ba2-11e8-b8e9-568642342d40", "--host=1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "--port=31797" ], "bin": "rabbitmqadmin", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "rabbitmqadmin --username=ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368 --password=$PASSWORD --ssl --ssl-ca-cert-file=0b22f14b-7ba2-11e8-b8e9-568642342d40 --host=1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud --port=31797" ], "environment": {}, "type": "cli" }, "https": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "https://ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368:$PASSWORD@1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31797" ], "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31797 } ], "path": "", "query_options": {}, "scheme": "https", "type": "uri" } } } }, "etcd": { "value": { "connection": { "cli": { "arguments": [ "--cacert=0b22f14b-7ba2-11e8-b8e9-568642342d40", "--endpoints=https://ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218", "--user=ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD" ], "bin": "etcdctl", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "ETCDCTL_API=3 etcdctl --cacert=0b22f14b-7ba2-11e8-b8e9-568642342d40 --endpoints=https://ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218 --user=ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD" ], "environment": { "ETCDCTL_API": "3" }, "type": "cli" }, "grpc": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c" }, "certificate": null, "composed": [ "http://ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD@ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218" ], "hosts": [ { "hostname": "ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 32218 } ], "path": "", "query_options": {}, "scheme": "http", "type": "uri" } } } }, "mongodb": { "value": { "connection": { "mongodb": { "composed": [ "mongodb://ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18:$PASSWORD@bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484/ibmclouddb?authSource=admin", "mongodb://ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18:$PASSWORD@bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484/ibmclouddb?authSource=admin" ], "type": "uri", "scheme": "mongodb", "hosts": [ { "hostname": "bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud", "port": 31484, "protocol": "mongodb" }, { "hostname": "bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud", "port": 31484, "protocol": "mongodb" } ], "path": "/ibmclouddb", "query_options": { "authSource": "admin" }, "authentication": { "method": "direct", "username": "ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18", "password": "$PASSWORD" }, "certificate": { "name": "13f690a1-d94d-11e8-955c-127ef829f16b", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "mongo -u ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18 -p $PASSWORD --ssl --sslCAFile 13f690a1-d94d-11e8-955c-127ef829f16b --authenticationDatabase admin --host replset/bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484,bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484" ], "type": "cli", "environment": {}, "bin": "mongo", "arguments": [ [ "-u", "ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18", "-p", "$PASSWORD", "--ssl", "--sslCAFile", "13f690a1-d94d-11e8-955c-127ef829f16b", "--authenticationDatabase", "admin", "--host", "replset/bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484,bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484" ] ], "certificate": { "name": "13f690a1-d94d-11e8-955c-127ef829f16b", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } } } } } }, "403": { "description": "Invalid token" } } }, "post": { "tags": [ "Connections" ], "summary": "Discover connection information for a deployment for a user with substitutions and an endpoint type.", "description": "Discover connection information for a deployment for a user. Behaves the same as the GET method but substitutes the provided password parameter into the returned connection information.", "operationId": "completeConnection", "x-ibm-permissions": { "actions": [ { "name": "POST /v5/ibm/deployments/:deployment_id/users/:user_type/:user_id/connections/:endpoint_type" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type} \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"password\": \"providedpassword\"}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "completeConnectionOptions := cloudDatabasesService.NewCompleteConnectionOptions(\n", " deploymentID,\n", " userType,\n", " \"exampleUserID\",\n", " \"public\",\n", ")\n", "completeConnectionOptions.SetPassword(\"examplePassword\")\n", "completeConnectionOptions.SetCertificateRoot(\"exampleCertRoot\")\n", "\n", "connection, response, err := cloudDatabasesService.CompleteConnection(completeConnectionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(connection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", " userType: userType,\n", " userId: 'exampleUserID',\n", " endpointType: 'public',\n", " password: 'examplePassword',\n", " certificateRoot: 'exampleCertRoot',\n", "};\n", "\n", "cloudDatabasesService.completeConnection(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "connection = cloud_databases_service.complete_connection(\n", " id=deployment_id,\n", " user_type=user_type,\n", " user_id='exampleUserID',\n", " endpoint_type='public',\n", " password='examplePassword',\n", " certificate_root='exampleCertRoot',\n", ").get_result()\n", "\n", "print(json.dumps(connection, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "user_type", "in": "path", "required": true, "description": "User type of `database` is the only currently supported value.", "schema": { "type": "string" }, "example": "database" }, { "name": "user_id", "in": "path", "required": true, "description": "User ID", "schema": { "type": "string" } }, { "name": "endpoint_type", "in": "path", "required": true, "description": "Endpoint Type. The select endpoint must be enabled on the deployment before its connection information can be fetched.", "schema": { "type": "string", "enum": [ "public", "private" ] } } ], "requestBody": { "description": "Optional parameters to be substituted into the response", "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "description": "Password to be substituted into the response" }, "certificate_root": { "type": "string", "description": "Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands." } } }, "example": { "password": "providedpassword" } } } }, "responses": { "200": { "description": "A Connection", "content": { "application/json": { "schema": { "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } }, "examples": { "postgresql": { "value": { "connection": { "postgres": { "composed": [ "postgres://admin:givenpassword@1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32121/ibmclouddb?sslmode=verify-full" ], "type": "uri", "scheme": "postgres", "hosts": [ { "hostname": "1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 32121 } ], "path": "/ibmclouddb", "query_options": null, "authentication": { "method": "direct", "username": "admin", "password": "givenpassword" }, "database": "ibmclouddb", "certificate": { "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "PGPASSWORD=givenpassword PGSSLROOTCERT=0b22f14b-7ba2-11e8-b8e9-568642342d40 psql 'host=1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud port=32121 dbname=ibmclouddb user=admin sslmode=verify-full'" ], "type": "cli", "environment": { "PGPASSWORD": "givenpassword" }, "bin": "psql", "arguments": [ [ "host=1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud port=32121 dbname=ibmclouddb user=admin sslmode=verify-full" ] ], "certificate": { "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } }, "redis": { "value": { "connection": { "rediss": { "composed": [ "rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "type": "uri", "scheme": "rediss", "hosts": [ { "hostname": "6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud", "port": 32658 } ], "path": "/0", "query_options": null, "authentication": { "method": "direct", "username": "admin", "password": "$PASSWORD" }, "database": 0, "certificate": { "name": "014c4682-b21d-11e8-b42a-6eef56314b76", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "REDIS_CERTFILE=014c4682-b21d-11e8-b42a-6eef56314b76 redli -u rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "type": "cli", "environment": { "REDIS_CERTFILE\"": "014c4682-b21d-11e8-b42a-6eef56314b76" }, "bin": "redli", "arguments": [ "-u", "rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "certificate": { "name": "014c4682-b21d-11e8-b42a-6eef56314b76", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } }, "elasticsearch": { "value": { "connection": { "cli": { "arguments": [ "-u", "ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD", "https://d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "bin": "curl", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "CURL_CA_BUNDLE=0b22f14b-7ba2-11e8-b8e9-568642342d40 curl -u ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD https://d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "environment": { "CURL_CA_BUNDLE": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "type": "cli" }, "https": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "https://ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD@d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "hosts": [ { "hostname": "d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31821 } ], "path": "", "query_options": {}, "scheme": "https", "type": "uri" } } } }, "rabbitmq": { "value": { "connection": { "amqps": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "amqps://ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368:$PASSWORD@1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31683" ], "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31683 } ], "path": "", "query_options": {}, "scheme": "amqps", "type": "uri" }, "cli": { "arguments": [ "--username=ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368", "--password=$PASSWORD", "--ssl", "--ssl-ca-cert-file=0b22f14b-7ba2-11e8-b8e9-568642342d40", "--host=1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "--port=31797" ], "bin": "rabbitmqadmin", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "rabbitmqadmin --username=ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368 --password=$PASSWORD --ssl --ssl-ca-cert-file=0b22f14b-7ba2-11e8-b8e9-568642342d40 --host=1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud --port=31797" ], "environment": {}, "type": "cli" }, "https": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "https://ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368:$PASSWORD@1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31797" ], "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31797 } ], "path": "", "query_options": {}, "scheme": "https", "type": "uri" } } } }, "etcd": { "value": { "connection": { "cli": { "arguments": [ "--cacert=0b22f14b-7ba2-11e8-b8e9-568642342d40", "--endpoints=https://ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218", "--user=ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD" ], "bin": "etcdctl", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "ETCDCTL_API=3 etcdctl --cacert=0b22f14b-7ba2-11e8-b8e9-568642342d40 --endpoints=https://ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218 --user=ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD" ], "environment": { "ETCDCTL_API": "3" }, "type": "cli" }, "grpc": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c" }, "certificate": null, "composed": [ "http://ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD@ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218" ], "hosts": [ { "hostname": "ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 32218 } ], "path": "", "query_options": {}, "scheme": "http", "type": "uri" } } } }, "mongodb": { "value": { "connection": { "mongodb": { "composed": [ "mongodb://ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18:$PASSWORD@bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484/ibmclouddb?authSource=admin", "mongodb://ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18:$PASSWORD@bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484/ibmclouddb?authSource=admin" ], "type": "uri", "scheme": "mongodb", "hosts": [ { "hostname": "bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud", "port": 31484, "protocol": "mongodb" }, { "hostname": "bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud", "port": 31484, "protocol": "mongodb" } ], "path": "/ibmclouddb", "query_options": { "authSource": "admin" }, "authentication": { "method": "direct", "username": "ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18", "password": "$PASSWORD" }, "certificate": { "name": "13f690a1-d94d-11e8-955c-127ef829f16b", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "mongo -u ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18 -p $PASSWORD --ssl --sslCAFile 13f690a1-d94d-11e8-955c-127ef829f16b --authenticationDatabase admin --host replset/bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484,bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484" ], "type": "cli", "environment": {}, "bin": "mongo", "arguments": [ [ "-u", "ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18", "-p", "$PASSWORD", "--ssl", "--sslCAFile", "13f690a1-d94d-11e8-955c-127ef829f16b", "--authenticationDatabase", "admin", "--host", "replset/bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484,bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484" ] ], "certificate": { "name": "13f690a1-d94d-11e8-955c-127ef829f16b", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } } } } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/users/{user_id}/": { "get": { "x-sdk-exclude": true, "deprecated": true, "tags": [ "Database Users" ], "summary": "Discover user name and password information for a deployment for a user with an endpoint type.", "description": "Only for Redis v5 and prior: Discover connection information for a deployment for a user with an endpoint type.", "operationId": "getUser", "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_id} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "user_id", "in": "path", "required": true, "description": "User ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" }, "examples": { "redis": { "value": { "connection": { "rediss": { "user": { "username": "admin", "password": "v3ry-1-secUre-pAssword-2" } } } } } } } } }, "500": { "description": "Not Found" } } } }, "/deployments/{id}/users/{user_type}/{user_id}/connections": { "get": { "deprecated": true, "x-sdk-exclude": true, "tags": [ "Connections" ], "summary": "Discover connection information for a deployment for a user.", "description": "Discover connection information for a deployment for a user.", "operationId": "getConnectionDeprecated", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "user_type", "in": "path", "required": true, "description": "User type", "schema": { "type": "string" } }, { "name": "user_id", "in": "path", "required": true, "description": "User ID", "schema": { "type": "string" } }, { "name": "certificate_root", "in": "query", "description": "Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A Connection", "content": { "application/json": { "schema": { "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } }, "examples": { "postgresql": { "value": { "connection": { "postgres": { "composed": [ "postgres://admin:$PASSWORD@1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32121/ibmclouddb?sslmode=verify-full" ], "type": "uri", "scheme": "postgres", "hosts": [ { "hostname": "1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 32121 } ], "path": "/ibmclouddb", "query_options": null, "authentication": { "method": "direct", "username": "admin", "password": "$PASSWORD" }, "database": "ibmclouddb", "certificate": { "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "PGPASSWORD=$PASSWORD PGSSLROOTCERT=0b22f14b-7ba2-11e8-b8e9-568642342d40 psql 'host=1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud port=32121 dbname=ibmclouddb user=admin sslmode=verify-full" ], "type": "cli", "environment": { "PGPASSWORD": "$PASSWORD" }, "bin": "psql", "arguments": [ [ "host=1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud port=32121 dbname=ibmclouddb user=admin sslmode=verify-full" ] ], "certificate": { "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } }, "redis": { "value": { "connection": { "rediss": { "composed": [ "rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "type": "uri", "scheme": "rediss", "hosts": [ { "hostname": "6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud", "port": 32658 } ], "path": "/0", "query_options": null, "authentication": { "method": "direct", "username": "admin", "password": "$PASSWORD" }, "database": 0, "certificate": { "name": "014c4682-b21d-11e8-b42a-6eef56314b76", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "REDIS_CERTFILE=014c4682-b21d-11e8-b42a-6eef56314b76 redli -u rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "type": "cli", "environment": { "REDIS_CERTFILE\"": "014c4682-b21d-11e8-b42a-6eef56314b76" }, "bin": "redli", "arguments": [ "-u", "rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "certificate": { "name": "014c4682-b21d-11e8-b42a-6eef56314b76", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } }, "elasticsearch": { "value": { "connection": { "cli": { "arguments": [ "-u", "ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD", "https://d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "bin": "curl", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "CURL_CA_BUNDLE=0b22f14b-7ba2-11e8-b8e9-568642342d40 curl -u ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD https://d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "environment": { "CURL_CA_BUNDLE": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "type": "cli" }, "https": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "https://ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:8dc6926bb16c0d52c56cede36cd101481def910fdfdfec3da766da4f9545ff78@d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "hosts": [ { "hostname": "d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31821 } ], "path": "", "query_options": {}, "scheme": "https", "type": "uri" } } } }, "rabbitmq": { "value": { "connection": { "amqps": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "amqps://ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368:$PASSWORD@1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31683" ], "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31683 } ], "path": "", "query_options": {}, "scheme": "amqps", "type": "uri" }, "stomp_ssl": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31123, "protocol": "stomp-ssl" } ], "ssl": true, "type": "stomp" }, "cli": { "arguments": [ "--username=ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368", "--password=$PASSWORD", "--ssl", "--ssl-ca-cert-file=0b22f14b-7ba2-11e8-b8e9-568642342d40", "--host=1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "--port=31797" ], "bin": "rabbitmqadmin", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "rabbitmqadmin --username=ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368 --password=$PASSWORD --ssl --ssl-ca-cert-file=0b22f14b-7ba2-11e8-b8e9-568642342d40 --host=1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud --port=31797" ], "environment": {}, "type": "cli" }, "https": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "https://ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368:$PASSWORD@1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31797" ], "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31797 } ], "path": "", "query_options": {}, "scheme": "https", "type": "uri" } } } }, "etcd": { "value": { "connection": { "cli": { "arguments": [ "--cacert=0b22f14b-7ba2-11e8-b8e9-568642342d40", "--endpoints=https://ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218", "--user=ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD" ], "bin": "etcdctl", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "ETCDCTL_API=3 etcdctl --cacert=0b22f14b-7ba2-11e8-b8e9-568642342d40 --endpoints=https://ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218 --user=ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD" ], "environment": { "ETCDCTL_API": "3" }, "type": "cli" }, "grpc": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c" }, "certificate": null, "composed": [ "http://ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD@ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218" ], "hosts": [ { "hostname": "ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 32218 } ], "path": "", "query_options": {}, "scheme": "http", "type": "uri" } } } }, "mongodb": { "value": { "connection": { "mongodb": { "composed": [ "mongodb://ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18:$PASSWORD@bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484/ibmclouddb?authSource=admin", "mongodb://ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18:$PASSWORD@bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484/ibmclouddb?authSource=admin" ], "type": "uri", "scheme": "mongodb", "hosts": [ { "hostname": "bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud", "port": 31484, "protocol": "mongodb" }, { "hostname": "bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud", "port": 31484, "protocol": "mongodb" } ], "path": "/ibmclouddb", "query_options": { "authSource": "admin" }, "authentication": { "method": "direct", "username": "ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18", "password": "$PASSWORD" }, "certificate": { "name": "13f690a1-d94d-11e8-955c-127ef829f16b", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "mongo -u ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18 -p $PASSWORD --ssl --sslCAFile 13f690a1-d94d-11e8-955c-127ef829f16b --authenticationDatabase admin --host replset/bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484,bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484" ], "type": "cli", "environment": {}, "bin": "mongo", "arguments": [ [ "-u", "ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18", "-p", "$PASSWORD", "--ssl", "--sslCAFile", "13f690a1-d94d-11e8-955c-127ef829f16b", "--authenticationDatabase", "admin", "--host", "replset/bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484,bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484" ] ], "certificate": { "name": "13f690a1-d94d-11e8-955c-127ef829f16b", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } } } } } }, "403": { "description": "Invalid token" } } }, "post": { "deprecated": true, "x-sdk-exclude": true, "tags": [ "Connections" ], "summary": "Discover connection information for a deployment for a user with substitutions.", "description": "Discover connection information for a deployment for a user. Behaves the same as the GET method but substitutes the given password parameter into the returned connection information.", "operationId": "completeConnectionDeprecated", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "user_type", "in": "path", "required": true, "description": "User type", "schema": { "type": "string" } }, { "name": "user_id", "in": "path", "required": true, "description": "User ID", "schema": { "type": "string" } } ], "requestBody": { "description": "Optional parameters to be substituted into the response", "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "description": "Password to be substituted into the response" }, "certificate_root": { "type": "string", "description": "Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands." } } } } } }, "responses": { "200": { "description": "A Connection", "content": { "application/json": { "schema": { "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } }, "examples": { "postgresql": { "value": { "connection": { "postgres": { "composed": [ "postgres://admin:givenpassword@1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32121/ibmclouddb?sslmode=verify-full" ], "type": "uri", "scheme": "postgres", "hosts": [ { "hostname": "1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 32121 } ], "path": "/ibmclouddb", "query_options": null, "authentication": { "method": "direct", "username": "admin", "password": "givenpassword" }, "database": "ibmclouddb", "certificate": { "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "PGPASSWORD=givenpassword PGSSLROOTCERT=0b22f14b-7ba2-11e8-b8e9-568642342d40 psql 'host=1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud port=32121 dbname=ibmclouddb user=admin sslmode=verify-full'" ], "type": "cli", "environment": { "PGPASSWORD": "givenpassword" }, "bin": "psql", "arguments": [ [ "host=1b8f53db-fc2d-4e24-8470-f82b15c71717.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud port=32121 dbname=ibmclouddb user=admin sslmode=verify-full" ] ], "certificate": { "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } }, "redis": { "value": { "connection": { "rediss": { "composed": [ "rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "type": "uri", "scheme": "rediss", "hosts": [ { "hostname": "6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud", "port": 32658 } ], "path": "/0", "query_options": null, "authentication": { "method": "direct", "username": "admin", "password": "$PASSWORD" }, "database": 0, "certificate": { "name": "014c4682-b21d-11e8-b42a-6eef56314b76", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "REDIS_CERTFILE=014c4682-b21d-11e8-b42a-6eef56314b76 redli -u rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "type": "cli", "environment": { "REDIS_CERTFILE\"": "014c4682-b21d-11e8-b42a-6eef56314b76" }, "bin": "redli", "arguments": [ "-u", "rediss://admin:$PASSWORD@6a5e3192-83a6-401f-b9ac-9663b68378fe.1cb1834b36b24f729271d2cfcd2f2177.databases.appdomain.cloud:32658/0" ], "certificate": { "name": "014c4682-b21d-11e8-b42a-6eef56314b76", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } }, "elasticsearch": { "value": { "connection": { "cli": { "arguments": [ "-u", "ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD", "https://d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "bin": "curl", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "CURL_CA_BUNDLE=0b22f14b-7ba2-11e8-b8e9-568642342d40 curl -u ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD https://d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "environment": { "CURL_CA_BUNDLE": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "type": "cli" }, "https": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "https://ibm_cloud_9ba7cc3f_5364_4c05_ba35_3e44f33781c4:$PASSWORD@d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31821" ], "hosts": [ { "hostname": "d5eeee66-5bc4-499a-b73b-1307848f1eac.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31821 } ], "path": "", "query_options": {}, "scheme": "https", "type": "uri" } } } }, "rabbitmq": { "value": { "connection": { "amqps": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "amqps://ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368:$PASSWORD@1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31683" ], "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31683 } ], "path": "", "query_options": {}, "scheme": "amqps", "type": "uri" }, "stomp_ssl": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31123, "protocol": "stomp-ssl" } ], "ssl": true, "type": "stomp" }, "cli": { "arguments": [ "--username=ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368", "--password=$PASSWORD", "--ssl", "--ssl-ca-cert-file=0b22f14b-7ba2-11e8-b8e9-568642342d40", "--host=1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "--port=31797" ], "bin": "rabbitmqadmin", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "rabbitmqadmin --username=ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368 --password=$PASSWORD --ssl --ssl-ca-cert-file=0b22f14b-7ba2-11e8-b8e9-568642342d40 --host=1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud --port=31797" ], "environment": {}, "type": "cli" }, "https": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368" }, "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "https://ibm_cloud_6829a37b_2ade_4bc5_953e_949a5a46e368:$PASSWORD@1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:31797" ], "hosts": [ { "hostname": "1a619c43-6415-4abb-8df0-0c7b1b3a3001.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 31797 } ], "path": "", "query_options": {}, "scheme": "https", "type": "uri" } } } }, "etcd": { "value": { "connection": { "cli": { "arguments": [ "--cacert=0b22f14b-7ba2-11e8-b8e9-568642342d40", "--endpoints=https://ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218", "--user=ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD" ], "bin": "etcdctl", "certificate": { "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE...", "name": "0b22f14b-7ba2-11e8-b8e9-568642342d40" }, "composed": [ "ETCDCTL_API=3 etcdctl --cacert=0b22f14b-7ba2-11e8-b8e9-568642342d40 --endpoints=https://ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218 --user=ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD" ], "environment": { "ETCDCTL_API": "3" }, "type": "cli" }, "grpc": { "authentication": { "method": "direct", "password": "$PASSWORD", "username": "ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c" }, "certificate": null, "composed": [ "http://ibm_cloud_59699685_b95e_4afe_9d39_7464c228563c:$PASSWORD@ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud:32218" ], "hosts": [ { "hostname": "ca537b4d-dcf2-467f-bd98-97535f11445b.8f7bfd8f3faa4218aec56e069eb46187.databases.appdomain.cloud", "port": 32218 } ], "path": "", "query_options": {}, "scheme": "http", "type": "uri" } } } }, "mongodb": { "value": { "connection": { "mongodb": { "composed": [ "mongodb://ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18:$PASSWORD@bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484/ibmclouddb?authSource=admin", "mongodb://ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18:$PASSWORD@bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484/ibmclouddb?authSource=admin" ], "type": "uri", "scheme": "mongodb", "hosts": [ { "hostname": "bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud", "port": 31484, "protocol": "mongodb" }, { "hostname": "bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud", "port": 31484, "protocol": "mongodb" } ], "path": "/ibmclouddb", "query_options": { "authSource": "admin" }, "authentication": { "method": "direct", "username": "ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18", "password": "$PASSWORD" }, "certificate": { "name": "13f690a1-d94d-11e8-955c-127ef829f16b", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } }, "cli": { "composed": [ "mongo -u ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18 -p $PASSWORD --ssl --sslCAFile 13f690a1-d94d-11e8-955c-127ef829f16b --authenticationDatabase admin --host replset/bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484,bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484" ], "type": "cli", "environment": {}, "bin": "mongo", "arguments": [ [ "-u", "ibm_cloud_986062af_d976_42d0_aedc_87effaa5ce18", "-p", "$PASSWORD", "--ssl", "--sslCAFile", "13f690a1-d94d-11e8-955c-127ef829f16b", "--authenticationDatabase", "admin", "--host", "replset/bd574ce4-7b36-4274-9976-96db99a3ac10-0.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484,bd574ce4-7b36-4274-9976-96db99a3ac10-1.b8a5e798d2d04f2e860e54e5d042c915.databases.appdomain.cloud:31484" ] ], "certificate": { "name": "13f690a1-d94d-11e8-955c-127ef829f16b", "certificate_base64": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURE..." } } } } } } } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/allowlists/ip_addresses": { "get": { "tags": [ "Security" ], "summary": "Retrieve the allowlisted addresses and ranges for a deployment.", "description": "Retrieve the allowlisted addresses and ranges for a deployment.", "operationId": "getAllowlist", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/allowlists/ip_addresses" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getAllowlistOptions := cloudDatabasesService.NewGetAllowlistOptions(\n", " deploymentID,\n", ")\n", "\n", "allowlist, response, err := cloudDatabasesService.GetAllowlist(getAllowlistOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(allowlist, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.getAllowlist(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "allowlist = cloud_databases_service.get_allowlist(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(allowlist, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "An allowlist", "headers": { "ETag": { "schema": { "type": "string" }, "description": "A hash of the current IP allowlist. Use with the PUT operation's If-Match header to ensure synchronicity between clients." } }, "content": { "application/json": { "schema": { "properties": { "ip_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AllowlistEntry" } } } }, "example": { "ip_addresses": [ { "address": "195.212.0.0/16", "description": "Dev IP space 1" }, { "address": "195.0.0.0/8", "description": "BB Lab" }, { "address": "46.5.0.0/16", "description": "Dev IP space 2" }, { "address": "10.187.176.142/32", "description": "Demo SL VSI" } ] } } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } }, "put": { "tags": [ "Security" ], "summary": "Set the allowlist for a deployment.", "description": "Set the allowlist for a deployment. This action overwrites all existing entries, so when you modify the allowlist via a GET/update/PUT, provide the GET response's ETag header value in this endpoint's If-Match header to ensure that changes that are made by other clients are not accidentally overwritten.", "operationId": "setAllowlist", "x-ibm-permissions": { "actions": [ { "name": "PUT /v5/ibm/deployments/:deployment_id/allowlists/ip_addresses" } ] }, "x-ibm-events": { "events": [ { "name": ".allowlisted-ips-list.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"ip_addresses\": [{\"address\": \"195.212.0.0/16\", \"description\": \"Dev IP space 1\"},{\"address\": \"195.0.0.0/8\", \"description\": \"BB Lab\"}, {\"address\": \"46.5.0.0/16\",\"description\": \"Dev IP space 2\"}, {\"address\": \"10.187.176.142/32\", \"description\": \"Demo SL VSI\"}]}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "allowlistEntryModel := &clouddatabasesv5.AllowlistEntry{\n", " Address: &IPAddress1,\n", " Description: core.StringPtr(\"Dev IP space 1\"),\n", "}\n", "\n", "setAllowlistOptions := cloudDatabasesService.NewSetAllowlistOptions(\n", " deploymentID,\n", ")\n", "setAllowlistOptions.SetIPAddresses([]clouddatabasesv5.AllowlistEntry{*allowlistEntryModel})\n", "setAllowlistOptions.SetIfMatch(\"exampleETag\")\n", "\n", "setAllowlistResponse, response, err := cloudDatabasesService.SetAllowlist(setAllowlistOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(setAllowlistResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const allowlistEntryModel = {\n", " address: ipAddress1,\n", " description: 'Dev IP space 1'\n", "};\n", "\n", "const params = {\n", " id: deploymentId,\n", " ipAddresses: [allowlistEntryModel],\n", " ifMatch: 'exampleETag',\n", "};\n", "\n", "cloudDatabasesService.setAllowlist(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "allowlist_entry_model = AllowlistEntry(\n", " address=ip_address_1,\n", " description='Dev IP space 1',\n", ")\n", "\n", "set_allowlist_response = cloud_databases_service.set_allowlist(\n", " id=deployment_id,\n", " ip_addresses=[allowlist_entry_model],\n", " if_match='exampleETag',\n", ").get_result()\n", "\n", "print(json.dumps(set_allowlist_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": false, "description": "Verify that the current allowlist matches a provided ETag value. Use in conjunction with the GET operation's ETag header to ensure synchronicity between clients.", "schema": { "type": "string" } } ], "requestBody": { "description": "New allowlist", "required": true, "content": { "application/json": { "schema": { "properties": { "ip_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AllowlistEntry" } } } }, "example": { "ip_addresses": [ { "address": "195.212.0.0/16", "description": "Dev IP space 1" }, { "address": "195.0.0.0/8", "description": "BB Lab" }, { "address": "46.5.0.0/16", "description": "Dev IP space 2" }, { "address": "10.187.176.142/32", "description": "Demo SL VSI" } ] } } } }, "responses": { "202": { "description": "A task which is being run to add the allowlist entry", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544573b", "resource_type": "ip", "description": "Updating allowlist for database", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 10, "created_at": "2018-03-28T10:21:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } }, "post": { "tags": [ "Security" ], "summary": "Add an address or range to the allowlist for a deployment.", "description": "Add an address or range to the allowlist for a deployment.", "operationId": "addAllowlistEntry", "x-ibm-permissions": { "actions": [ { "name": "POST /v5/ibm/deployments/:deployment_id/allowlists/ip_addresses" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"ip_address\": {\"address\": \"http://172.16.254.1/16\", \"description\": \"Dev IP space 3\"}}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "allowlistEntryModel := &clouddatabasesv5.AllowlistEntry{\n", " Address: &IPAddress3,\n", " Description: core.StringPtr(\"Dev IP space 3\"),\n", "}\n", "\n", "addAllowlistEntryOptions := cloudDatabasesService.NewAddAllowlistEntryOptions(\n", " deploymentID,\n", ")\n", "addAllowlistEntryOptions.SetIPAddress(allowlistEntryModel)\n", "\n", "addAllowlistEntryResponse, response, err := cloudDatabasesService.AddAllowlistEntry(addAllowlistEntryOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(addAllowlistEntryResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const allowlistEntryModel = {\n", " address: ipAddress3,\n", " description: 'Dev IP space 3',\n", "};\n", "\n", "const params = {\n", " id: deploymentId,\n", " ipAddress: allowlistEntryModel,\n", "};\n", "\n", "cloudDatabasesService.addAllowlistEntry(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "allowlist_entry_model = AllowlistEntry(\n", " address=ip_address_3,\n", " description='Dev IP space 3',\n", ")\n", "\n", "add_allowlist_entry_response = cloud_databases_service.add_allowlist_entry(\n", " id=deployment_id,\n", " ip_address=allowlist_entry_model,\n", ").get_result()\n", "\n", "print(json.dumps(add_allowlist_entry_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "requestBody": { "description": "New allowlist Entry", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ip_address": { "$ref": "#/components/schemas/AllowlistEntry" } } }, "example": { "ip_address": { "address": "172.16.0.0/16", "description": "Dev IP space 3" } } } } }, "responses": { "202": { "description": "A task which is being run to add the allowlist entry", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-d9c96544393b", "resource_type": "ip", "description": "Adding allowlist entry for database", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 10, "created_at": "2018-03-28T10:21:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/allowlists/ip_addresses/{ipaddress}": { "delete": { "tags": [ "Security" ], "summary": "Delete an address or range from the allowlist of a deployment.", "description": "Delete an address or range from the allowlist of a deployment.", "operationId": "deleteAllowlistEntry", "x-ibm-permissions": { "actions": [ { "name": "DELETE /v5/ibm/deployments/:deployment_id/allowlists/ip_addresses/:ip_address_id" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses/{ipaddress} \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteAllowlistEntryOptions := cloudDatabasesService.NewDeleteAllowlistEntryOptions(\n", " deploymentID,\n", " IPAddress3,\n", ")\n", "\n", "deleteAllowlistEntryResponse, response, err := cloudDatabasesService.DeleteAllowlistEntry(deleteAllowlistEntryOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(deleteAllowlistEntryResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", " ipaddress: ipAddress3,\n", "};\n", "\n", "cloudDatabasesService.deleteAllowlistEntry(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "delete_allowlist_entry_response = cloud_databases_service.delete_allowlist_entry(\n", " id=deployment_id,\n", " ipaddress=ip_address_3,\n", ").get_result()\n", "\n", "print(json.dumps(delete_allowlist_entry_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "ipaddress", "in": "path", "required": true, "description": "An IPv4 address or a CIDR range (netmasked IPv4 address)", "schema": { "type": "string" } } ], "responses": { "202": { "description": "A task which is being run to delete the allowlist entry", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4d36-92f3-b5c96544393b", "resource_type": "ip", "description": "Deleting allowlist entry for database", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 15, "created_at": "2018-03-28T10:25:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/management/database_connections": { "delete": { "tags": [ "Management" ], "summary": "Kill connections to a PostgreSQL or EnterpriseDB deployment", "description": "Closes all the connections on a deployment. Available for PostgreSQL and EnterpriseDB ONLY.", "operationId": "killConnections", "x-ibm-permissions": { "actions": [ { "name": "DELETE /v5/ibm/deployments/:deployment_id/management/database_connections" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/management/database_connections \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "killConnectionsOptions := cloudDatabasesService.NewKillConnectionsOptions(\n", " deploymentID,\n", ")\n", "\n", "killConnectionsResponse, response, err := cloudDatabasesService.KillConnections(killConnectionsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(killConnectionsResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.killConnections(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "kill_connections_response = cloud_databases_service.kill_connections(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(kill_connections_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "202": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0c59-4db6-92f3-b5c96544393b", "resource_type": "instance", "description": "Killing all database connections.", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:31:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } } }, "/deployments/{id}/elasticsearch/file_syncs": { "post": { "x-sdk-exclude": true, "tags": [ "Management" ], "summary": "Sync files uploaded to Elasticsearch deployment", "description": "Starts a task that writes files to disk. Available for Elasticsearch ONLY.", "operationId": "fileSync", "x-ibm-permissions": { "actions": [ { "name": "POST /v5/ibm/deployments/:deployment_id/elasticsearch/file_syncs" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/elasticsearch/file_syncs \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/274074dce64e9c423ffc238516c755e1:b125f76a-99bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393b", "resource_type": "instance", "description": "Syncing files from standard index.", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/274074dce64e9c423ffc238516c755e1:b125f76a-99bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:31:30Z" } } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } } }, "/deployments/{id}/postgresql/logical_replication_slots": { "post": { "tags": [ "Management" ], "summary": "Create a new logical replication slot", "description": "Creates a new logical replication slot on the specified database. For use with PostgreSQL and wal2json only.", "operationId": "createLogicalReplicationSlot", "x-ibm-permissions": { "actions": [ { "name": "POST /v5/ibm/deployments/:deployment_id/postgresql/logical_replication_slots" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/postgresql/logical_replication_slots \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"logical_replication_slot\":{\"name\": \"customer_replication\",\"database_name\": \"customers\",\"plugin_type\": \"wal2json\"}}' \\" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the logical replication slot. All fields are required.", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "logical_replication_slot": { "$ref": "#/components/schemas/LogicalReplicationSlot" } } }, "example": { "logical_replication_slot": { "name": "customer_replication", "database_name": "customers", "plugin_type": "wal2json" } } } } }, "responses": { "202": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:eu-de:a/057f598ff0b94d9663c28b68843eaab3:b544602f-ad0a-405b-ba39-2e69d04ff3a2:task:d29ea458-5c11-486f-9182-1984ec5d5314", "resource_type": "instance", "description": "Creating logical replication slot", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:eu-de:a/057f598ff0b94d9663c28b68843eaab3:b544602f-ad0a-405b-ba39-2e69d04ff3a2::", "progress_percent": 0, "created_at": "2019-05-31T10:20:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } } }, "/deployments/{id}/postgresql/logical_replication_slots/{name}": { "delete": { "tags": [ "Management" ], "summary": "Delete a logical replication slot", "description": "Deletes a logical replication slot from a database. For use with PostgreSQL, EnterpriseDB, and wal2json only.", "operationId": "deleteLogicalReplicationSlot", "x-ibm-permissions": { "actions": [ { "name": "DELETE /v5/ibm/deployments/:deployment_id/postgresql/logical_replication_slots/:name" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/postgresql/logical_replication_slots/customer_replication \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "description": "Name of the logical replication slot", "schema": { "type": "string" } } ], "responses": { "202": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:eu-de:a/057f598ff0b94d9663c28b68843eaab3:b544602f-ad0a-405b-ba39-2e69d04ff3a2:task:d29ea458-5c11-486f-9182-1894ec5d5314", "resource_type": "instance", "description": "Deleting logical replication slot", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:eu-de:a/057f598ff0b94d9663c28b68843eaab3:b544602f-ad0a-405b-ba39-2e69d04ff3a2::", "progress_percent": 0, "created_at": "2019-05-31T10:20:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } } }, "/deployments/{id}/configuration": { "patch": { "tags": [ "Database Configuration" ], "summary": "Change your database configuration", "description": "Change your database configuration. Available for PostgreSQL, EnterpriseDB, MySQL, RabbitMQ and Redis ONLY.", "operationId": "updateDatabaseConfiguration", "x-ibm-permissions": { "actions": [ { "name": "PATCH /v5/ibm/deployments/:deployment_id/configuration" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/configuration \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"configuration\": {\"max_connections\": 200}}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "setConfigurationConfigurationModel := &clouddatabasesv5.SetConfigurationConfigurationPgConfiguration{\n", " MaxConnections: core.Int64Ptr(int64(200)),\n", " MaxPreparedTransactions: core.Int64Ptr(int64(0)),\n", " DeadlockTimeout: core.Int64Ptr(int64(100)),\n", " EffectiveIoConcurrency: core.Int64Ptr(int64(1)),\n", " MaxReplicationSlots: core.Int64Ptr(int64(10)),\n", " MaxWalSenders: core.Int64Ptr(int64(12)),\n", " SharedBuffers: core.Int64Ptr(int64(16)),\n", " SynchronousCommit: core.StringPtr(\"local\"),\n", " WalLevel: core.StringPtr(\"hot_standby\"),\n", " ArchiveTimeout: core.Int64Ptr(int64(300)),\n", " LogMinDurationStatement: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "updateDatabaseConfigurationOptions := cloudDatabasesService.NewUpdateDatabaseConfigurationOptions(\n", " deploymentID,\n", " setConfigurationConfigurationModel,\n", ")\n", "\n", "updateDatabaseConfigurationResponse, response, err := cloudDatabasesService.UpdateDatabaseConfiguration(updateDatabaseConfigurationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(updateDatabaseConfigurationResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const setConfigurationConfigurationModel = {\n", " max_connections: 200,\n", " max_prepared_transactions: 0,\n", " deadlock_timeout: 100,\n", " effective_io_concurrency: 1,\n", " max_replication_slots: 10,\n", " max_wal_senders: 12,\n", " shared_buffers: 16,\n", " synchronous_commit: 'local',\n", " wal_level: 'hot_standby',\n", " archive_timeout: 300,\n", " log_min_duration_statement: 100,\n", "};\n", "\n", "const params = {\n", " id: deploymentId,\n", " configuration: setConfigurationConfigurationModel,\n", "};\n", "\n", "cloudDatabasesService.updateDatabaseConfiguration(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "set_configuration_configuration_model = SetConfigurationConfigurationPGConfiguration(\n", " max_connections=200,\n", " max_prepared_transactions=0,\n", " deadlock_timeout=100,\n", " effective_io_concurrency=1,\n", " max_replication_slots=10,\n", " max_wal_senders=12,\n", " shared_buffers=16,\n", " synchronous_commit='local',\n", " wal_level='hot_standby',\n", " archive_timeout=300,\n", " log_min_duration_statement=100,\n", ")\n", "\n", "update_database_configuration_response = cloud_databases_service.update_database_configuration(\n", " id=deployment_id,\n", " configuration=set_configuration_configuration_model,\n", ").get_result()\n", "\n", "print(json.dumps(update_database_configuration_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "requestBody": { "description": "Database configuration", "required": true, "content": { "application/json": { "schema": { "properties": { "configuration": { "$ref": "#/components/schemas/Configuration" } } }, "example": { "configuration": { "max_connections": 200 } } } } }, "responses": { "200": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393a", "resource_type": "configuration", "description": "Applying new configuration", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:31:30Z" } } } } }, "links": { "taskId": { "$ref": "#/components/links/taskId" } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } } }, "/deployments/{id}/configuration/schema": { "get": { "x-sdk-exclude": true, "tags": [ "Database Configuration" ], "summary": "Get the schema of the database configuration", "description": "Get the schema of the database configuration. Available for PostgreSQL and Redis ONLY.", "operationId": "getDatabaseConfigurationSchema", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/configuration/schema" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/configuration/schema \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A database configuration schema", "content": { "application/json": { "schema": { "properties": { "schema": { "$ref": "#/components/schemas/ConfigurationSchema" } } }, "example": { "schema": { "max_connections": { "default": 115, "default_description": "This property has no documentation for its default value.", "description": "Maximum Connections allowed.", "kind": "integer", "requires_restart": true, "min": 115, "max": 30000, "step": null }, "max_locks_per_transaction": { "default": 64, "default_description": "The default, 64, has historically proven sufficient, but you might need to raise this value if you have queries that touch many different tables in a single transaction, e.g. query of a parent table with many children. This parameter can only be set at server start.", "description": "Limits the average number of object locks used by each transaction.", "kind": "integer", "requires_restart": true, "min": 10, "max": null }, "max_prepared_transactions": { "default": 0, "default_description": "This property has no documentation for its default value.", "description": "Max number of transactions that can be in the \"prepared\" state simultaneously.", "kind": "integer", "max": null, "min": 0, "requires_restart": true, "step": null } } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } } }, "/deployments/{id}/remotes": { "get": { "tags": [ "Remotes" ], "summary": "List read-only replica information", "description": "Get the read-only replicas associated with a deployment. Available for PostgreSQL and EnterpriseDB ONLY.", "operationId": "listRemotes", "x-ibm-permissions": { "actions": [ { "name": "GET /v5/ibm/deployments/:deployment_id/remotes" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/remotes \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listRemotesOptions := cloudDatabasesService.NewListRemotesOptions(\n", " deploymentID,\n", ")\n", "\n", "listRemotesResponse, response, err := cloudDatabasesService.ListRemotes(listRemotesOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(listRemotesResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: deploymentId,\n", "};\n", "\n", "cloudDatabasesService.listRemotes(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "list_remotes_response = cloud_databases_service.list_remotes(\n", " id=deployment_id,\n", ").get_result()\n", "\n", "print(json.dumps(list_remotes_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A remotes object", "content": { "application/json": { "schema": { "type": "object", "properties": { "remotes": { "$ref": "#/components/schemas/Remotes" } }, "example": { "remotes": { "leader": "", "replicas": [ "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/389574dce64e9c423ffc238516c755e1:0e399ae3-4a1a-476d-b85b-755c7af54788::" ] } } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } }, "patch": { "deprecated": true, "x-sdk-exclude": true, "tags": [ "Remotes" ], "summary": "Modify read-only replication on a deployment", "description": "Promote a read-only remote replica to leader by calling with leader set to an empty string. Available for PostgreSQL and EnterpriseDB ONLY.", "operationId": "setRemotes", "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/remotes \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"remotes\": {\"leader\": \"\"}}' \\" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters for promoting a read-only replica", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "remotes": { "type": "object", "properties": { "leader": { "type": "string", "description": "Leader should be an empty string", "example": "" } } }, "skip_initial_backup": { "type": "boolean", "description": "Option to restore instance without taking a backup once data is restored. Allows restored deployment to be available sooner.", "default": false } } } } } }, "responses": { "200": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:5abb6a7d11a1a5001479a0b0", "resource_type": "instance", "description": "Promoting read-only replica to standalone instance.", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:31:30Z" } } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" }, "422": { "description": "promotion is the only feature supported and must be requested as an empty string" } } } }, "/deployments/{id}/remotes/resync": { "post": { "tags": [ "Remotes" ], "summary": "Resync read-only replica", "description": "Reinitialize a read-only replica. Available for PostgreSQL and EnterpriseDB ONLY.", "operationId": "resyncReplica", "x-ibm-permissions": { "actions": [ { "name": "POST /v5/ibm/deployments/:deployment_id/remotes/resync" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/remotes/resync \\\n -H 'Authorization: Bearer <>' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "resyncReplicaOptions := cloudDatabasesService.NewResyncReplicaOptions(\n", " replicaID,\n", ")\n", "\n", "resyncReplicaResponse, response, err := cloudDatabasesService.ResyncReplica(resyncReplicaOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(resyncReplicaResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: replicaId,\n", "};\n", "\n", "cloudDatabasesService.resyncReplica(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "resync_replica_response = cloud_databases_service.resync_replica(\n", " id=replica_id,\n", ").get_result()\n", "\n", "print(json.dumps(resync_replica_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID of the read-only replica", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:5abb6a7d11a1a5001479a0b0", "resource_type": "instance", "description": "Reinitializing read-only replica.", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:31:30Z" } } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" } } } }, "/deployments/{id}/remotes/promotion": { "post": { "tags": [ "Remotes" ], "summary": "Promote read-only replica to a full deployment", "description": "Promote a read-only replica or upgrade and promote a read-only replica. Available for PostgreSQL and EnterpriseDB ONLY.", "operationId": "promoteReadOnlyReplica", "x-ibm-permissions": { "actions": [ { "name": "POST /v5/ibm/deployments/:deployment_id/remotes/promotion" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/remotes/promotion \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"promotion\": {\"skip_initial_backup\": false}}' \\" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "promotion := map[string]interface{}{\n", " \"skip_initial_backup\": false,\n", "}\n", "\n", "setPromotionPromotionModel := &clouddatabasesv5.SetPromotionPromotionPromote{\n", " Promotion: promotion,\n", "}\n", "\n", "setPromotionOptions := cloudDatabasesService.NewSetPromotionOptions(\n", " replicaID,\n", " setPromotionPromotionModel,\n", ")\n", "\n", "setPromotionResponse, response, err := cloudDatabasesService.SetPromotion(setPromotionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(setPromotionResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const promotion = {\n", " skip_initial_backup: true,\n", "};\n", "\n", "const setPromotionPromotionModel = {\n", " promotion: promotion,\n", "};\n", "\n", "const params = {\n", " id: replicaId,\n", " promotion: setPromotionPromotionModel,\n", "};\n", "\n", "cloudDatabasesService.setPromotion(params)\n", " .then(res => {\n", " console.log(JSON.stringify(res.result, null, 2));\n", " })\n", " .catch(err => {\n", " console.warn(err)\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "promotion = {\n", " 'skip_initial_backup': True,\n", "}\n", "\n", "set_promotion_model = SetPromotionPromotionPromote(\n", " promotion=promotion,\n", ")\n", "\n", "set_promotion_response = cloud_databases_service.set_promotion(\n", " id=replica_id,\n", " promotion=set_promotion_model,\n", ").get_result()\n", "\n", "print(json.dumps(set_promotion_response, indent=2))" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID of the read-only replica to promote", "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters for promoting a read-only replica", "required": true, "content": { "application/json": { "schema": { "properties": { "promotion": { "$ref": "#/components/schemas/Promotion" } } }, "example": { "promotion": { "skip_initial_backup": false } } } } }, "responses": { "200": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:5abb6a7d11a1a5001479a0b0", "resource_type": "instance", "description": "Promoting read-only replica to standalone instance.", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2018-03-28T10:31:30Z" } } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" }, "433": { "description": "An error message response from sending invalid body parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } }, "/deployments/{id}/version": { "patch": { "tags": [ "In-place version upgrade" ], "summary": "Upgrade your database version", "description": "Upgrade your database version. See version upgrade documentation for details", "operationId": "setDatabaseInplaceVersionUpgrade", "x-ibm-permissions": { "actions": [ { "name": "PATCH /v5/ibm/deployments/:deployment_id/version" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example curl request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \\\n https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/version?expiration_datetime='2027-07-07T17:17:17Z' \\\n -H 'Authorization: Bearer <>' \\\n -H 'Content-Type: application/json' \\\n -d '{\"version\": \"7.2\"}' \\" ] } ] } ] } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deployment ID", "schema": { "type": "string" } }, { "name": "skip_backup", "in": "query", "required": false, "description": "(Optional, Boolean) Whether to skip taking a backup before upgrading the database version. This is only applicable for supported database types. To learn more, refer to the version upgrade documentation.", "schema": { "type": "boolean", "example": true } }, { "name": "expiration_datetime", "in": "query", "required": false, "description": "The expiration_datetime must be in the ISO8601 timestamp format and between 5 minutes and 24 hours from now. It allows you to specify how long to wait for the job to start before the upgrade is cancelled.", "schema": { "type": "string", "format": "date-time", "example": "2025-10-05T17:17:17Z" } } ], "requestBody": { "description": "In-place version upgrade", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetInplaceVersionUpgrade" } } } }, "responses": { "200": { "description": "A task", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/Task" } }, "example": { "task": { "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393a", "resource_type": "upgrade", "description": "Upgrade database version", "status": "running", "deployment_id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd::", "progress_percent": 5, "created_at": "2025-10-05T17:17:17Z" } } } } } }, "403": { "description": "Invalid token" }, "404": { "description": "not found" }, "422": { "description": "An error message response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } } } } }, "components": { "links": { "taskId": { "description": "link to task_id", "operationId": "getTask", "parameters": { "id": "$response.body#/task/id" } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }, "schemas": { "Task": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the task." }, "resource_type": { "type": "string", "description": "The resource type of the task", "enum": [ "backup", "ip", "user", "password", "instance", "configuration", "upgrade" ] }, "description": { "type": "string", "description": "Human-readable description of the task." }, "status": { "type": "string", "description": "The status of the task.", "enum": [ "queued", "running", "completed", "failed", "expired" ] }, "deployment_id": { "type": "string", "description": "ID of the deployment the task is being performed on." }, "progress_percent": { "type": "integer", "format": "int32", "description": "Indicator as percentage of progress of the task." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the task was created." } } }, "Backups": { "type": "object", "title": "Backups", "x-data-source-name": "database_backups", "x-data-source-collection": "backups", "x-terraform-data-source-filter": "deployment_id", "x-data-source-operations": { "read": "listDeploymentBackups" }, "properties": { "backups": { "type": "array", "description": "An array of backups.", "items": { "$ref": "#/components/schemas/Backup" } } }, "example": { "backups": [ { "id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/2740839ce64e9c423ffc238516c755e1:afa742a3-6f83-4f6e-a06e-b5c501e9e87a:backup:e47213d6-4a13-47f4-a511-9ef459670192", "deployment_id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/2740839ce64e9c423ffc238516c755e1:afa742a3-6f83-4f6e-a06e-b5c501e9e87a::", "type": "scheduled", "status": "completed", "is_downloadable": false, "is_restorable": true, "created_at": "2019-05-29T14:30:46.000Z" }, { "id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/2740839ce64e9c423ffc238516c755e1:afa742a3-6f83-4f6e-a06e-b5c501e9e87a:backup:ec07e9be-9ad8-48ad-a22e-bc93abe66339", "deployment_id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/2740839ce64e9c423ffc238516c755e1:afa742a3-6f83-4f6e-a06e-b5c501e9e87a::", "type": "scheduled", "status": "completed", "is_downloadable": false, "is_restorable": true, "created_at": "2019-05-18T14:30:39.000Z" } ] } }, "Backup": { "type": "object", "title": "Backup", "x-data-source-name": "database_backup", "x-data-source-operations": { "read": "getBackupInfo" }, "properties": { "id": { "type": "string", "description": "ID of this backup.", "example": "5a970218cb7544000671c094" }, "deployment_id": { "type": "string", "description": "ID of the deployment this backup relates to.", "example": "595eada310b7ac00116dd48b" }, "type": { "type": "string", "description": "The type of backup.", "enum": [ "scheduled", "on_demand" ], "example": "scheduled" }, "status": { "type": "string", "description": "The status of this backup.", "enum": [ "running", "completed", "failed" ], "example": "running" }, "is_downloadable": { "type": "boolean", "description": "Is this backup available to download?", "example": true }, "is_restorable": { "type": "boolean", "description": "Can this backup be used to restore an instance?", "example": true }, "download_link": { "type": "string", "description": "URI which is currently available for file downloading", "example": "https://securedownloadservice.com/backup-2018-02-28T19:25:12Z.tgz" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when this backup was created.", "example": "2018-02-28T19:25:12Z" } } }, "Deployment": { "type": "object", "x-data-source-name": "database", "x-data-source-operations": { "read": "getDeploymentInfo" }, "properties": { "id": { "type": "string", "description": "ID of this deployment.", "example": "crn:v1:bluemix:public:databases-for-redis:us-south:a/274074dce64e9c423ffc238516c755e1:29caf0e7-120f-4da8-9551-3abf57ebcfc7::" }, "name": { "type": "string", "description": "Readable name of this deployment.", "example": "crn:v1:bluemix:public:databases-for-redis:us-south:a/274074dce64e9c423ffc238516c755e1:29caf0e7-120f-4da8-9551-3abf57ebcfc7::" }, "type": { "type": "string", "description": "Database type within this deployment.", "example": "redis" }, "platform": { "type": "string", "description": "Platform for this deployment.", "example": "satellite, classic" }, "platform_options": { "type": "object", "description": "Platform-specific options for this deployment.", "additionalProperties": true }, "version": { "type": "string", "description": "Version number of the database.", "example": "4" }, "admin_usernames": { "type": "object", "description": "Login name of administration level user.", "additionalProperties": { "type": "string" } }, "enable_public_endpoints": { "type": "boolean", "description": "Whether access to this deployment is enabled from the public internet. This property can be modified by updating this service instance through the Resource Controller API.", "example": true }, "enable_private_endpoints": { "type": "boolean", "description": "Whether access to this deployment is enabled from IBM Cloud via the IBM Cloud backbone network. This property can be modified by updating this service instance through the Resource Controller API.", "example": false } } }, "Capability": { "type": "object", "properties": { "autoscaling": { "type": "object", "$ref": "#/components/schemas/AutoscalingCapability" }, "encryption": { "type": "object", "$ref": "#/components/schemas/EncryptionCapability" }, "endpoints": { "type": "object", "$ref": "#/components/schemas/EndpointsCapability" }, "groups": { "$ref": "#/components/schemas/GroupsCapability" }, "flavors": { "type": "array", "$ref": "#/components/schemas/FlavorsCapability" }, "locations": { "type": "object", "$ref": "#/components/schemas/LocationsCapability" }, "point_in_time_recovery": { "type": "object", "$ref": "#/components/schemas/PointInTimeRecoveryCapability" }, "remotes": { "type": "object", "$ref": "#/components/schemas/RemotesCapability" }, "restores": { "type": "object", "$ref": "#/components/schemas/RestoresCapability" }, "versions": { "type": "array", "$ref": "#/components/schemas/VersionsCapability" } } }, "AutoscalingCapability": { "type": "object", "properties": { "autoscaling_supported": { "type": "boolean", "description": "Autoscaling capability.", "example": true } } }, "EncryptionCapability": { "type": "object", "properties": { "disk_encryption_supported": { "type": "boolean", "description": "Disk encryption capability.", "example": true } } }, "EndpointsCapability": { "type": "object", "properties": { "direct_endpoints_supported": { "type": "boolean", "description": "Direct endpoints capability.", "example": false }, "public_endpoints_supported": { "type": "boolean", "description": "Public endpoints capability.", "example": true }, "private_endpoints_supported": { "type": "boolean", "description": "Private endpoints capability.", "example": true }, "multiple_endpoints_supported": { "type": "boolean", "description": "Multiple endpoints capability.", "example": true } } }, "GroupsCapability": { "type": "array", "title": "GroupsCapability", "items": { "$ref": "#/components/schemas/Group" } }, "FlavorsCapability": { "type": "array", "title": "FlavorsCapability", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Host flavor id", "example": "b3c.4x16.encrypted" }, "name": { "type": "string", "description": "Host flavor name", "example": "4x16" }, "cpu": { "type": "object", "properties": { "allocation_count": { "type": "integer", "description": "Allocated number of cpus", "example": 2 } } }, "memory": { "type": "object", "properties": { "allocation_mb": { "type": "integer", "description": "Allocated memory in MB", "example": 12288 } } }, "hosting_size": { "type": "string", "example": "xs", "description": "Host flavor size" } } } }, "LocationsCapability": { "type": "object", "properties": { "locations": { "type": "array", "description": "An array of regions and satellite locations.", "items": { "type": "string", "description": "Location", "example": "us-south" } } } }, "PointInTimeRecoveryCapability": { "type": "object", "properties": { "point_in_time_recovery_supported": { "type": "boolean", "description": "Point in time recovery capability.", "example": true } } }, "RemotesCapability": { "type": "object", "properties": { "read_only_replicas_supported": { "type": "boolean", "description": "Read-only replica capability.", "example": true } } }, "RestoresCapability": { "type": "object", "description": "Only available for requests with Backup. Only available capability for Backup requests.", "properties": { "backup_restore_supported": { "type": "boolean", "description": "Backup restore capability.", "example": true } } }, "VersionsCapability": { "type": "array", "description": "An array of versions of the database, their status, preferedness, and transitions", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The database type", "example": "elasticsearch" }, "version": { "type": "string", "description": "The version number", "example": "5.6" }, "status": { "type": "string", "description": "The status of this version: To be finalized", "enum": [ "deprecated", "beta", "stable" ], "example": "stable" }, "is_preferred": { "type": "boolean", "example": true, "description": "Should this version be preferred over others?" }, "transitions": { "type": "array", "description": "versions that this version can be upgraded to", "items": { "type": "object", "properties": { "application": { "type": "string", "description": "The database type", "example": "elasticsearch" }, "method": { "type": "string", "description": "method of going from from_version to to_version", "example": "restore" }, "skip_backup_supported": { "type": "boolean", "description": "Option to upgrade instance without taking a backup.", "example": false }, "from_version": { "type": "string", "description": "The version the transition in from", "example": "5.6" }, "to_version": { "type": "string", "description": "The version the transition is to", "example": "6.7" } } } } } } }, "Deployables": { "type": "object", "title": "Deployables", "description": "Deployable databases with their version information", "properties": { "type": { "type": "string", "description": "Deployment type - typically the name of the database", "example": "elasticsearch" }, "versions": { "type": "array", "description": "An array of versions of the database, their status, preferedness, and transitions", "items": { "type": "object", "properties": { "version": { "type": "string", "description": "The version number", "example": "5.6" }, "status": { "type": "string", "description": "The status of this version: To be finalized", "enum": [ "deprecated", "beta", "stable" ], "example": "stable" }, "is_preferred": { "type": "boolean", "example": true, "description": "Should this version be preferred over others?" }, "transitions": { "type": "array", "description": "versions that this version can be upgraded to", "items": { "type": "object", "properties": { "application": { "type": "string", "description": "The database type", "example": "elasticsearch" }, "method": { "type": "string", "description": "in-place or restore method of going from from_version to to_version", "example": "restore" }, "skip_backup_supported": { "type": "boolean", "description": "Option to upgrade instance without taking a backup.", "example": false }, "from_version": { "type": "string", "description": "The version the transition in from", "example": "5.6" }, "to_version": { "type": "string", "description": "The version the transition is to", "example": "6.7" } } } } } } } } }, "Connection": { "type": "object", "x-data-source-name": "database_connection", "x-data-source-operations": { "read": "getConnection" }, "oneOf": [ { "$ref": "#/components/schemas/PostgreSQLConnection" }, { "$ref": "#/components/schemas/RedisConnection" }, { "$ref": "#/components/schemas/ElasticsearchConnection" }, { "$ref": "#/components/schemas/RabbitMQConnection" }, { "$ref": "#/components/schemas/EtcdConnection" }, { "$ref": "#/components/schemas/MongoDBConnection" }, { "$ref": "#/components/schemas/MongoDBEEConnection" }, { "$ref": "#/components/schemas/MongoDBEEOpsManagerConnection" }, { "$ref": "#/components/schemas/MySQLConnection" }, { "$ref": "#/components/schemas/EnterpriseDBConnection" } ] }, "PostgreSQLConnection": { "description": "PostgreSQL and EnterpriseDB Connection Strings", "type": "object", "required": [ "postgres", "cli" ], "properties": { "postgres": { "description": "Connection information for drivers and libraries", "$ref": "#/components/schemas/PostgreSQLConnectionURI" }, "cli": { "description": "Connection information for psql", "$ref": "#/components/schemas/ConnectionCLI" } } }, "PostgreSQLConnectionURI": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectionURI" } ], "properties": { "database": { "type": "string", "description": "Name of the database to use in the URI connection" } } }, "EnterpriseDBConnection": { "description": "PostgreSQL and EnterpriseDB Connection Strings", "type": "object", "required": [ "postgres", "emp", "cli" ], "properties": { "postgres": { "description": "Connection information for drivers and libraries", "$ref": "#/components/schemas/PostgreSQLConnectionURI" }, "emp": { "description": "Connection information for emp", "$ref": "#/components/schemas/ConnectionURI" }, "cli": { "description": "Connection information for psql", "$ref": "#/components/schemas/ConnectionCLI" } } }, "RedisConnection": { "description": "Redis Connection Strings", "type": "object", "required": [ "rediss", "cli" ], "properties": { "rediss": { "description": "Connection information for drivers and libraries.", "$ref": "#/components/schemas/RedisConnectionURI" }, "cli": { "description": "Connection information for a Redis CLI client", "$ref": "#/components/schemas/ConnectionCLI" } } }, "RedisConnectionURI": { "allOf": [ { "$ref": "#/components/schemas/ConnectionURI" } ], "properties": { "database": { "type": "integer", "description": "Number of the database to use in the URI connection" } } }, "ElasticsearchConnection": { "description": "Elasticsearch Connection Strings", "type": "object", "required": [ "https", "cli" ], "properties": { "https": { "description": "Elasticsearch Connection information for drivers and libraries", "$ref": "#/components/schemas/ConnectionURI" }, "cli": { "description": "Connection information for cURL", "$ref": "#/components/schemas/ConnectionCLI" } } }, "EtcdConnection": { "description": "etcd3 Connection Strings", "type": "object", "required": [ "grpc", "cli" ], "properties": { "grpc": { "description": "GRPC(etcd3) Connection information for drivers and libraries", "$ref": "#/components/schemas/ConnectionURI" }, "cli": { "description": "Connection information for etcdctl", "$ref": "#/components/schemas/ConnectionCLI" } } }, "MongoDBConnection": { "description": "MongoDB Connection Strings", "type": "object", "required": [ "mongodb", "cli" ], "properties": { "mongodb": { "description": "MongoDB Connection information for drivers and libraries", "$ref": "#/components/schemas/MongoDBConnectionURI" }, "cli": { "description": "Connection information for mongo shell", "$ref": "#/components/schemas/ConnectionCLI" } } }, "MongoDBEEConnection": { "description": "MongoDB Connection Strings", "type": "object", "required": [ "mongodb", "cli" ], "properties": { "mongodb": { "description": "MongoDB Connection information for drivers and libraries", "$ref": "#/components/schemas/MongoDBConnectionURI" }, "cli": { "description": "Connection information for mongo shell", "$ref": "#/components/schemas/ConnectionCLI" }, "bi_connector": { "description": "MongoDB BI Connector Connection information for drivers and libraries", "$ref": "#/components/schemas/ConnectionURI" }, "analytics": { "description": "MongoDB Anyalytics Connection information for drivers and libraries", "$ref": "#/components/schemas/ConnectionURI" } } }, "MongoDBEEOpsManagerConnection": { "description": "MongoDB Connection Strings", "type": "object", "required": [ "opsmanager" ], "properties": { "ops_manager": { "description": "MongoDB Enterprise Edition Connection information for Ops Manager", "$ref": "#/components/schemas/ConnectionURI" } } }, "MongoDBConnectionURI": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectionURI" } ], "properties": { "database": { "type": "string", "description": "Name of the database to use in the URI connection" }, "replica_set": { "type": "string", "description": "Name of the replica set to use in the URI connection" } } }, "RabbitMQConnection": { "description": "RabbitMQ Connection Strings", "type": "object", "required": [ "amqps", "stomp_ssl", "mqtts", "https", "cli" ], "properties": { "amqps": { "description": "RabbitMQ Connection information for AMQPS drivers and libraries", "$ref": "#/components/schemas/ConnectionURI" }, "mqtts": { "description": "RabbitMQ Connection information for MQTTS drivers and libraries", "$ref": "#/components/schemas/ConnectionURI" }, "stomp_ssl": { "description": "RabbitMQ Connection information for STOMP drivers and libraries", "$ref": "#/components/schemas/ConnectionURI" }, "https": { "description": "RabbitMQ Connection information for HTTPS", "$ref": "#/components/schemas/ConnectionURI" }, "cli": { "description": "Connection information for rabbitmqadmin", "$ref": "#/components/schemas/ConnectionCLI" } } }, "MySQLConnection": { "description": "MySQL Connection Strings", "type": "object", "required": [ "mysql", "cli" ], "properties": { "mysql": { "description": "MySQL Connection information for drivers and libraries", "$ref": "#/components/schemas/MySQLConnectionURI" }, "cli": { "description": "MySQL Connection information for mysql", "$ref": "#/components/schemas/ConnectionCLI" } } }, "MySQLConnectionURI": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectionURI" } ], "properties": { "database": { "type": "string", "description": "Name of the database to use in the URI connection" } } }, "ConnectionURI": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of connection being described", "example": "uri" }, "composed": { "type": "array", "items": { "type": "string", "description": "Array of fully composed URI connection strings" } }, "scheme": { "type": "string", "description": "Scheme/protocol for URI connection" }, "hosts": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionHost" } }, "path": { "type": "string", "description": "Path for URI connection" }, "query_options": { "type": "object", "description": "Query options to add to the URI connection", "additionalProperties": true }, "authentication": { "$ref": "#/components/schemas/ConnectionAuthentication" }, "certificate": { "$ref": "#/components/schemas/ConnectionCertificate" }, "ssl": { "type": "boolean", "description": "Indicates ssl is required for the connection" }, "browser_accessible": { "type": "boolean", "description": "Indicates the address is accessible by browser" } } }, "ConnectionCLI": { "description": "CLI Connection", "type": "object", "properties": { "type": { "type": "string", "description": "Type of connection being described", "example": "cli" }, "composed": { "type": "array", "items": { "type": "string", "description": "Array of fully composed CLI connection strings" } }, "environment": { "description": "A map of environment variables for a CLI connection", "type": "object", "additionalProperties": true }, "bin": { "type": "string", "description": "The name of the executable the CLI should run" }, "arguments": { "description": "Sets of arguments to call the executable with. The outer array corresponds to a possible way to call the CLI; the inner array is the set of arguments to use with that call.", "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "certificate": { "$ref": "#/components/schemas/ConnectionCertificate" } } }, "ConnectionHost": { "description": "Connection hostname and port", "type": "object", "properties": { "hostname": { "type": "string", "description": "Hostname for connection" }, "port": { "type": "integer", "description": "Port number for connection" } } }, "ConnectionAuthentication": { "description": "Authentication data for Connection String", "type": "object", "properties": { "method": { "type": "string", "description": "Authentication method for this credential" }, "username": { "type": "string", "description": "Username part of credential" }, "password": { "type": "string", "description": "Password part of credential" } } }, "ConnectionCertificate": { "type": "object", "properties": { "name": { "type": "string", "description": "Name associated with the certificate" }, "certificate_base64": { "type": "string", "description": "Base64 encoded version of the certificate" } } }, "ConnectionBundle": { "type": "object", "properties": { "name": { "type": "string", "description": "Name associated with the certificate" }, "bundle_base64": { "type": "string", "description": "Base64 encoded version of the certificate bundle" } } }, "Group": { "type": "object", "properties": { "id": { "type": "string", "description": "Id/name for group", "enum": [ "member", "search", "bi_connector", "analytics" ], "example": "member" }, "count": { "type": "integer", "description": "Number of entities in the group", "example": 2 }, "members": { "type": "object", "properties": { "units": { "type": "string", "description": "Units used for scaling number of members", "example": "count" }, "allocation_count": { "type": "integer", "description": "Allocated number of members", "example": 2 }, "minimum_count": { "type": "integer", "description": "Minimum number of members", "example": 2 }, "maximum_count": { "type": "integer", "description": "Maximum number of members", "example": 20 }, "step_size_count": { "type": "integer", "description": "Step size for number of members", "example": 1 }, "is_adjustable": { "type": "boolean", "description": "Is this deployment's number of members adjustable?", "example": true }, "is_optional": { "type": "boolean", "description": "Is this deployments's number of members optional?", "example": false }, "can_scale_down": { "type": "boolean", "description": "Can this deployment's number of members scale down?", "example": false } } }, "memory": { "type": "object", "properties": { "units": { "type": "string", "description": "Units used for scaling memory", "example": "mb" }, "allocation_mb": { "type": "integer", "description": "Allocated memory in MB", "example": 12288 }, "minimum_mb": { "type": "integer", "description": "Minimum memory in MB", "example": 1024 }, "maximum_mb": { "type": "integer", "description": "Maximum memory in MB", "example": 114688 }, "step_size_mb": { "type": "integer", "description": "Step size memory can be adjusted by in MB", "example": 1024 }, "is_adjustable": { "type": "boolean", "description": "Is this group's memory adjustable?", "example": true }, "is_optional": { "type": "boolean", "description": "Is this group's memory optional?", "example": false }, "can_scale_down": { "type": "boolean", "description": "Can this group's memory scale down?", "example": true }, "cpu_enforcement_ratio_ceiling_mb": { "type": "integer", "description": "The amount of memory required before the cpu/memory ratio is no longer enforced. (multitenant only)", "example": 16384 }, "cpu_enforcement_ratio_mb": { "type": "integer", "description": "The maximum memory allowed per CPU until the ratio ceiling is reached. (multitenant only)", "example": 8192 } } }, "cpu": { "type": "object", "properties": { "units": { "type": "string", "description": "Units used for scaling cpu - count means the value is the number of the unit(s) available.", "example": "count" }, "allocation_count": { "type": "integer", "description": "Number of allocated CPUs", "example": 2 }, "minimum_count": { "type": "integer", "description": "Minimum number of CPUs", "example": 2 }, "maximum_count": { "type": "integer", "description": "Maximum number of CPUs", "example": 32 }, "step_size_count": { "type": "integer", "description": "Step size CPUs can be adjusted", "example": 2 }, "is_adjustable": { "type": "boolean", "description": "Is this group's CPU count adjustable", "example": false }, "is_optional": { "type": "boolean", "description": "Is this group's CPU optional?", "example": false }, "can_scale_down": { "type": "boolean", "description": "Can this group's CPU scale down?", "example": true } } }, "disk": { "type": "object", "properties": { "units": { "type": "string", "description": "Units used for scaling storage", "example": "mb" }, "allocation_mb": { "type": "integer", "description": "Allocated storage in MB", "example": 10240 }, "minimum_mb": { "type": "integer", "description": "Minimum allocated storage", "example": 2048 }, "maximum_mb": { "type": "integer", "description": "Maximum allocated storage", "example": 4194304 }, "step_size_mb": { "type": "integer", "description": "Step size storage can be adjusted", "example": 2048 }, "is_adjustable": { "type": "boolean", "description": "Is this group's storage adjustable?", "example": true }, "is_optional": { "type": "boolean", "description": "Is this group's storage optional?", "example": false }, "can_scale_down": { "type": "boolean", "description": "Can this group's storage scale down?", "example": false } } }, "host_flavor": { "type": "object", "properties": { "id": { "type": "string", "description": "Group's host flavor id", "example": "b3c.4x16.encrypted" }, "name": { "type": "string", "description": "Group's hostflavor name", "example": "4x16" }, "hosting_size": { "type": "string", "description": "Group's host flavor size", "example": "xs" } } } } }, "GroupScaling": { "type": "object", "properties": { "members": { "type": "object", "properties": { "allocation_count": { "type": "integer", "description": "Allocated number of members", "example": 4 } } }, "memory": { "type": "object", "properties": { "allocation_mb": { "type": "integer", "description": "Allocated memory in MB", "example": 12288 } } }, "cpu": { "type": "object", "properties": { "allocation_count": { "type": "integer", "description": "Number of allocated CPUs", "example": 2 } } }, "disk": { "type": "object", "properties": { "allocation_mb": { "type": "integer", "description": "Allocated storage in MB", "example": 20480 } } }, "host_flavor": { "type": "object", "properties": { "id": { "type": "string", "description": "**Beta feature:** The hosting infrastructure identifier. Selecting `multitenant` places your database on a logically separated, multi-tenant machine. With this identifier, minimum resource configurations apply. Alternatively, setting the identifier to any of the following host sizes places your database on the specified host size with no other tenants.\n- `b3c.4x16.encrypted`\n- `b3c.8x32.encrypted`\n- `m3c.8x64.encrypted`\n- `b3c.16x64.encrypted`\n- `b3c.32x128.encrypted`\n- `m3c.30x240.encrypted`", "example": "b3c.16x64.encrypted" } } } } }, "AutoscalingDiskGroup": { "type": "object", "properties": { "disk": { "$ref": "#/components/schemas/AutoscalingDiskGroupDisk" } } }, "AutoscalingDiskGroupDisk": { "type": "object", "properties": { "scalers": { "type": "object", "properties": { "capacity": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "", "example": true }, "free_space_less_than_percent": { "type": "integer", "description": "", "example": 10 } } }, "io_utilization": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "", "example": true }, "over_period": { "type": "string", "description": "", "example": "30m" }, "above_percent": { "type": "integer", "description": "", "example": 45 } } } } }, "rate": { "type": "object", "properties": { "increase_percent": { "type": "number", "description": "", "example": 20 }, "period_seconds": { "type": "integer", "description": "", "example": 900 }, "limit_mb_per_member": { "type": "number", "description": "", "example": 3670016 }, "units": { "type": "string", "description": "", "example": "mb" } } } } }, "AutoscalingMemoryGroup": { "type": "object", "properties": { "memory": { "$ref": "#/components/schemas/AutoscalingMemoryGroupMemory" } } }, "AutoscalingMemoryGroupMemory": { "type": "object", "properties": { "scalers": { "type": "object", "properties": { "io_utilization": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "", "example": true }, "over_period": { "type": "string", "description": "", "example": "30m" }, "above_percent": { "type": "integer", "description": "", "example": 45 } } } } }, "rate": { "type": "object", "properties": { "increase_percent": { "type": "number", "description": "", "example": 10 }, "period_seconds": { "type": "integer", "description": "", "example": 900 }, "limit_mb_per_member": { "type": "number", "description": "", "example": 3670016 }, "units": { "type": "string", "description": "", "example": "mb" } } } } }, "AutoscalingCPUGroup": { "type": "object", "properties": { "cpu": { "$ref": "#/components/schemas/AutoscalingCPUGroupCPU" } } }, "AutoscalingCPUGroupCPU": { "type": "object", "properties": { "scalers": { "type": "object", "properties": {} }, "rate": { "type": "object", "properties": { "increase_percent": { "type": "number", "description": "", "example": 10 }, "period_seconds": { "type": "integer", "description": "", "example": 900 }, "limit_count_per_member": { "type": "integer", "description": "", "example": 10 }, "units": { "type": "string", "description": "", "example": "count" } } } } }, "AutoscalingGroup": { "type": "object", "required": [ "autoscaling" ], "properties": { "autoscaling": { "allOf": [ { "$ref": "#/components/schemas/AutoscalingDiskGroup" }, { "$ref": "#/components/schemas/AutoscalingMemoryGroup" }, { "$ref": "#/components/schemas/AutoscalingCPUGroup" } ] } } }, "AutoscalingSetGroup": { "type": "object", "required": [ "autoscaling" ], "properties": { "autoscaling": { "oneOf": [ { "$ref": "#/components/schemas/AutoscalingDiskGroup" }, { "$ref": "#/components/schemas/AutoscalingMemoryGroup" }, { "$ref": "#/components/schemas/AutoscalingCPUGroup" } ] } } }, "Errors": { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "description": "Map of error message arrays", "type": "array", "items": { "type": "string", "description": "Error message" } } } }, "example": { "errors": { "error.source": [ "readable error message", "more error messages" ], "other.source": [ "other errors" ] } } }, "AllowlistEntry": { "type": "object", "properties": { "address": { "type": "string", "description": "An IPv4 address or a CIDR range (netmasked IPv4 address)" }, "description": { "type": "string", "description": "A human readable description of the address or range for identification purposes." } }, "example": { "address": "195.212.0.0/16", "description": "Dev IP space 1" } }, "Configuration": { "type": "object", "required": [ "configuration" ], "oneOf": [ { "$ref": "#/components/schemas/PGConfiguration" }, { "$ref": "#/components/schemas/RedisConfiguration" }, { "$ref": "#/components/schemas/RabbitMQConfiguration" }, { "$ref": "#/components/schemas/MySQLConfiguration" } ] }, "PGConfiguration": { "description": "PostgreSQL and EnterpriseDB Configuration", "type": "object", "properties": { "archive_timeout": { "type": "integer", "description": "The number of seconds to wait before forces a switch to the next WAL file if a new file has not been started.", "minimum": 300 }, "deadlock_timeout": { "type": "integer", "description": "Deadlock timeout in ms. The time to wait on a lock before checking for deadlock. Also the duration where lock waits will be logged.", "maximum": 2147483647, "minimum": 100 }, "effective_io_concurrency": { "type": "integer", "description": "Number of simultaneous requests that can be handled efficiently by the disk subsystem.", "maximum": 1000, "minimum": 1 }, "log_connections": { "type": "string", "enum": [ "off", "on" ], "description": "Causes each attempted connection to the server to be logged, as well as successful completion of client authentication." }, "log_disconnections": { "type": "string", "enum": [ "off", "on" ], "description": "Causes session terminations to be logged. The log output provides information similar to log_connections, plus the duration of the session." }, "log_min_duration_statement": { "type": "integer", "description": "The minimum number of milliseconds for execution time above which statements will be logged.", "minimum": 100 }, "max_connections": { "type": "integer", "description": "Maximum connections allowed.", "minimum": 115 }, "max_locks_per_transaction": { "type": "integer", "description": "This parameter limits the average number of object locks used by each transaction.", "minimum": 10 }, "max_prepared_transactions": { "type": "integer", "description": "Max number of transactions that can be in the \"prepared\" state simultaneously.", "minimum": 0 }, "max_replication_slots": { "type": "integer", "description": "Maximum number of simultaneously defined replication slots.", "maximum": 262143, "minimum": 10 }, "max_wal_senders": { "type": "integer", "description": "Maximum number of simultaneously running WAL sender processes.", "maximum": 262143, "minimum": 12 }, "shared_buffers": { "type": "integer", "description": "The number of 8kB shared memory buffers used by the server. Set to 1/4 of memory. Setting too high will cause crashes or prevent the database from starting.", "maximum": 1048576, "minimum": 16 }, "synchronous_commit": { "type": "string", "enum": [ "local", "off" ], "description": "Sets the current transaction's synchronization level. Off can result in data loss. remote_write with enable synchronous replication which will impact performance and availabilty." }, "tcp_keepalives_count": { "type": "integer", "description": "The number of TCP keepalives that can be lost before the server's connection to the client is considered dead.", "maximum": 2147483647, "minimum": 0 }, "tcp_keepalives_idle": { "type": "integer", "description": "The number of seconds of inactivity after which TCP should send a keepalive message to the client.", "maximum": 2147483647, "minimum": 0 }, "tcp_keepalives_interval": { "type": "integer", "description": "The number of seconds after which a TCP keepalive message that is not acknowledged by the client should be retransmitted", "maximum": 2147483647, "minimum": 0 }, "wal_level": { "type": "string", "enum": [ "replica", "logical" ], "description": "Controls WAL level. Allowed values are replica or logical. Set to logical to use logical decoding. If you are not using logical decoding, using logical increases the WAL size, which has several disadvantages and no real advantage." } } }, "RedisConfiguration": { "description": "Redis Configuration", "type": "object", "properties": { "maxmemory": { "type": "integer", "description": "The maximum memory Redis should use, as bytes.", "minimum": 0 }, "maxmemory-policy": { "type": "string", "description": "The policy with which Redis evicts keys when maximum memory is reached.", "enum": [ "volatile-lru", "volatile-lfu", "allkeys-lru", "allkeys-lfu", "volatile-random", "allkeys-random", "volatile-ttl", "noeviction" ] }, "appendonly": { "type": "string", "description": "If set to yes this will enable AOF persistence.", "enum": [ "yes", "no" ] }, "maxmemory-samples": { "type": "integer", "description": "The maximum memory Redis should use, as bytes.", "minimum": 0 }, "stop-writes-on-bgsave-error": { "type": "string", "description": "Whether or not to stop accepting writes when background persistence actions fail.", "enum": [ "yes", "no" ] } } }, "RabbitMQConfiguration": { "description": "MySQL Configuration", "type": "object", "properties": { "delete_undefined_queues": { "type": "boolean", "description": "Automatically delete undefined queues." } } }, "MySQLConfiguration": { "description": "MySQL Configuration", "type": "object", "properties": { "default_authentication_plugin": { "type": "string", "description": "Determines which authentication plugin the server assigns to new accounts created by CREATE USER and GRANT statements that do not explicitly specify an authentication plugin.", "enum": [ "sha256_password", "caching_sha2_password", "mysql_native_password" ] }, "innodb_buffer_pool_size_percentage": { "type": "integer", "description": "Percentage of memory to use for innodb_buffer_pool_size.", "maximum": 100, "minimum": 10 }, "innodb_flush_log_at_trx_commit": { "type": "integer", "description": "Controls the balance between strict ACID compliance for commit operations and higher performance. See official MySQL documentation for more details.", "maximum": 2, "minimum": 0 }, "innodb_log_buffer_size": { "type": "integer", "description": "InnoDB log buffer size in bytes.", "maximum": 4294967295, "minimum": 1048576 }, "innodb_log_file_size": { "type": "integer", "description": "InnoDB log file size in bytes.", "maximum": 274877906900, "minimum": 4194304 }, "innodb_lru_scan_depth": { "type": "integer", "description": "An InnoDB MySQL option that may affect performance. Check official MySQL documentation for a detailed description of this option's use cases.", "maximum": 2048, "minimum": 128 }, "innodb_read_io_threads": { "type": "integer", "description": "The number of I/O Threads for read operations in InnoDB.", "maximum": 64, "minimum": 1 }, "innodb_write_io_threads": { "type": "integer", "description": "The number of I/O Threads for write operations in InnoDB.", "maximum": 64, "minimum": 1 }, "max_allowed_packet": { "type": "integer", "description": "The maximum size of a packet message buffer in bytes.", "maximum": 1073741824, "minimum": 1024 }, "max_connections": { "type": "integer", "description": "Maximum number of allowed MySQL connections.", "minimum": 100, "maximum": 200000 }, "mysql_max_binlog_age_sec": { "type": "integer", "default": 1800, "description": "Maximum age for a binlog in seconds. If a binlog is older, it's archived.", "maximum": 1073741823, "minimum": 300 }, "net_read_timeout": { "type": "integer", "description": "The number of seconds to wait for more data from a connection before aborting the read.", "maximum": 7200, "minimum": 1 }, "net_write_timeout": { "type": "integer", "description": "The number of seconds to wait for a block to be written to a connection before aborting the write.", "maximum": 7200, "minimum": 1 }, "sql_mode": { "type": "string", "description": "The comma-separated list of SQL modes applied on this server globally." }, "wait_timeout": { "type": "integer", "description": "The number of seconds the server waits for activity on a noninteractive connection before closing it.", "maximum": 31536000, "minimum": 1 }, "max_prepared_stmt_count": { "type": "integer", "description": "This variable limits the total number of prepared statements in the server.", "maximum": 4194304, "minimum": 0 } } }, "ConfigurationSchema": { "description": "Database Configuration Schema", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PGConfigurationSchema" }, { "$ref": "#/components/schemas/RedisConfigurationSchema" }, { "$ref": "#/components/schemas/MySQLConfigurationSchema" }, { "$ref": "#/components/schemas/RabbitMQConfigurationSchema" } ] }, "MySQLConfigurationSchema": { "description": "MySQL Configuration Schema", "type": "object", "properties": { "default_authentication_plugin": { "$ref": "#/components/schemas/ChoicePropertySchema" }, "innodb_buffer_pool_size_percentage": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "innodb_flush_log_at_trx_commit": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "innodb_log_buffer_size": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "innodb_log_file_size": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "innodb_lru_scan_depth": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "innodb_read_io_threads": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "innodb_write_io_threads": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "max_allowed_packet": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "max_connections": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "mysql_max_binlog_age_sec": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "net_read_timeout": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "net_write_timeout": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "sql_mode": { "$ref": "#/components/schemas/StringPropertySchema" }, "timezone": { "$ref": "#/components/schemas/StringPropertySchema" }, "wait_timeout": { "$ref": "#/components/schemas/IntegerPropertySchema" } } }, "PGConfigurationSchema": { "description": "PostgreSQL and EnterpriseDB Configuration Schema", "type": "object", "properties": { "archive_timeout": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "deadlock_timeout": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "effective_io_concurrency": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "log_connections": { "$ref": "#/components/schemas/ChoicePropertySchema" }, "log_disconnections": { "$ref": "#/components/schemas/ChoicePropertySchema" }, "log_min_duration_statement": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "max_connections": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "max_locks_per_transaction": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "max_prepared_transactions": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "max_replication_slots": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "max_wal_senders": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "shared_buffers": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "synchronous_commit": { "$ref": "#/components/schemas/ChoicePropertySchema" }, "tcp_keepalives_count": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "tcp_keepalives_idle": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "tcp_keepalives_interval": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "wal_level": { "$ref": "#/components/schemas/ChoicePropertySchema" } } }, "RabbitMQConfigurationSchema": { "description": "RabbitMQ Configuration Schema", "type": "object", "properties": { "delete-undefined-queues": { "$ref": "#/components/schemas/BooleanPropertySchema" } } }, "RedisConfigurationSchema": { "description": "Redis Configuration Schema", "type": "object", "properties": { "appendonly": { "$ref": "#/components/schemas/ChoicePropertySchema" }, "maxmemory": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "maxmemory-policy": { "$ref": "#/components/schemas/ChoicePropertySchema" }, "maxmemory-samples": { "$ref": "#/components/schemas/IntegerPropertySchema" }, "stop-writes-on-bgsave-error": { "$ref": "#/components/schemas/ChoicePropertySchema" } } }, "IntegerPropertySchema": { "description": "Integer Property Schema", "type": "object", "properties": { "customer_configurable": { "type": "boolean", "description": "Whether the setting is customer-configurable" }, "default": { "type": "integer", "description": "The default value of the setting" }, "default_description": { "type": "string", "description": "The description of the default value" }, "description": { "type": "string", "description": "The description of the setting" }, "kind": { "type": "string", "description": "The type of this setting (e.g., string, integer)" }, "requires_restart": { "type": "boolean", "description": "Whether or not changing this setting will restart the database" }, "min": { "type": "integer", "description": "The minimum value that this setting accepts" }, "max": { "type": "integer", "description": "The maximum value that this setting accepts" }, "step": { "type": "integer", "description": "The number that should be skipped between each step of a slider rendered for this setting" } } }, "ChoicePropertySchema": { "description": "Choice Property Schema", "type": "object", "properties": { "customer_configurable": { "type": "boolean", "description": "Whether the setting is customer-configurable" }, "default": { "type": "integer", "description": "The default value of the setting" }, "default_description": { "type": "string", "description": "The description of the default value" }, "description": { "type": "string", "description": "The description of the setting" }, "kind": { "type": "string", "description": "The type of this setting (e.g., string, integer)" }, "requires_restart": { "type": "boolean", "description": "Whether or not changing this setting will restart the database" }, "choices": { "type": "array", "items": { "type": "string" }, "description": "The valid choices for this setting" } } }, "BooleanPropertySchema": { "description": "Boolean Property Schema", "type": "object", "properties": { "customer_configurable": { "type": "boolean", "description": "Whether the setting is customer-configurable" }, "default": { "type": "integer", "description": "The default value of the setting" }, "default_description": { "type": "string", "description": "The description of the default value" }, "description": { "type": "string", "description": "The description of the setting" }, "kind": { "type": "string", "description": "The type of this setting (e.g., string, integer)" }, "requires_restart": { "type": "boolean", "description": "Whether or not changing this setting will restart the database" } } }, "StringPropertySchema": { "description": "String Property Schema", "type": "object", "properties": { "customer_configurable": { "type": "boolean", "description": "Whether the setting is customer-configurable" }, "default": { "type": "integer", "description": "The default value of the setting" }, "default_description": { "type": "string", "description": "The description of the default value" }, "description": { "type": "string", "description": "The description of the setting" }, "kind": { "type": "string", "description": "The type of this setting (e.g., string, integer)" }, "requires_restart": { "type": "boolean", "description": "Whether or not changing this setting will restart the database" } } }, "Remotes": { "description": "Remotes", "type": "object", "properties": { "leader": { "type": "string", "description": "Leader ID, if applicable", "example": "01f30581-54f8-41a4-8193-4a04cc022e9b-h" }, "replicas": { "type": "array", "items": { "type": "string" }, "description": "Replica IDs, if applicable", "example": [ "23h40521-57g6-31b5-9256-6b15df456f7j-g", "g1d8g764-hngm-595j-7349450f3058-y" ] } } }, "Promotion": { "type": "object", "description": "Promotion and Upgrade options", "additionalProperties": true, "properties": { "version": { "x-sdk-exclude": true, "type": "string", "description": "Version number to upgrade to." }, "skip_initial_backup": { "x-sdk-exclude": true, "type": "boolean", "description": "Skip the initial backup of the deployment post-promotion." }, "dry_run": { "x-sdk-exclude": true, "type": "boolean", "description": "Validate upgrade success, DOES NOT run the promotion and upgrade." } } }, "LogicalReplicationSlot": { "type": "object", "required": [ "name", "database_name", "plugin_type" ], "properties": { "name": { "type": "string", "description": "name of the replication slot", "example": "customer_replication" }, "database_name": { "type": "string", "description": "name of the database the replication slot is created on", "example": "customers" }, "plugin_type": { "type": "string", "description": "creating a replication slot is only supported for use with wal2json", "example": "wal2json" } } }, "User": { "oneOf": [ { "$ref": "#/components/schemas/DatabaseUser" }, { "$ref": "#/components/schemas/RedisDatabaseUser" }, { "$ref": "#/components/schemas/OpsManagerUser" } ] }, "DatabaseUser": { "type": "object", "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username for new user", "example": "user" }, "password": { "type": "string", "minLength": 15, "description": "Password for new user. Password must be at least 15 characters in length and contain a letter and number.", "example": "v3ry-1-secUre-pAssword-2" } } }, "OpsManagerUser": { "type": "object", "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username for new user", "example": "user" }, "password": { "type": "string", "minLength": 15, "description": "Password for new Ops Manager user. Password must be at least 15 characters in length and contain a letter, number and a special character.", "example": "v3ry-1-secUre-pAssword-2" }, "role": { "type": "string", "description": "Role for new user. Available for MongoDB Enterprise Ops Manager users", "example": "group_data_access_admin", "enum": [ "group_read_only", "group_data_access_admin" ] } } }, "RedisDatabaseUser": { "type": "object", "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username for new user", "example": "user" }, "password": { "type": "string", "minLength": 15, "description": "Password for new user. Password must be at least 15 characters in length and contain a letter and number.", "example": "v3ry-1-secUre-pAssword-2" }, "role": { "type": "string", "pattern": "^(?:[+-]@(?:read|write|admin|all)\\s?)+$", "description": "RBAC role for Redis database user types. Available for Redis 6.0 and newer. Must use Redis ACL syntax to add or remove command categories. Allowed categories are `read`, `write`, `admin` and `all`.", "example": "-@all -@read" } } }, "UserUpdate": { "anyOf": [ { "$ref": "#/components/schemas/PasswordSetting" }, { "$ref": "#/components/schemas/RedisRoleSetting" } ] }, "PasswordSetting": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "minLength": 15, "description": "Password for user. Password must be at least 15 characters in length and contain a letter and number.", "example": "v3ry-1-secUre-pAssword-2" } } }, "RedisRoleSetting": { "type": "object", "required": [ "role" ], "properties": { "role": { "type": "string", "pattern": "^(?:[+-]@(?:read|write|admin|all)\\s?)+$", "description": "RBAC role for redis database user types. Available for Redis 6.0 and above. Must use Redis ACL syntax to add or remove command categories. Allowed categories are `read`, `write`, `admin` and `all`.", "example": "-@all -@read" } } }, "PointInTimeRecoveryData": { "type": "object", "x-data-source-name": "database_pitr", "x-data-source-operations": { "read": "getPITRData" }, "properties": { "earliest_point_in_time_recovery_time": { "type": "string" } } }, "SetInplaceVersionUpgrade": { "type": "object", "required": [ "version" ], "properties": { "version": { "type": "string", "description": "a database version", "example": "7" } } } }, "examples": { "PitrCapabilityTrue": { "summary": "Point in time recovery is supported", "value": { "deployment": { "type": "postgresql", "version": "14", "platform": "classic", "location": "us-south" }, "options": { "target_platform": "classic", "target_location": "jp-tok" }, "capability": { "point_in_time_recovery": { "point_in_time_recovery_supported": true } } } }, "CapabilityAutoscalingFalse": { "summary": "Autoscaling is not supported", "value": { "deployment": { "type": "postgresql", "version": "14", "platform": "satelite", "location": "satloc_wdc_abc123def456" }, "capability": { "autoscaling": { "autoscaling_supported": false } } } }, "CapabilityLocationsHasStrings": { "summary": "Locations has location strings", "value": { "deployment": { "platform": "classic", "location": "us-south" }, "capability": { "locations": [ "au-syd", "br-sao", "ca-tor", "che01", "eu-gb", "jp-osa", "jp-tok", "seo01", "us-east", "us-south" ] } } }, "RestoreCapabilityTrue": { "summary": "Backup restore is supported", "value": { "backup": { "type": "postgresql", "version": "14", "platform": "classic", "location": "us-south" }, "options": { "target_platform": "classic", "target_location": "jp-tok" }, "capability": { "restores": { "backup_restore_supported": true } } } }, "InvalidToken": { "summary": "Invalid token", "value": { "errors": "bad_request" } }, "PitrUnprocessableEntity": { "summary": "Point in time recovery capability discovery is missing information", "value": { "errors": { "deployment.type": [ "can't be blank" ], "options.target_platform": [ "can't be blank" ], "options.target_location": [ "can't be blank" ] } } }, "RestoresUnprocessableEntity": { "summary": "Backup restore capability discovery is missing information", "value": { "errors": { "options.target_platform": [ "can't be blank" ], "options.target_location": [ "can't be blank" ] } } } } }, "security": [ { "bearerAuth": [] } ] }