The IBM Cloud Databases API | IBM Cloud API Docs

Introduction

Last updated: 2023-04-14

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.

Prior versions of the IBM Cloud Databases API documentation can be found at:

IBM Cloud Databases v4 API

IBM Cloud Databases SDKs

The IBM Cloud Databases SDKs interact with the IBM Cloud Databases APIs. Current SDK availability:

Installing the IBM Cloud Databases Node.js SDK requires:

an IBM Cloud account and
Node.js version greater than 10.

npm install ibm-cloud-databases

View the SDK on GitHub at: https://github.com/IBM/cloud-databases-node-sdk

For general SDK usage information, refer to the Using the SDK section usage of the IBM Cloud SDK Common Readme file.

Installing the IBM Cloud Databases Go SDK requires:

an IBM Cloud account
An IAM API key to allow the SDK to access your account and
Go version 1.14 or newer

If your application uses Go modules for dependency management (recommended), just add an import for each service that you will use in your application:

import (
	"github.com/IBM/cloud-databases-go-sdk/clouddatabasesv5"
)

Next, run go build or go mod tidy to download and install the new dependencies and update your application's go.mod file.

In the example shown, the clouddatabasesv5 part of the import path is the package name associated with the IBM Cloud Databases service.

Alternatively, you can use the go get command to download and install the appropriate packages needed by your application:

go get -u github.com/IBM/cloud-databases-go-sdk/clouddatabasesv5

Be sure to use the appropriate package name for the services used by your application.

View the SDK on GitHub at: https://github.com/IBM/cloud-databases-go-sdk

For general SDK usage information, refer to the Using the SDK section usage of the IBM Cloud SDK Common Readme file.

Installing the IBM Cloud Databases Python SDK requires:

an IBM Cloud account
An IAM API key to allow the SDK to access your account and
Python version 3.6 or newer

To install, use pip or easy_install:

pip install --upgrade "ibm-cloud-databases>=0.1.0"

or

easy_install --upgrade "ibm-cloud-databases>=0.1.0"

View the SDK on GitHub at: https://github.com/IBM/cloud-databases-python-sdk

For general SDK usage information, refer to the Using the SDK section usage of the IBM Cloud SDK Common Readme file.

Endpoint URLs

The API is available at these public endpoints

The API is also available at these private endpoints

You 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.

Authentication

Access to the API uses token authentication, by using the header Authorization: Bearer <token>. The token must be IAM-issued. You can send in an IAM API key directly as the token or use the API key to generate an IAM Bearer Token.

To 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.

Error Handling

The 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.

Event tracking

You 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.

For more information about how to track Certificate Manager activity, see Auditing events for IBM Cloud.

Deployment IDs and CRNs

Deployment 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,

crn:v1:bluemix:public:databases-for-redis:us-south:a/274074dce64e9c423ffc238516c755e1:29caf0e7-120f-4da8-9551-3abf57ebcfc7::

becomes

crn:v1:bluemix:public:databases-for-redis:us-south:a%2F274074dce64e9c423ffc238516c755e1:29caf0e7-120f-4da8-9551-3abf57ebcfc7::

when URL encoded.

Pagination

No endpoint currently returns paginated data.

Rate Limiting

No endpoint currently implements rate limiting.

This 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.

Specifically, 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.

This API does not support provisioning and decommissioning of database deployments. Those functions are the responsibility of the Resource Controller and the Resource Controller API.

Specifically the POST /resource_instances endpoint 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 for details of plan ids and other settings.

Returns a list of all the types and associated major versions of database deployments that can be provisioned.

GET /deployables

(cloudDatabases *CloudDatabasesV5) ListDeployables(listDeployablesOptions *ListDeployablesOptions) (result *ListDeployablesResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) ListDeployablesWithContext(ctx context.Context, listDeployablesOptions *ListDeployablesOptions) (result *ListDeployablesResponse, response *core.DetailedResponse, err error)

listDeployables(params)

list_deployables(self,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployables

Request

No Request Parameters

This method does not accept any request parameters.

parameter

WithContext method only

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

Example curl request

curl -X GET https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployables -H 'Authorization: Bearer <>' \

Example request

listDeployablesOptions := cloudDatabasesService.NewListDeployablesOptions()

listDeployablesResponse, response, err := cloudDatabasesService.ListDeployables(listDeployablesOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(listDeployablesResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

cloudDatabasesService.listDeployables({})
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

list_deployables_response = cloud_databases_service.list_deployables().get_result()

print(json.dumps(list_deployables_response, indent=2))

Response

Response Body

object

ListDeployablesResponse

Examples:

ListDeployablesResponse

Examples:

ListDeployablesResponse

Examples:

Status Code

200
Deployable database objects
403
Invalid token

Example responses

Status 200

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}
Copy to clipboard

Success 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"
            }
          ]
        }
      ]
    }
  ]
}
Copy to clipboard

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

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.

GET /regions

(cloudDatabases *CloudDatabasesV5) ListRegions(listRegionsOptions *ListRegionsOptions) (result *ListRegionsResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) ListRegionsWithContext(ctx context.Context, listRegionsOptions *ListRegionsOptions) (result *ListRegionsResponse, response *core.DetailedResponse, err error)

listRegions(params)

list_regions(self,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/regions

Request

No Request Parameters

This method does not accept any request parameters.

parameter

WithContext method only

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

Example curl request

curl -X GET https://api.{region}.databases.cloud.ibm.com/v5/ibm/regions -H 'Authorization: Bearer <>' \

Example request

listRegionsOptions := cloudDatabasesService.NewListRegionsOptions()

listRegionsResponse, response, err := cloudDatabasesService.ListRegions(listRegionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(listRegionsResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

cloudDatabasesService.listRegions({})
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

list_regions_response = cloud_databases_service.list_regions().get_result()

print(json.dumps(list_regions_response, indent=2))

Response

Response Body

object

ListRegionsResponse

Examples:

ListRegionsResponse

Examples:

ListRegionsResponse

Examples:

Status Code

200
A regions object
403
Invalid token

Example responses

Status 200

{
  "regions": [
    "eu-gb",
    "us-south"
  ]
}
Copy to clipboard

Success example

{
  "regions": [
    "eu-gb",
    "us-south"
  ]
}
Copy to clipboard

Gets the full data that is associated with a deployment. This data includes the ID, name, database type, and version.

GET /deployments/{id}

(cloudDatabases *CloudDatabasesV5) GetDeploymentInfo(getDeploymentInfoOptions *GetDeploymentInfoOptions) (result *GetDeploymentInfoResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) GetDeploymentInfoWithContext(ctx context.Context, getDeploymentInfoOptions *GetDeploymentInfoOptions) (result *GetDeploymentInfoResponse, response *core.DetailedResponse, err error)

getDeploymentInfo(params)

get_deployment_info(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id

Request

Instantiate the GetDeploymentInfoOptions struct and set the fields to provide parameter values for the GetDeploymentInfo method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

GetDeploymentInfoOptions

The GetDeploymentInfo options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X GET https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id} -H 'Authorization: Bearer <>' \

Example request

getDeploymentInfoOptions := cloudDatabasesService.NewGetDeploymentInfoOptions(
  deploymentID,
)

getDeploymentInfoResponse, response, err := cloudDatabasesService.GetDeploymentInfo(getDeploymentInfoOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(getDeploymentInfoResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.getDeploymentInfo(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

get_deployment_info_response = cloud_databases_service.get_deployment_info(
  id=deployment_id,
).get_result()

print(json.dumps(get_deployment_info_response, indent=2))
Copy to clipboard

Response

Response Body

object

GetDeploymentInfoResponse

Examples:

GetDeploymentInfoResponse

Examples:

GetDeploymentInfoResponse

Examples:

Status Code

200
A deployment response
403
Invalid token

Example responses

Status 200

{
  "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": []
  }
}
Copy to clipboard

Success 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": []
  }
}
Copy to clipboard

Creates a user in the database that can access the database through a connection.

POST /deployments/{id}/users/{user_type}

(cloudDatabases *CloudDatabasesV5) CreateDatabaseUser(createDatabaseUserOptions *CreateDatabaseUserOptions) (result *CreateDatabaseUserResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) CreateDatabaseUserWithContext(ctx context.Context, createDatabaseUserOptions *CreateDatabaseUserOptions) (result *CreateDatabaseUserResponse, response *core.DetailedResponse, err error)

createDatabaseUser(params)

create_database_user(self,
        id: str,
        user_type: str,
        *,
        user: 'CreateDatabaseUserRequestUser' = None,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST /v5/ibm/deployments/:deployment_id/users/:user_type

Auditing

Calling this method generates the following auditing event.

<service_id>.user.create

Request

Instantiate the CreateDatabaseUserOptions struct and set the fields to provide parameter values for the CreateDatabaseUser method.

Path Parameters

id
Required*
string
Deployment ID
user_type
Required*
string
User type
Examples:
database type
allows management, monitoring, and backing up deployments
Allows only read-only connections. Available only on EnterpriseDB and PostgreSQL.

Request Body

Required*

object

Parameters for creating the user

Examples:

parameter

WithContext method only

CreateDatabaseUserOptions

The CreateDatabaseUser options.

parameters

id
Required*
string
Deployment ID.
userType
Required*
string
User type.
Examples:
user

parameters

id
Required*
str
Deployment ID.
user_type
Required*
str
User type.
Examples:
user

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -d '{"user": {"username": "user", "password": "v3ry-1-secUre-pAssword-2"}}' \
Copy to clipboard

Example request

createDatabaseUserRequestUserModel := &clouddatabasesv5.CreateDatabaseUserRequestUser{
  Username: &username,
  Password: &password,
}

createDatabaseUserOptions := cloudDatabasesService.NewCreateDatabaseUserOptions(
  deploymentID,
  userType,
)
createDatabaseUserOptions.SetUser(createDatabaseUserRequestUserModel)

createDatabaseUserResponse, response, err := cloudDatabasesService.CreateDatabaseUser(createDatabaseUserOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(createDatabaseUserResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const createDatabaseUserRequestUserModel = {
  username: username,
  password: password,
};

const params = {
  id: deploymentId,
  userType: userType,
  user: createDatabaseUserRequestUserModel,
};

cloudDatabasesService.createDatabaseUser(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

create_database_user_request_user_model = CreateDatabaseUserRequestUser(
  username=username,
  password=password,
)

create_database_user_response = cloud_databases_service.create_database_user(
  id=deployment_id,
  user_type=user_type,
  user=create_database_user_request_user_model,
).get_result()

print(json.dumps(create_database_user_response, indent=2))
Copy to clipboard

Response

Response Body

object

CreateDatabaseUserResponse

Examples:

CreateDatabaseUserResponse

Examples:

CreateDatabaseUserResponse

Examples:

Status Code

202
A task which is being run to create the user
403
Invalid token
422
An error message response

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Sets the password or role of a specified user. Updating roles is only supported for Redis 6.0 or greater.

Sets the password of a specified user.

PATCH /deployments/{id}/users/{user_type}/{username}

(cloudDatabases *CloudDatabasesV5) ChangeUserPassword(changeUserPasswordOptions *ChangeUserPasswordOptions) (result *ChangeUserPasswordResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) ChangeUserPasswordWithContext(ctx context.Context, changeUserPasswordOptions *ChangeUserPasswordOptions) (result *ChangeUserPasswordResponse, response *core.DetailedResponse, err error)

changeUserPassword(params)

change_user_password(self,
        id: str,
        user_type: str,
        username: str,
        *,
        user: 'APasswordSettingUser' = None,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

PATCH /v5/ibm/deployments/:deployment_id/users/:user_type/:user_id

Auditing

Calling this method generates the following auditing event.

<service_id>.user-password.update

Request

Instantiate the ChangeUserPasswordOptions struct and set the fields to provide parameter values for the ChangeUserPassword method.

Path Parameters

id
Required*
string
Deployment ID
user_type
Required*
string
User type

Example: database
username
Required*
string
User ID

Example: user

Request Body

Required*

object

User Details

Examples:

parameter

WithContext method only

ChangeUserPasswordOptions

The ChangeUserPassword options.

parameters

id
Required*
string
Deployment ID.
userType
Required*
string
User type.
Examples:
username
Required*
string
User ID.
Examples:
user

parameters

id
Required*
str
Deployment ID.
user_type
Required*
str
User type.
Examples:
username
Required*
str
User ID.
Examples:
user

Example curl request

curl -X PATCH  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{username}  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -d '{"user": {"password": "v3ry-1-secUre-pAssword-2"}}' \
Copy to clipboard

Example request

aPasswordSettingUserModel := &clouddatabasesv5.APasswordSettingUser{
  Password: &newPassword,
}

changeUserPasswordOptions := cloudDatabasesService.NewChangeUserPasswordOptions(
  deploymentID,
  userType,
  username,
)
changeUserPasswordOptions.SetUser(aPasswordSettingUserModel)

changeUserPasswordResponse, response, err := cloudDatabasesService.ChangeUserPassword(changeUserPasswordOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(changeUserPasswordResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const aPasswordSettingUserModel = {
  password: newPassowrd,
};

const params = {
  id: deploymentId,
  userType: userType,
  username: username,
  user: aPasswordSettingUserModel,
};

cloudDatabasesService.changeUserPassword(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

a_password_setting_user_model = APasswordSettingUser(
  password=new_password,
)

change_user_password_response = cloud_databases_service.change_user_password(
  id=deployment_id,
  user_type=user_type,
  username=username,
  user=a_password_setting_user_model,
).get_result()

print(json.dumps(change_user_password_response, indent=2))
Copy to clipboard

Response

Response Body

object

ChangeUserPasswordResponse

Examples:

ChangeUserPasswordResponse

Examples:

ChangeUserPasswordResponse

Examples:

Status Code

202
A task which is being run to set the user password
403
Invalid token
422
An error message response

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Removes a user from the deployment.

DELETE /deployments/{id}/users/{user_type}/{username}

(cloudDatabases *CloudDatabasesV5) DeleteDatabaseUser(deleteDatabaseUserOptions *DeleteDatabaseUserOptions) (result *DeleteDatabaseUserResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) DeleteDatabaseUserWithContext(ctx context.Context, deleteDatabaseUserOptions *DeleteDatabaseUserOptions) (result *DeleteDatabaseUserResponse, response *core.DetailedResponse, err error)

deleteDatabaseUser(params)

delete_database_user(self,
        id: str,
        user_type: str,
        username: str,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

DELETE /v5/ibm/deployments/:deployment_id/users/:user_type/:user_id

Auditing

Calling this method generates the following auditing event.

<service_id>.user.delete

Request

Instantiate the DeleteDatabaseUserOptions struct and set the fields to provide parameter values for the DeleteDatabaseUser method.

Path Parameters

id
Required*
string
Deployment ID
user_type
Required*
string
User type

Example: database
username
Required*
string
Username

Example: user

parameter

WithContext method only

DeleteDatabaseUserOptions

The DeleteDatabaseUser options.

parameters

id
Required*
string
Deployment ID.
userType
Required*
string
User type.
Examples:
username
Required*
string
Username.
Examples:

parameters

id
Required*
str
Deployment ID.
user_type
Required*
str
User type.
Examples:
username
Required*
str
Username.
Examples:

Example curl request

curl -X DELETE  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{username}  -H 'Authorization: Bearer <>' \

Example request

deleteDatabaseUserOptions := cloudDatabasesService.NewDeleteDatabaseUserOptions(
  deploymentID,
  userType,
  username,
)

deleteDatabaseUserResponse, response, err := cloudDatabasesService.DeleteDatabaseUser(deleteDatabaseUserOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(deleteDatabaseUserResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
  userType: userType,
  username: username,
};

cloudDatabasesService.deleteDatabaseUser(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

delete_database_user_response = cloud_databases_service.delete_database_user(
  id=deployment_id,
  user_type=user_type,
  username=username,
).get_result()

print(json.dumps(delete_database_user_response, indent=2))
Copy to clipboard

Response

Response Body

object

DeleteDatabaseUserResponse

Examples:

DeleteDatabaseUserResponse

Examples:

DeleteDatabaseUserResponse

Examples:

Status Code

202
A task which is being run to delete the user
403
Invalid token
422
An error message response

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96555393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Only for Redis v5 and prior: Discover connection information for a deployment for a user with an endpoint type.

GET /deployments/{id}/users/{user_id}/

Request

Path Parameters

id
Required*
string
Deployment ID
user_id
Required*
string
User ID

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_id}  -H 'Authorization: Bearer <>' \

Response

Response Body

Task

Status Code

200
User
500
Not Found

Example responses

Status 200

{
  "connection": {
    "rediss": {
      "user": {
        "username": "admin",
        "password": "v3ry-1-secUre-pAssword-2"
      }
    }
  }
}
Copy to clipboard

Change your database configuration. Available for PostgreSQL, EnterpriseDB, MySQL, RabbitMQ and Redis ONLY.

Change your database configuration. Available for PostgreSQL, EnterpriseDB, and Redis ONLY.

PATCH /deployments/{id}/configuration

(cloudDatabases *CloudDatabasesV5) UpdateDatabaseConfiguration(updateDatabaseConfigurationOptions *UpdateDatabaseConfigurationOptions) (result *UpdateDatabaseConfigurationResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) UpdateDatabaseConfigurationWithContext(ctx context.Context, updateDatabaseConfigurationOptions *UpdateDatabaseConfigurationOptions) (result *UpdateDatabaseConfigurationResponse, response *core.DetailedResponse, err error)

updateDatabaseConfiguration(params)

update_database_configuration(self,
        id: str,
        configuration: 'SetConfigurationConfiguration',
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

PATCH /v5/ibm/deployments/:deployment_id/configuration

Request

Instantiate the UpdateDatabaseConfigurationOptions struct and set the fields to provide parameter values for the UpdateDatabaseConfiguration method.

Path Parameters

id
Required*
string
Deployment ID

Request Body

Required*

Database configuration

Examples:

parameter

WithContext method only

UpdateDatabaseConfigurationOptions

The UpdateDatabaseConfiguration options.

parameters

id
Required*
string
Deployment ID.
configuration
PostgreSQL and EnterpriseDB Configuration.
Change Request Parameter List

parameters

id
Required*
str
Deployment ID.
configuration
PostgreSQL and EnterpriseDB Configuration.
Change Request Parameter List

Example curl request

curl -X PATCH  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/configuration  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -d '{"configuration": {"max_connections": 200}}' \
Copy to clipboard

Example request

setConfigurationConfigurationModel := &clouddatabasesv5.SetConfigurationConfigurationPgConfiguration{
  MaxConnections:          core.Int64Ptr(int64(200)),
  MaxPreparedTransactions: core.Int64Ptr(int64(0)),
  DeadlockTimeout:         core.Int64Ptr(int64(100)),
  EffectiveIoConcurrency:  core.Int64Ptr(int64(1)),
  MaxReplicationSlots:     core.Int64Ptr(int64(10)),
  MaxWalSenders:           core.Int64Ptr(int64(12)),
  SharedBuffers:           core.Int64Ptr(int64(16)),
  SynchronousCommit:       core.StringPtr("local"),
  WalLevel:                core.StringPtr("hot_standby"),
  ArchiveTimeout:          core.Int64Ptr(int64(300)),
  LogMinDurationStatement: core.Int64Ptr(int64(100)),
}

updateDatabaseConfigurationOptions := cloudDatabasesService.NewUpdateDatabaseConfigurationOptions(
  deploymentID,
  setConfigurationConfigurationModel,
)

updateDatabaseConfigurationResponse, response, err := cloudDatabasesService.UpdateDatabaseConfiguration(updateDatabaseConfigurationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(updateDatabaseConfigurationResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const setConfigurationConfigurationModel = {
  max_connections: 200,
  max_prepared_transactions: 0,
  deadlock_timeout: 100,
  effective_io_concurrency: 1,
  max_replication_slots: 10,
  max_wal_senders: 12,
  shared_buffers: 16,
  synchronous_commit: 'local',
  wal_level: 'hot_standby',
  archive_timeout: 300,
  log_min_duration_statement: 100,
};

const params = {
  id: deploymentId,
  configuration: setConfigurationConfigurationModel,
};

cloudDatabasesService.updateDatabaseConfiguration(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

set_configuration_configuration_model = SetConfigurationConfigurationPGConfiguration(
  max_connections=200,
  max_prepared_transactions=0,
  deadlock_timeout=100,
  effective_io_concurrency=1,
  max_replication_slots=10,
  max_wal_senders=12,
  shared_buffers=16,
  synchronous_commit='local',
  wal_level='hot_standby',
  archive_timeout=300,
  log_min_duration_statement=100,
)

update_database_configuration_response = cloud_databases_service.update_database_configuration(
  id=deployment_id,
  configuration=set_configuration_configuration_model,
).get_result()

print(json.dumps(update_database_configuration_response, indent=2))
Copy to clipboard

Response

Response Body

object

UpdateDatabaseConfigurationResponse

Examples:

UpdateDatabaseConfigurationResponse

Examples:

UpdateDatabaseConfigurationResponse

Examples:

Status Code

200
A task
403
Invalid token
404
not found

Example responses

Status 200

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393a",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Get the schema of the database configuration. Available for PostgreSQL and Redis ONLY.

GET /deployments/{id}/configuration/schema

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/configuration/schema

Request

Path Parameters

id
Required*
string
Deployment ID

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/configuration/schema  -H 'Authorization: Bearer <>' \

Response

Response Body

Status Code

200
A database configuration schema
403
Invalid token
404
not found

Example responses

Status 200

{
  "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_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
    }
  }
}
Copy to clipboard

Get the read-only replicas associated with a deployment. Available for PostgreSQL and EnterpriseDB ONLY.

GET /deployments/{id}/remotes

(cloudDatabases *CloudDatabasesV5) ListRemotes(listRemotesOptions *ListRemotesOptions) (result *ListRemotesResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) ListRemotesWithContext(ctx context.Context, listRemotesOptions *ListRemotesOptions) (result *ListRemotesResponse, response *core.DetailedResponse, err error)

listRemotes(params)

list_remotes(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/remotes

Request

Instantiate the ListRemotesOptions struct and set the fields to provide parameter values for the ListRemotes method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

ListRemotesOptions

The ListRemotes options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/remotes  -H 'Authorization: Bearer <>' \

Example request

listRemotesOptions := cloudDatabasesService.NewListRemotesOptions(
  deploymentID,
)

listRemotesResponse, response, err := cloudDatabasesService.ListRemotes(listRemotesOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(listRemotesResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.listRemotes(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

list_remotes_response = cloud_databases_service.list_remotes(
  id=deployment_id,
).get_result()

print(json.dumps(list_remotes_response, indent=2))
Copy to clipboard

Response

Response Body

object

ListRemotesResponse

Examples:

ListRemotesResponse

Examples:

ListRemotesResponse

Examples:

Status Code

200
A remotes object
403
Invalid token
404
not found

Example responses

Status 200

{
  "remotes": {
    "leader": "",
    "replicas": [
      "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/389574dce64e9c423ffc238516c755e1:0e399ae3-4a1a-476d-b85b-755c7af54788::"
    ]
  }
}
Copy to clipboard

Success example

{
  "remotes": {
    "leader": "",
    "replicas": [
      "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/389574dce64e9c423ffc238516c755e1:0e399ae3-4a1a-476d-b85b-755c7af54788::"
    ]
  }
}
Copy to clipboard

Promote a read-only remote replica to leader by calling with leader set to an empty string. Available for PostgreSQL and EnterpriseDB ONLY.

PATCH /deployments/{id}/remotes

Request

Path Parameters

id
Required*
string
Deployment ID

Request Body

Required*

object

Parameters for promoting a read-only replica

Example curl request

curl -X PATCH  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/remotes  -H 'Authorization: Bearer <>'   -H 'Content-Type: application/json'  -d '{"remotes": {"leader": ""}}' \
Copy to clipboard

Response

Response Body

object

Status Code

200
A task
403
Invalid token
404
not found
422
promotion is the only feature supported and must be requested as an empty string

Example responses

Status 200

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:5abb6a7d11a1a5001479a0b0",
    "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"
  }
}
Copy to clipboard

Reinitialize a read-only replica. Available for PostgreSQL and EnterpriseDB ONLY.

POST /deployments/{id}/remotes/resync

(cloudDatabases *CloudDatabasesV5) ResyncReplica(resyncReplicaOptions *ResyncReplicaOptions) (result *ResyncReplicaResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) ResyncReplicaWithContext(ctx context.Context, resyncReplicaOptions *ResyncReplicaOptions) (result *ResyncReplicaResponse, response *core.DetailedResponse, err error)

resyncReplica(params)

resync_replica(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST /v5/ibm/deployments/:deployment_id/remotes/resync

Request

Instantiate the ResyncReplicaOptions struct and set the fields to provide parameter values for the ResyncReplica method.

Path Parameters

id
Required*
string
Deployment ID of the read-only replica

parameter

WithContext method only

ResyncReplicaOptions

The ResyncReplica options.

parameters

id
Required*
string
Deployment ID of the read-only replica.

parameters

id
Required*
str
Deployment ID of the read-only replica.

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/remotes/resync  -H 'Authorization: Bearer <>' \

Example request

resyncReplicaOptions := cloudDatabasesService.NewResyncReplicaOptions(
  replicaID,
)

resyncReplicaResponse, response, err := cloudDatabasesService.ResyncReplica(resyncReplicaOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(resyncReplicaResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: replicaId,
};

cloudDatabasesService.resyncReplica(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

resync_replica_response = cloud_databases_service.resync_replica(
  id=replica_id,
).get_result()

print(json.dumps(resync_replica_response, indent=2))
Copy to clipboard

Response

Response Body

object

ResyncReplicaResponse

Examples:

ResyncReplicaResponse

Examples:

ResyncReplicaResponse

Examples:

Status Code

200
A task
403
Invalid token
404
not found

Example responses

Status 200

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:5abb6a7d11a1a5001479a0b0",
    "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"
  }
}
Copy to clipboard

Success example

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:5abb6a7d11a1a5001479a0b0",
    "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"
  }
}
Copy to clipboard

Promote a read-only replica or upgrade and promote a read-only replica. Available for PostgreSQL and EnterpriseDB ONLY.

POST /deployments/{id}/remotes/promotion

(cloudDatabases *CloudDatabasesV5) SetPromotion(setPromotionOptions *SetPromotionOptions) (result *SetPromotionResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) SetPromotionWithContext(ctx context.Context, setPromotionOptions *SetPromotionOptions) (result *SetPromotionResponse, response *core.DetailedResponse, err error)

setPromotion(params)

set_promotion(self,
        id: str,
        promotion: 'SetPromotionPromotion',
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST /v5/ibm/deployments/:deployment_id/remotes/promotion

Request

Instantiate the SetPromotionOptions struct and set the fields to provide parameter values for the SetPromotion method.

Path Parameters

id
Required*
string
Deployment ID of the read-only replica to promote

Request Body

Required*

Parameters for promoting a read-only replica

Examples:

parameter

WithContext method only

SetPromotionOptions

The SetPromotion options.

parameters

id
Required*
string
Deployment ID of the read-only replica to promote.
promotion
Promotes a read-only replica to a full deployment.
Change Request Parameter List

parameters

id
Required*
str
Deployment ID of the read-only replica to promote.
promotion
Promotes a read-only replica to a full deployment.
Change Request Parameter List

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/remotes/promotion  -H 'Authorization: Bearer <>'   -H 'Content-Type: application/json'  -d '{"promotion": {"skip_initial_backup": false}}' \
Copy to clipboard

Example request

promotion := map[string]interface{}{
  "skip_initial_backup": false,
}

setPromotionPromotionModel := &clouddatabasesv5.SetPromotionPromotionPromote{
  Promotion: promotion,
}

setPromotionOptions := cloudDatabasesService.NewSetPromotionOptions(
  replicaID,
  setPromotionPromotionModel,
)

setPromotionResponse, response, err := cloudDatabasesService.SetPromotion(setPromotionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(setPromotionResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const promotion = {
  skip_initial_backup: true,
};

const setPromotionPromotionModel = {
  promotion: promotion,
};

const params = {
  id: replicaId,
  promotion: setPromotionPromotionModel,
};

cloudDatabasesService.setPromotion(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

promotion = {
  'skip_initial_backup': True,
}

set_promotion_model = SetPromotionPromotionPromote(
  promotion=promotion,
)

set_promotion_response = cloud_databases_service.set_promotion(
  id=replica_id,
  promotion=set_promotion_model,
).get_result()

print(json.dumps(set_promotion_response, indent=2))
Copy to clipboard

Response

Response Body

object

SetPromotionResponse

Examples:

SetPromotionResponse

Examples:

SetPromotionResponse

Examples:

Status Code

200
A task
403
Invalid token
404
not found
433
An error message response from sending invalid body parameters.

Example responses

Status 200

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:5abb6a7d11a1a5001479a0b0",
    "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"
  }
}
Copy to clipboard

Success example

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc257516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:5abb6a7d11a1a5001479a0b0",
    "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"
  }
}
Copy to clipboard

Status 433

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

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.

GET /deployments/{id}/tasks

(cloudDatabases *CloudDatabasesV5) ListDeploymentTasks(listDeploymentTasksOptions *ListDeploymentTasksOptions) (result *Tasks, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) ListDeploymentTasksWithContext(ctx context.Context, listDeploymentTasksOptions *ListDeploymentTasksOptions) (result *Tasks, response *core.DetailedResponse, err error)

listDeploymentTasks(params)

list_deployment_tasks(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/tasks

Request

Instantiate the ListDeploymentTasksOptions struct and set the fields to provide parameter values for the ListDeploymentTasks method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

ListDeploymentTasksOptions

The ListDeploymentTasks options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X GET https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/tasks -H 'Authorization: Bearer <>' \

Example request

listDeploymentTasksOptions := cloudDatabasesService.NewListDeploymentTasksOptions(
  deploymentID,
)

tasks, response, err := cloudDatabasesService.ListDeploymentTasks(listDeploymentTasksOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(tasks, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.listDeploymentTasks(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

tasks = cloud_databases_service.list_deployment_tasks(
  id=deployment_id,
).get_result()

print(json.dumps(tasks, indent=2))
Copy to clipboard

Response

Response Body

object

Tasks

Status Code

200
An array of tasks
403
Invalid token

No Sample Response

This method does not specify any sample responses.

Get information about a task and its status. Tasks themselves are persistent so old tasks can be consulted as well as running tasks.

GET /tasks/{id}

(cloudDatabases *CloudDatabasesV5) GetTask(getTaskOptions *GetTaskOptions) (result *GetTaskResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) GetTaskWithContext(ctx context.Context, getTaskOptions *GetTaskOptions) (result *GetTaskResponse, response *core.DetailedResponse, err error)

getTask(params)

get_task(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/tasks/:task_id

Request

Instantiate the GetTaskOptions struct and set the fields to provide parameter values for the GetTask method.

Path Parameters

id
Required*
string
Task ID

parameter

WithContext method only

GetTaskOptions

The GetTask options.

parameters

id
Required*
string
Task ID.

parameters

id
Required*
str
Task ID.

Example curl request

curl -X GET https://api.{region}.databases.cloud.ibm.com/v5/ibm/tasks/{id} -H 'Authorization: Bearer <>' \

Example request

getTaskOptions := cloudDatabasesService.NewGetTaskOptions(
  taskIDLink,
)

getTaskResponse, response, err := cloudDatabasesService.GetTask(getTaskOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(getTaskResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: taskIdLink,
};

cloudDatabasesService.getTask(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

get_task_response = cloud_databases_service.get_task(
  id=task_id_link,
).get_result()

print(json.dumps(get_task_response, indent=2))
Copy to clipboard

Response

Response Body

object

GetTaskResponse

Examples:

GetTaskResponse

Examples:

GetTaskResponse

Examples:

Status Code

200
A task
303
A completed task redirects to the associated resource.
403
Invalid token

Example responses

Status 200

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 303

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Error 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",
    "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"
  }
}
Copy to clipboard

Get information about a backup, such as creation date.

GET /backups/{backup_id}

(cloudDatabases *CloudDatabasesV5) GetBackupInfo(getBackupInfoOptions *GetBackupInfoOptions) (result *GetBackupInfoResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) GetBackupInfoWithContext(ctx context.Context, getBackupInfoOptions *GetBackupInfoOptions) (result *GetBackupInfoResponse, response *core.DetailedResponse, err error)

getBackupInfo(params)

get_backup_info(self,
        backup_id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/backups/:backup_id

Request

Instantiate the GetBackupInfoOptions struct and set the fields to provide parameter values for the GetBackupInfo method.

Path Parameters

backup_id
Required*
string
Backup ID

parameter

WithContext method only

GetBackupInfoOptions

The GetBackupInfo options.

parameters

backupId
Required*
string
Backup ID.

parameters

backup_id
Required*
str
Backup ID.

Example curl request

curl -X GET https://api.{region}.databases.cloud.ibm.com/v5/ibm/backups/{backup_id} -H 'Authorization: Bearer <>' \

Example request

getBackupInfoOptions := cloudDatabasesService.NewGetBackupInfoOptions(
  backupIDLink,
)

getBackupInfoResponse, response, err := cloudDatabasesService.GetBackupInfo(getBackupInfoOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(getBackupInfoResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  backupId: backupIdLink,
};

cloudDatabasesService.getBackupInfo(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

get_backup_info_response = cloud_databases_service.get_backup_info(
  backup_id=backup_id_link,
).get_result()

print(json.dumps(get_backup_info_response, indent=2))

Response

Response Body

object

GetBackupInfoResponse

Examples:

GetBackupInfoResponse

Examples:

GetBackupInfoResponse

Examples:

Status Code

200
A backup response
403
Invalid token

Example responses

Status 200

{
  "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"
  }
}
Copy to clipboard

Success 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"
  }
}
Copy to clipboard

Get details of all currently available backups from a deployment.

GET /deployments/{id}/backups

(cloudDatabases *CloudDatabasesV5) ListDeploymentBackups(listDeploymentBackupsOptions *ListDeploymentBackupsOptions) (result *Backups, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) ListDeploymentBackupsWithContext(ctx context.Context, listDeploymentBackupsOptions *ListDeploymentBackupsOptions) (result *Backups, response *core.DetailedResponse, err error)

listDeploymentBackups(params)

list_deployment_backups(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/backups

Request

Instantiate the ListDeploymentBackupsOptions struct and set the fields to provide parameter values for the ListDeploymentBackups method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

ListDeploymentBackupsOptions

The ListDeploymentBackups options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/backups  -H 'Authorization: Bearer <>' \

Example request

listDeploymentBackupsOptions := cloudDatabasesService.NewListDeploymentBackupsOptions(
  deploymentID,
)

backups, response, err := cloudDatabasesService.ListDeploymentBackups(listDeploymentBackupsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(backups, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.listDeploymentBackups(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

backups = cloud_databases_service.list_deployment_backups(
  id=deployment_id,
).get_result()

print(json.dumps(backups, indent=2))
Copy to clipboard

Response

Response Body

Backups

Examples:

Backups

Examples:

Backups

Examples:

Status Code

200
An array of backups
403
Invalid token

Example responses

Status 200

{
  "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"
    }
  ]
}
Copy to clipboard

Success 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"
    }
  ]
}
Copy to clipboard

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.

POST /deployments/{id}/backups

(cloudDatabases *CloudDatabasesV5) StartOndemandBackup(startOndemandBackupOptions *StartOndemandBackupOptions) (result *StartOndemandBackupResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) StartOndemandBackupWithContext(ctx context.Context, startOndemandBackupOptions *StartOndemandBackupOptions) (result *StartOndemandBackupResponse, response *core.DetailedResponse, err error)

startOndemandBackup(params)

start_ondemand_backup(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST /v5/ibm/deployments/:deployment_id/backups

Auditing

Calling this method generates the following auditing event.

<service_id>.backup-ondemand.create

Request

Instantiate the StartOndemandBackupOptions struct and set the fields to provide parameter values for the StartOndemandBackup method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

StartOndemandBackupOptions

The StartOndemandBackup options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/backups  -H 'Authorization: Bearer <>' \

Example request

startOndemandBackupOptions := cloudDatabasesService.NewStartOndemandBackupOptions(
  deploymentID,
)

startOndemandBackupResponse, response, err := cloudDatabasesService.StartOndemandBackup(startOndemandBackupOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(startOndemandBackupResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.startOndemandBackup(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

start_ondemand_backup_response = cloud_databases_service.start_ondemand_backup(
  id=deployment_id,
).get_result()

print(json.dumps(start_ondemand_backup_response, indent=2))
Copy to clipboard

Response

Response Body

object

StartOndemandBackupResponse

Examples:

StartOndemandBackupResponse

Examples:

StartOndemandBackupResponse

Examples:

Status Code

200
A task
403
Invalid token
422
An error message response

Example responses

Status 200

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Returns the earliest available time for point-in-time-recovery in ISO8601 UTC format. PostgreSQL and EnterpriseDB only.

GET /deployments/{id}/point_in_time_recovery_data

(cloudDatabases *CloudDatabasesV5) GetPitRdata(getPitRdataOptions *GetPitRdataOptions) (result *PointInTimeRecoveryData, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) GetPitRdataWithContext(ctx context.Context, getPitRdataOptions *GetPitRdataOptions) (result *PointInTimeRecoveryData, response *core.DetailedResponse, err error)

getPitRdata(params)

get_pit_rdata(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/point_in_time_recovery_data

Request

Instantiate the GetPitRdataOptions struct and set the fields to provide parameter values for the GetPitRdata method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

GetPITRdataOptions

The GetPitRdata options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/point_in_time_recovery_data  -H 'Authorization: Bearer <>' \

Example request

getPitRdataOptions := cloudDatabasesService.NewGetPitRdataOptions(
  deploymentID,
)

pointInTimeRecoveryData, response, err := cloudDatabasesService.GetPitRdata(getPitRdataOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(pointInTimeRecoveryData, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.getPitRdata(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

point_in_time_recovery_data = cloud_databases_service.get_pit_rdata(
  id=deployment_id,
).get_result()

print(json.dumps(point_in_time_recovery_data, indent=2))
Copy to clipboard

Response

Response Body

object

PointInTimeRecoveryData

Examples:

PointInTimeRecoveryData

Examples:

PointInTimeRecoveryData

Examples:

Status Code

200
The earliest point-in-time-recovery time
403
Invalid token
404
not found

Example responses

Status 200

{
  "point_in_time_recovery_data": {
    "earliest_point_in_time_recovery_time": "2019-09-09T23:16:00Z"
  }
}
Copy to clipboard

Success example

{
  "point_in_time_recovery_data": {
    "earliest_point_in_time_recovery_time": "2019-09-09T23:16:00Z"
  }
}
Copy to clipboard

Discover connection information for a deployment for a user with an endpoint type.

GET /deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type}

(cloudDatabases *CloudDatabasesV5) GetConnection(getConnectionOptions *GetConnectionOptions) (result *Connection, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) GetConnectionWithContext(ctx context.Context, getConnectionOptions *GetConnectionOptions) (result *Connection, response *core.DetailedResponse, err error)

getConnection(params)

get_connection(self,
        id: str,
        user_type: str,
        user_id: str,
        endpoint_type: str,
        *,
        certificate_root: str = None,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/users/:user_type/:user_id/connections/:endpoint_type

Request

Instantiate the GetConnectionOptions struct and set the fields to provide parameter values for the GetConnection method.

Path Parameters

id
Required*
string
Deployment ID
user_type
Required*
string
User type

Example: database
user_id
Required*
string
User ID
endpoint_type
Required*
string
Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched.

Allowable values: [public,private]

Query Parameters

certificate_root
string
Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

parameter

WithContext method only

GetConnectionOptions

The GetConnection options.

parameters

id
Required*
string
Deployment ID.
userType
Required*
string
User type.
Examples:
userId
Required*
string
User ID.
endpointType
Required*
string
Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched.

Allowable values: [public,private]
certificateRoot
string
Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

parameters

id
Required*
str
Deployment ID.
user_type
Required*
str
User type.
Examples:
user_id
Required*
str
User ID.
endpoint_type
Required*
str
Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched.

Allowable values: [public,private]
certificate_root
str
Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type}  -H 'Authorization: Bearer <>' \

Example request

getConnectionOptions := cloudDatabasesService.NewGetConnectionOptions(
  deploymentID,
  userType,
  "exampleUserID",
  "public",
)
getConnectionOptions.SetCertificateRoot("exampleCertRoot")

connection, response, err := cloudDatabasesService.GetConnection(getConnectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(connection, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
  userType: userType,
  userId: 'exampleUserID',
  endpointType: 'public',
  certificateRoot: 'exampleCertRoot'
};

cloudDatabasesService.getConnection(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

connection = cloud_databases_service.get_connection(
  id=deployment_id,
  user_type=user_type,
  user_id='exampleUserID',
  endpoint_type='public',
  certificate_root='exampleCertRoot',
).get_result()

print(json.dumps(connection, indent=2))
Copy to clipboard

Response

Response Body

Connection

Status Code

200
A Connection
403
Invalid token

Example responses

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Success example

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Success example

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Success example

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Success example

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Success example

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Success example

{
  "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..."
      }
    }
  }
}
Copy to clipboard

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.

POST /deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type}

(cloudDatabases *CloudDatabasesV5) CompleteConnection(completeConnectionOptions *CompleteConnectionOptions) (result *Connection, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) CompleteConnectionWithContext(ctx context.Context, completeConnectionOptions *CompleteConnectionOptions) (result *Connection, response *core.DetailedResponse, err error)

completeConnection(params)

complete_connection(self,
        id: str,
        user_type: str,
        user_id: str,
        endpoint_type: str,
        *,
        password: str = None,
        certificate_root: str = None,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST /v5/ibm/deployments/:deployment_id/users/:user_type/:user_id/connections/:endpoint_type

Request

Instantiate the CompleteConnectionOptions struct and set the fields to provide parameter values for the CompleteConnection method.

Path Parameters

id
Required*
string
Deployment ID
user_type
Required*
string
User type of database is the only currently supported value.

Example: database
user_id
Required*
string
User ID
endpoint_type
Required*
string
Endpoint Type. The select endpoint must be enabled on the deployment before its connection information can be fetched.

Allowable values: [public,private]

Request Body

object

Optional parameters to be substituted into the response

Examples:

parameter

WithContext method only

CompleteConnectionOptions

The CompleteConnection options.

parameters

id
Required*
string
Deployment ID.
userType
Required*
string
User type of database is the only currently supported value.
Examples:
userId
Required*
string
User ID.
endpointType
Required*
string
Endpoint Type. The select endpoint must be enabled on the deployment before its connection information can be fetched.

Allowable values: [public,private]
password
string
Password to be substituted into the response.
Examples:
certificateRoot
string
Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

parameters

id
Required*
str
Deployment ID.
user_type
Required*
str
User type of database is the only currently supported value.
Examples:
user_id
Required*
str
User ID.
endpoint_type
Required*
str
Endpoint Type. The select endpoint must be enabled on the deployment before its connection information can be fetched.

Allowable values: [public,private]
password
str
Password to be substituted into the response.
Examples:
certificate_root
str
Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type}  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -d '{"password": "providedpassword"}' \
Copy to clipboard

Example request

completeConnectionOptions := cloudDatabasesService.NewCompleteConnectionOptions(
  deploymentID,
  userType,
  "exampleUserID",
  "public",
)
completeConnectionOptions.SetPassword("examplePassword")
completeConnectionOptions.SetCertificateRoot("exampleCertRoot")

connection, response, err := cloudDatabasesService.CompleteConnection(completeConnectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(connection, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
  userType: userType,
  userId: 'exampleUserID',
  endpointType: 'public',
  password: 'examplePassword',
  certificateRoot: 'exampleCertRoot',
};

cloudDatabasesService.completeConnection(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

connection = cloud_databases_service.complete_connection(
  id=deployment_id,
  user_type=user_type,
  user_id='exampleUserID',
  endpoint_type='public',
  password='examplePassword',
  certificate_root='exampleCertRoot',
).get_result()

print(json.dumps(connection, indent=2))
Copy to clipboard

Response

Response Body

Connection

Status Code

200
A Connection
403
Invalid token
422
An error message response

Example responses

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Success example

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Success example

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Success example

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Success example

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Success example

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Success example

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Discover connection information for a deployment for a user.

GET /deployments/{id}/users/{user_type}/{user_id}/connections

Request

Path Parameters

id
Required*
string
Deployment ID
user_type
Required*
string
User type
user_id
Required*
string
User ID

Query Parameters

certificate_root
string
Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use by other commands.

Response

Response Body

Status Code

200
A Connection
403
Invalid token

Example responses

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

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.

POST /deployments/{id}/users/{user_type}/{user_id}/connections

Request

Path Parameters

id
Required*
string
Deployment ID
user_type
Required*
string
User type
user_id
Required*
string
User ID

Request Body

object

Optional parameters to be substituted into the response

Response

Response Body

Status Code

200
A Connection
403
Invalid token
422
An error message response

Example responses

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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"
    }
  }
}
Copy to clipboard

Status 200

{
  "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..."
      }
    }
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

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.

GET /deployments/{id}/groups

(cloudDatabases *CloudDatabasesV5) ListDeploymentScalingGroups(listDeploymentScalingGroupsOptions *ListDeploymentScalingGroupsOptions) (result *Groups, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) ListDeploymentScalingGroupsWithContext(ctx context.Context, listDeploymentScalingGroupsOptions *ListDeploymentScalingGroupsOptions) (result *Groups, response *core.DetailedResponse, err error)

listDeploymentScalingGroups(params)

list_deployment_scaling_groups(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/groups

Request

Instantiate the ListDeploymentScalingGroupsOptions struct and set the fields to provide parameter values for the ListDeploymentScalingGroups method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

ListDeploymentScalingGroupsOptions

The ListDeploymentScalingGroups options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups  -H 'Authorization: Bearer <>' \

Example request

listDeploymentScalingGroupsOptions := cloudDatabasesService.NewListDeploymentScalingGroupsOptions(
  deploymentID,
)

groups, response, err := cloudDatabasesService.ListDeploymentScalingGroups(listDeploymentScalingGroupsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(groups, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.listDeploymentScalingGroups(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

groups = cloud_databases_service.list_deployment_scaling_groups(
  id=deployment_id,
).get_result()

print(json.dumps(groups, indent=2))
Copy to clipboard

Response

Response Body

Groups

Examples:

Groups

Examples:

Groups

Examples:

Status Code

200
An array of scaling groups
403
Invalid token

No Sample Response

This method does not specify any sample responses.

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.

GET /deployables/{type}/groups

(cloudDatabases *CloudDatabasesV5) GetDefaultScalingGroups(getDefaultScalingGroupsOptions *GetDefaultScalingGroupsOptions) (result *Groups, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) GetDefaultScalingGroupsWithContext(ctx context.Context, getDefaultScalingGroupsOptions *GetDefaultScalingGroupsOptions) (result *Groups, response *core.DetailedResponse, err error)

getDefaultScalingGroups(params)

get_default_scaling_groups(self,
        type: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployables/:type/groups

Request

Instantiate the GetDefaultScalingGroupsOptions struct and set the fields to provide parameter values for the GetDefaultScalingGroups method.

Path Parameters

type
Required*
string
Database type name

Allowable values: [postgresql,etcd]
Example: postgresql

Query Parameters

host_flavor
string
When a host_flavor of 'multitenant' is included with the request, IBM Cloud Database's new shared compute default groups will be returned

Allowable values: [multitenant]
Example: multitenant

parameter

WithContext method only

GetDefaultScalingGroupsOptions

The GetDefaultScalingGroups options.

parameters

type
Required*
string
Database type name.

Allowable values: [postgresql,etcd]
Examples:

parameters

type
Required*
str
Database type name.

Allowable values: [postgresql,etcd]
Examples:

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployables/{type}/groups  -H 'Authorization: Bearer <>' \

Example request

getDefaultScalingGroupsOptions := cloudDatabasesService.NewGetDefaultScalingGroupsOptions(
  "postgresql",
)

groups, response, err := cloudDatabasesService.GetDefaultScalingGroups(getDefaultScalingGroupsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(groups, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  type: 'postgresql',
};

cloudDatabasesService.getDefaultScalingGroups(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

groups = cloud_databases_service.get_default_scaling_groups(
  type='postgresql',
).get_result()

print(json.dumps(groups, indent=2))
Copy to clipboard

Response

Response Body

Groups

Examples:

Groups

Examples:

Groups

Examples:

Status Code

200
An array of scaling groups
403
Invalid token

No Sample Response

This method does not specify any sample responses.

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.

PATCH /deployments/{id}/groups/{group_id}

(cloudDatabases *CloudDatabasesV5) SetDeploymentScalingGroup(setDeploymentScalingGroupOptions *SetDeploymentScalingGroupOptions) (result *SetDeploymentScalingGroupResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) SetDeploymentScalingGroupWithContext(ctx context.Context, setDeploymentScalingGroupOptions *SetDeploymentScalingGroupOptions) (result *SetDeploymentScalingGroupResponse, response *core.DetailedResponse, err error)

setDeploymentScalingGroup(params)

set_deployment_scaling_group(self,
        id: str,
        group_id: str,
        set_deployment_scaling_group_request: 'SetDeploymentScalingGroupRequest',
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

PATCH /v5/ibm/deployments/:deployment_id/groups/:group_id

Request

Instantiate the SetDeploymentScalingGroupOptions struct and set the fields to provide parameter values for the SetDeploymentScalingGroup method.

Path Parameters

id
Required*
string
Deployment ID
group_id
Required*
string
Group Id

Request Body

Required*

Scaling group settings

Examples:

parameter

WithContext method only

SetDeploymentScalingGroupOptions

The SetDeploymentScalingGroup options.

parameters

id
Required*
string
Deployment ID.
groupId
Required*
string
Group Id.
setDeploymentScalingGroupRequest
Change Request Parameter List

parameters

id
Required*
str
Deployment ID.
group_id
Required*
str
Group Id.
set_deployment_scaling_group_request
Change Request Parameter List

Example curl request

curl -X PATCH  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups/{group_id}  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -d '{"memory": {"allocation_mb": 4096}}' \
Copy to clipboard

Example request

setMemoryGroupMemoryModel := &clouddatabasesv5.SetMemoryGroupMemory{
  AllocationMb: core.Int64Ptr(int64(114688)),
}

setDeploymentScalingGroupRequestModel := &clouddatabasesv5.SetDeploymentScalingGroupRequestSetMemoryGroup{
  Memory: setMemoryGroupMemoryModel,
}

setDeploymentScalingGroupOptions := cloudDatabasesService.NewSetDeploymentScalingGroupOptions(
  deploymentID,
  scalingGroupIDLink,
  setDeploymentScalingGroupRequestModel,
)

setDeploymentScalingGroupResponse, response, err := cloudDatabasesService.SetDeploymentScalingGroup(setDeploymentScalingGroupOptions)
if err != nil {
  handleError(setDeploymentScalingGroupResponse, response, err)
}
b, _ := json.MarshalIndent(setDeploymentScalingGroupResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const setMemoryGroupMemoryModel = {
  allocation_mb: 114688,
};

const setDeploymentScalingGroupRequestModel = {
  memory: setMemoryGroupMemoryModel,
};

const params = {
  id: deploymentId,
  groupId: scalingGroupIdLink,
  setDeploymentScalingGroupRequest: setDeploymentScalingGroupRequestModel,
};

cloudDatabasesService.setDeploymentScalingGroup(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

set_memory_group_memory_model = SetMemoryGroupMemory(
  allocation_mb=114688,
)

set_deployment_scaling_group_request_model = SetDeploymentScalingGroupRequestSetMemoryGroup(
  memory=set_memory_group_memory_model,
)

set_deployment_scaling_group_response = cloud_databases_service.set_deployment_scaling_group(
  id=deployment_id,
  group_id=scaling_group_id_link,
  set_deployment_scaling_group_request=set_deployment_scaling_group_request_model
).get_result()

print(json.dumps(set_deployment_scaling_group_response, indent=2))
Copy to clipboard

Response

Response Body

object

SetDeploymentScalingGroupResponse

Examples:

SetDeploymentScalingGroupResponse

Examples:

SetDeploymentScalingGroupResponse

Examples:

Status Code

202
A task which is being run to scale the deployment
403
Invalid token
422
An error message response

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f4-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

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.

GET /deployments/{id}/groups/{group_id}/autoscaling

(cloudDatabases *CloudDatabasesV5) GetAutoscalingConditions(getAutoscalingConditionsOptions *GetAutoscalingConditionsOptions) (result *AutoscalingGroup, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) GetAutoscalingConditionsWithContext(ctx context.Context, getAutoscalingConditionsOptions *GetAutoscalingConditionsOptions) (result *AutoscalingGroup, response *core.DetailedResponse, err error)

getAutoscalingConditions(params)

get_autoscaling_conditions(self,
        id: str,
        group_id: str,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/groups/:group_id/autoscaling

Request

Instantiate the GetAutoscalingConditionsOptions struct and set the fields to provide parameter values for the GetAutoscalingConditions method.

Path Parameters

id
Required*
string
Deployment ID
group_id
Required*
string
Group ID

parameter

WithContext method only

GetAutoscalingConditionsOptions

The GetAutoscalingConditions options.

parameters

id
Required*
string
Deployment ID.
groupId
Required*
string
Group ID.

parameters

id
Required*
str
Deployment ID.
group_id
Required*
str
Group ID.

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups/{group_id}/autoscaling  -H 'Authorization: Bearer <>' \

Example request

getAutoscalingConditionsOptions := cloudDatabasesService.NewGetAutoscalingConditionsOptions(
  deploymentID,
  autoScalingGroupID,
)

autoscalingGroup, response, err := cloudDatabasesService.GetAutoscalingConditions(getAutoscalingConditionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(autoscalingGroup, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
  groupId: autoScalingGroupId,
};

cloudDatabasesService.getAutoscalingConditions(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

autoscaling_group = cloud_databases_service.get_autoscaling_conditions(
  id=deployment_id,
  group_id=auto_scaling_group_id,
).get_result()

print(json.dumps(autoscaling_group, indent=2))
Copy to clipboard

Response

Response Body

AutoscalingGroup

Status Code

200
An object containing autoscaling conditions
403
Invalid token
404
Not Found

Example responses

Status 200

{
  "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"
      }
    }
  }
}
Copy to clipboard

Success 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"
      }
    }
  }
}
Copy to clipboard

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.

PATCH /deployments/{id}/groups/{group_id}/autoscaling

(cloudDatabases *CloudDatabasesV5) SetAutoscalingConditions(setAutoscalingConditionsOptions *SetAutoscalingConditionsOptions) (result *SetAutoscalingConditionsResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) SetAutoscalingConditionsWithContext(ctx context.Context, setAutoscalingConditionsOptions *SetAutoscalingConditionsOptions) (result *SetAutoscalingConditionsResponse, response *core.DetailedResponse, err error)

setAutoscalingConditions(params)

set_autoscaling_conditions(self,
        id: str,
        group_id: str,
        autoscaling: 'AutoscalingSetGroupAutoscaling',
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

PATCH /v5/ibm/deployments/:deployment_id/groups/:group_id/autoscaling

Auditing

Calling this method generates the following auditing event.

<service_id>.autoscaling.update

Request

Instantiate the SetAutoscalingConditionsOptions struct and set the fields to provide parameter values for the SetAutoscalingConditions method.

Path Parameters

id
Required*
string
Deployment ID
group_id
Required*
string
Group ID

Request Body

Required*

AutoscalingSetGroup

Autoscaling configuration

Examples:

parameter

WithContext method only

SetAutoscalingConditionsOptions

The SetAutoscalingConditions options.

parameters

id
Required*
string
Deployment ID.
groupId
Required*
string
Group ID.
autoscaling
Change Request Parameter List

parameters

id
Required*
str
Deployment ID.
group_id
Required*
str
Group ID.
autoscaling
Change Request Parameter List

Example curl request

curl -X PATCH  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups/{group_id}/autoscaling  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -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"}}}}' \
Copy to clipboard

Example request

autoscalingMemoryGroupMemoryScalersIoUtilizationModel := &clouddatabasesv5.AutoscalingMemoryGroupMemoryScalersIoUtilization{
  Enabled:      core.BoolPtr(true),
  OverPeriod:   core.StringPtr("5m"),
  AbovePercent: core.Int64Ptr(int64(90)),
}

autoscalingMemoryGroupMemoryScalersModel := &clouddatabasesv5.AutoscalingMemoryGroupMemoryScalers{
  IoUtilization: autoscalingMemoryGroupMemoryScalersIoUtilizationModel,
}

autoscalingMemoryGroupMemoryRateModel := &clouddatabasesv5.AutoscalingMemoryGroupMemoryRate{
  IncreasePercent:  core.Float64Ptr(float64(10.0)),
  PeriodSeconds:    core.Int64Ptr(int64(300)),
  LimitMbPerMember: core.Float64Ptr(float64(114432)),
  Units:            core.StringPtr("mb"),
}

autoscalingMemoryGroupMemoryModel := &clouddatabasesv5.AutoscalingMemoryGroupMemory{
  Scalers: autoscalingMemoryGroupMemoryScalersModel,
  Rate:    autoscalingMemoryGroupMemoryRateModel,
}

autoscalingSetGroupAutoscalingModel := &clouddatabasesv5.AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup{
  Memory: autoscalingMemoryGroupMemoryModel,
}

setAutoscalingConditionsOptions := cloudDatabasesService.NewSetAutoscalingConditionsOptions(
  deploymentID,
  autoScalingGroupID,
  autoscalingSetGroupAutoscalingModel,
)

setAutoscalingConditionsResponse, response, err := cloudDatabasesService.SetAutoscalingConditions(setAutoscalingConditionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(setAutoscalingConditionsResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const autoscalingMemoryGroupMemoryScalersIoUtilizationModel = {
  enabled: true,
  over_period: '5m',
  above_percent: 90,
};

const autoscalingMemoryGroupMemoryScalersModel = {
  io_utilization: autoscalingMemoryGroupMemoryScalersIoUtilizationModel,
};

const autoscalingMemoryGroupMemoryRateModel = {
  increase_percent: 10.0,
  period_seconds: 300,
  limit_mb_per_member: 114432,
  units: 'mb',
};

const autoscalingMemoryGroupMemoryModel = {
  scalers: autoscalingMemoryGroupMemoryScalersModel,
  rate: autoscalingMemoryGroupMemoryRateModel,
};

const autoscalingSetGroupAutoscalingModel = {
  memory: autoscalingMemoryGroupMemoryModel,
};

const params = {
  id: deploymentId,
  groupId: autoScalingGroupId,
  autoscaling: autoscalingSetGroupAutoscalingModel,
};

cloudDatabasesService.setAutoscalingConditions(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

autoscaling_memory_group_memory_scalers_io_utilization_model = AutoscalingMemoryGroupMemoryScalersIoUtilization(
  enabled=True,
  over_period='5m',
  above_percent=90,
)

autoscaling_memory_group_memory_scalers_model = AutoscalingMemoryGroupMemoryScalers(
  io_utilization=autoscaling_memory_group_memory_scalers_io_utilization_model,
)

autoscaling_memory_group_memory_rate_model = AutoscalingMemoryGroupMemoryRate(
  increase_percent=10.0,
  period_seconds=300,
  limit_mb_per_member=114432,
  units='mb',
)

autoscaling_memory_group_memory_model = AutoscalingMemoryGroupMemory(
  scalers=autoscaling_memory_group_memory_scalers_model,
  rate=autoscaling_memory_group_memory_rate_model,
)

autoscaling_set_group_autoscaling_model = AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup(
  memory=autoscaling_memory_group_memory_model,
)

set_autoscaling_conditions_response = cloud_databases_service.set_autoscaling_conditions(
  id=deployment_id,
  group_id=auto_scaling_group_id,
  autoscaling=autoscaling_set_group_autoscaling_model,
).get_result()

print(json.dumps(set_autoscaling_conditions_response, indent=2))
Copy to clipboard

Response

Response Body

object

SetAutoscalingConditionsResponse

Examples:

SetAutoscalingConditionsResponse

Examples:

SetAutoscalingConditionsResponse

Examples:

Status Code

202
A task which is being run to configure autoscaling
403
Invalid token
404
Not Found

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423a4ef238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4d36-92f3-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Closes all the connections on a deployment. Available for PostgreSQL and EnterpriseDB ONLY.

DELETE /deployments/{id}/management/database_connections

(cloudDatabases *CloudDatabasesV5) KillConnections(killConnectionsOptions *KillConnectionsOptions) (result *KillConnectionsResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) KillConnectionsWithContext(ctx context.Context, killConnectionsOptions *KillConnectionsOptions) (result *KillConnectionsResponse, response *core.DetailedResponse, err error)

killConnections(params)

kill_connections(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

DELETE /v5/ibm/deployments/:deployment_id/management/database_connections

Request

Instantiate the KillConnectionsOptions struct and set the fields to provide parameter values for the KillConnections method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

KillConnectionsOptions

The KillConnections options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X DELETE  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/management/database_connections  -H 'Authorization: Bearer <>' \

Example request

killConnectionsOptions := cloudDatabasesService.NewKillConnectionsOptions(
  deploymentID,
)

killConnectionsResponse, response, err := cloudDatabasesService.KillConnections(killConnectionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(killConnectionsResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.killConnections(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

kill_connections_response = cloud_databases_service.kill_connections(
  id=deployment_id,
).get_result()

print(json.dumps(kill_connections_response, indent=2))
Copy to clipboard

Response

Response Body

object

KillConnectionsResponse

Examples:

KillConnectionsResponse

Examples:

KillConnectionsResponse

Examples:

Status Code

202
A task
403
Invalid token
404
not found

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0c59-4db6-92f3-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Starts a task that writes files to disk. Available for Elasticsearch ONLY.

POST /deployments/{id}/elasticsearch/file_syncs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST /v5/ibm/deployments/:deployment_id/elasticsearch/file_syncs

Request

Path Parameters

id
Required*
string
Deployment ID

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/elasticsearch/file_syncs  -H 'Authorization: Bearer <>' \

Response

Response Body

object

Status Code

200
A task
403
Invalid token
404
not found

Example responses

Status 200

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-elasticsearch:us-south:a/274074dce64e9c423ffc238516c755e1:b125f76a-99bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Creates a new logical replication slot on the specified database. For use with PostgreSQL and wal2json only.

POST /deployments/{id}/postgresql/logical_replication_slots

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST /v5/ibm/deployments/:deployment_id/postgresql/logical_replication_slots

Request

Path Parameters

id
Required*
string
Deployment ID

Request Body

Required*

object

Defines the logical replication slot. All fields are required.

Examples:

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/postgresql/logical_replication_slots  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -d '{"logical_replication_slot":{"name": "customer_replication","database_name": "customers","plugin_type": "wal2json"}}' \
Copy to clipboard

Response

Response Body

object

Status Code

202
A task
403
Invalid token
404
not found

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:eu-de:a/057f598ff0b94d9663c28b68843eaab3:b544602f-ad0a-405b-ba39-2e69d04ff3a2:task:d29ea458-5c11-486f-9182-1984ec5d5314",
    "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"
  }
}
Copy to clipboard

Deletes a logical replication slot from a database. For use with PostgreSQL, EnterpriseDB, and wal2json only.

DELETE /deployments/{id}/postgresql/logical_replication_slots/{name}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

DELETE /v5/ibm/deployments/:deployment_id/postgresql/logical_replication_slots/:name

Request

Path Parameters

id
Required*
string
Deployment ID
name
Required*
string
Name of the logical replication slot

Example curl request

curl -X DELETE  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/postgresql/logical_replication_slots/customer_replication  -H 'Authorization: Bearer <>' \

Response

Response Body

object

Status Code

202
A task
403
Invalid token
404
not found

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:eu-de:a/057f598ff0b94d9663c28b68843eaab3:b544602f-ad0a-405b-ba39-2e69d04ff3a2:task:d29ea458-5c11-486f-9182-1894ec5d5314",
    "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"
  }
}
Copy to clipboard

Retrieve the allowlisted addresses and ranges for a deployment.

GET /deployments/{id}/allowlists/ip_addresses

(cloudDatabases *CloudDatabasesV5) GetAllowlist(getAllowlistOptions *GetAllowlistOptions) (result *Allowlist, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) GetAllowlistWithContext(ctx context.Context, getAllowlistOptions *GetAllowlistOptions) (result *Allowlist, response *core.DetailedResponse, err error)

getAllowlist(params)

get_allowlist(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET /v5/ibm/deployments/:deployment_id/allowlists/ip_addresses

Request

Instantiate the GetAllowlistOptions struct and set the fields to provide parameter values for the GetAllowlist method.

Path Parameters

id
Required*
string
Deployment ID

parameter

WithContext method only

GetAllowlistOptions

The GetAllowlist options.

parameters

id
Required*
string
Deployment ID.

parameters

id
Required*
str
Deployment ID.

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses  -H 'Authorization: Bearer <>' \

Example request

getAllowlistOptions := cloudDatabasesService.NewGetAllowlistOptions(
  deploymentID,
)

allowlist, response, err := cloudDatabasesService.GetAllowlist(getAllowlistOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(allowlist, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
};

cloudDatabasesService.getAllowlist(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

allowlist = cloud_databases_service.get_allowlist(
  id=deployment_id,
).get_result()

print(json.dumps(allowlist, indent=2))
Copy to clipboard

Response

Response Body

Allowlist

Examples:

Allowlist

Examples:

Allowlist

Examples:

Status Code

200
An allowlist
403
Invalid token
422
An error message response

Example responses

Status 200

{
  "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"
    }
  ]
}
Copy to clipboard

Success 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"
    }
  ]
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

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.

PUT /deployments/{id}/allowlists/ip_addresses

(cloudDatabases *CloudDatabasesV5) SetAllowlist(setAllowlistOptions *SetAllowlistOptions) (result *SetAllowlistResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) SetAllowlistWithContext(ctx context.Context, setAllowlistOptions *SetAllowlistOptions) (result *SetAllowlistResponse, response *core.DetailedResponse, err error)

setAllowlist(params)

set_allowlist(self,
        id: str,
        *,
        ip_addresses: List['AllowlistEntry'] = None,
        if_match: str = None,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

PUT /v5/ibm/deployments/:deployment_id/allowlists/ip_addresses

Auditing

Calling this method generates the following auditing event.

<service_id>.allowlisted-ips-list.update

Request

Instantiate the SetAllowlistOptions struct and set the fields to provide parameter values for the SetAllowlist method.

Custom Headers

If-Match
string
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.

Path Parameters

id
Required*
string
Deployment ID

Request Body

Required*

New allowlist

Examples:

parameter

WithContext method only

SetAllowlistOptions

The SetAllowlist options.

parameters

id
Required*
string
Deployment ID.
ipAddresses
An array of allowlist entries.
Examples:
ifMatch
string
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.

parameters

id
Required*
str
Deployment ID.
ip_addresses
An array of allowlist entries.
Examples:
if_match
str
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.

Example curl request

curl -X PUT  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -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"}]}' \
Copy to clipboard

Example request

allowlistEntryModel := &clouddatabasesv5.AllowlistEntry{
  Address:     &IPAddress1,
  Description: core.StringPtr("Dev IP space 1"),
}

setAllowlistOptions := cloudDatabasesService.NewSetAllowlistOptions(
  deploymentID,
)
setAllowlistOptions.SetIPAddresses([]clouddatabasesv5.AllowlistEntry{*allowlistEntryModel})
setAllowlistOptions.SetIfMatch("exampleETag")

setAllowlistResponse, response, err := cloudDatabasesService.SetAllowlist(setAllowlistOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(setAllowlistResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const allowlistEntryModel = {
  address: ipAddress1,
  description: 'Dev IP space 1'
};

const params = {
  id: deploymentId,
  ipAddresses: [allowlistEntryModel],
  ifMatch: 'exampleETag',
};

cloudDatabasesService.setAllowlist(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

allowlist_entry_model = AllowlistEntry(
  address=ip_address_1,
  description='Dev IP space 1',
)

set_allowlist_response = cloud_databases_service.set_allowlist(
  id=deployment_id,
  ip_addresses=[allowlist_entry_model],
  if_match='exampleETag',
).get_result()

print(json.dumps(set_allowlist_response, indent=2))
Copy to clipboard

Response

Response Body

object

SetAllowlistResponse

Examples:

SetAllowlistResponse

Examples:

SetAllowlistResponse

Examples:

Status Code

202
A task which is being run to add the allowlist entry
403
Invalid token
422
An error message response

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-b5c96544573b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Add an address or range to the allowlist for a deployment.

POST /deployments/{id}/allowlists/ip_addresses

(cloudDatabases *CloudDatabasesV5) AddAllowlistEntry(addAllowlistEntryOptions *AddAllowlistEntryOptions) (result *AddAllowlistEntryResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) AddAllowlistEntryWithContext(ctx context.Context, addAllowlistEntryOptions *AddAllowlistEntryOptions) (result *AddAllowlistEntryResponse, response *core.DetailedResponse, err error)

addAllowlistEntry(params)

add_allowlist_entry(self,
        id: str,
        *,
        ip_address: 'AllowlistEntry' = None,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST /v5/ibm/deployments/:deployment_id/allowlists/ip_addresses

Request

Instantiate the AddAllowlistEntryOptions struct and set the fields to provide parameter values for the AddAllowlistEntry method.

Path Parameters

id
Required*
string
Deployment ID

Request Body

Required*

object

New allowlist Entry

Examples:

parameter

WithContext method only

AddAllowlistEntryOptions

The AddAllowlistEntry options.

parameters

id
Required*
string
Deployment ID.
ipAddress

parameters

id
Required*
str
Deployment ID.
ip_address

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses  -H 'Authorization: Bearer <>'  -H 'Content-Type: application/json'  -d '{"ip_address": {"address": "http://172.16.254.1/16", "description": "Dev IP space 3"}}' \
Copy to clipboard

Example request

allowlistEntryModel := &clouddatabasesv5.AllowlistEntry{
  Address:     &IPAddress3,
  Description: core.StringPtr("Dev IP space 3"),
}

addAllowlistEntryOptions := cloudDatabasesService.NewAddAllowlistEntryOptions(
  deploymentID,
)
addAllowlistEntryOptions.SetIPAddress(allowlistEntryModel)

addAllowlistEntryResponse, response, err := cloudDatabasesService.AddAllowlistEntry(addAllowlistEntryOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(addAllowlistEntryResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const allowlistEntryModel = {
  address: ipAddress3,
  description: 'Dev IP space 3',
};

const params = {
  id: deploymentId,
  ipAddress: allowlistEntryModel,
};

cloudDatabasesService.addAllowlistEntry(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

allowlist_entry_model = AllowlistEntry(
  address=ip_address_3,
  description='Dev IP space 3',
)

add_allowlist_entry_response = cloud_databases_service.add_allowlist_entry(
  id=deployment_id,
  ip_address=allowlist_entry_model,
).get_result()

print(json.dumps(add_allowlist_entry_response, indent=2))
Copy to clipboard

Response

Response Body

object

AddAllowlistEntryResponse

Examples:

AddAllowlistEntryResponse

Examples:

AddAllowlistEntryResponse

Examples:

Status Code

202
A task which is being run to add the allowlist entry
403
Invalid token
422
An error message response

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4db6-92f3-d9c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Delete an address or range from the allowlist of a deployment.

DELETE /deployments/{id}/allowlists/ip_addresses/{ipaddress}

(cloudDatabases *CloudDatabasesV5) DeleteAllowlistEntry(deleteAllowlistEntryOptions *DeleteAllowlistEntryOptions) (result *DeleteAllowlistEntryResponse, response *core.DetailedResponse, err error)

(cloudDatabases *CloudDatabasesV5) DeleteAllowlistEntryWithContext(ctx context.Context, deleteAllowlistEntryOptions *DeleteAllowlistEntryOptions) (result *DeleteAllowlistEntryResponse, response *core.DetailedResponse, err error)

deleteAllowlistEntry(params)

delete_allowlist_entry(self,
        id: str,
        ipaddress: str,
        **kwargs
    ) -> DetailedResponse
Copy to clipboard

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

DELETE /v5/ibm/deployments/:deployment_id/allowlists/ip_addresses/:ip_address_id

Request

Instantiate the DeleteAllowlistEntryOptions struct and set the fields to provide parameter values for the DeleteAllowlistEntry method.

Path Parameters

id
Required*
string
Deployment ID
ipaddress
Required*
string
An IPv4 address or a CIDR range (netmasked IPv4 address)

parameter

WithContext method only

DeleteAllowlistEntryOptions

The DeleteAllowlistEntry options.

parameters

id
Required*
string
Deployment ID.
ipaddress
Required*
string
An IPv4 address or a CIDR range (netmasked IPv4 address).

parameters

id
Required*
str
Deployment ID.
ipaddress
Required*
str
An IPv4 address or a CIDR range (netmasked IPv4 address).

Example curl request

curl -X DELETE  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses/{ipaddress}  -H 'Authorization: Bearer <>' \

Example request

deleteAllowlistEntryOptions := cloudDatabasesService.NewDeleteAllowlistEntryOptions(
  deploymentID,
  IPAddress3,
)

deleteAllowlistEntryResponse, response, err := cloudDatabasesService.DeleteAllowlistEntry(deleteAllowlistEntryOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(deleteAllowlistEntryResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

const params = {
  id: deploymentId,
  ipaddress: ipAddress3,
};

cloudDatabasesService.deleteAllowlistEntry(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });
Copy to clipboard

Example request

delete_allowlist_entry_response = cloud_databases_service.delete_allowlist_entry(
  id=deployment_id,
  ipaddress=ip_address_3,
).get_result()

print(json.dumps(delete_allowlist_entry_response, indent=2))
Copy to clipboard

Response

Response Body

object

DeleteAllowlistEntryResponse

Examples:

DeleteAllowlistEntryResponse

Examples:

DeleteAllowlistEntryResponse

Examples:

Status Code

202
A task which is being run to delete the allowlist entry
403
Invalid token
422
An error message response

Example responses

Status 202

{
  "task": {
    "id": "crn:v1:bluemix:public:databases-for-postgresql:us-south:a/274074dce64e9c423ffc238516c755e1:a127f76a-98bf-4f8b-b263-01d9e16b15bd:task:3dc480bd-0cd9-4d36-92f3-b5c96544393b",
    "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"
  }
}
Copy to clipboard

Success 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",
    "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"
  }
}
Copy to clipboard

Status 422

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Error example

{
  "errors": {
    "error.source": [
      "readable error message",
      "more error messages"
    ],
    "other.source": [
      "other errors"
    ]
  }
}
Copy to clipboard

Returns capability information based on the parameters provided. Also returns request parameters or defaults if request parameters are blank.

POST /capability/{capability_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

POST v5/ibm/capability/:capability_id

Request

Path Parameters

capability_id
Required*
string
Capability ID

Allowable values: [autoscaling,encryption,endpoints,groups,flavors,locations,point_in_time_recovery,remotes,restores,versions]

Request Body

Required*

object

Parameters for discovering capability.

Examples:

Example curl request

curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/capability/point_in_time_recovery  -H 'Authorization: Bearer <>'   -H 'Content-Type: application/json'  -d '{
        "deployment": {
          "type": "postgresql",
          "version": "14",
          "platform": "classic",
          "location": "us-south"
        },
        "options": {
          "target_platform": "classic",
          "target_location": "jp-tok"
        }
      }'
Copy to clipboard

Response

Response Body

object

Status Code

200
capability information
403
Invalid token
422
Unprocessable Entity

Example responses

Status 200: Point in time recovery is supported

{
  "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
    }
  }
}
Copy to clipboard

Status 200: Autoscaling is not supported

{
  "deployment": {
    "type": "postgresql",
    "version": "14",
    "platform": "satelite",
    "location": "satloc_wdc_abc123def456"
  },
  "capability": {
    "autoscaling": {
      "autoscaling_supported": false
    }
  }
}
Copy to clipboard

Status 200: Locations has location strings

{
  "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"
    ]
  }
}
Copy to clipboard

{ "errors": "bad_request" }

Status 422: Point in time recovery capability discovery is missing information

{
  "errors": {
    "deployment.type": [
      "can't be blank"
    ],
    "options.target_platform": [
      "can't be blank"
    ],
    "options.target_location": [
      "can't be blank"
    ]
  }
}
Copy to clipboard

Returns capability information based on the deployment provided. Also returns url parameters or defaults if request parameters are blank.

GET /deployments/{id}/capability/{capability_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET v5/ibm/deployments/:deployment_id/capability/:capability_id

Request

Path Parameters

id
Required*
string
Deployment ID
capability_id
Required*
string
Capability ID

Allowable values: [autoscaling,encryption,endpoints,groups,locations,point_in_time_recovery,remotes,versions]

Query Parameters

target_platform
string
Target platform. Required for Point In Time Recovery.

Example: target_platform=classic
target_location
string
Target location. Required for Point In Time Recovery.

Example: target_location=us-east
host_flavor
string
When a host_flavor of 'multitenant' is included with the request, IBM Cloud Database's new shared compute groups will be returned

Example: host_flavor=multitenant

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/crn:v1:bluemix:public:databases-for-postgresql:us-south:a%2F40ddc34a953a8c02f10987b59085b60e:f5cdcba4-b5d4-4d7e-a654-9140fa0deb27::/capability/point_in_time_recovery?target_platform=classic&target_location=jp-tok  -H 'Authorization: Bearer <>' \

Response

Response Body

object

Status Code

200
capability information
403
Invalid token
422
Unprocessable Entity

Example responses

Status 200: Point in time recovery is supported

{
  "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
    }
  }
}
Copy to clipboard

Status 200: Autoscaling is not supported

{
  "deployment": {
    "type": "postgresql",
    "version": "14",
    "platform": "satelite",
    "location": "satloc_wdc_abc123def456"
  },
  "capability": {
    "autoscaling": {
      "autoscaling_supported": false
    }
  }
}
Copy to clipboard

{ "errors": "bad_request" }

Status 422: Point in time recovery capability discovery is missing information

{
  "errors": {
    "deployment.type": [
      "can't be blank"
    ],
    "options.target_platform": [
      "can't be blank"
    ],
    "options.target_location": [
      "can't be blank"
    ]
  }
}
Copy to clipboard

Returns capability information based on the backup provided. Also returns url parameters or defaults if request parameters are blank.

GET /backups/{backup_id}/capability/{capability_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

GET v5/ibm/backups/:backup_id/capability/:capability_id

Request

Path Parameters

backup_id
Required*
string
Backup ID
capability_id
Required*
string
Capability ID

Allowable values: [restores]

Query Parameters

target_platform
string
Target platform.

Example: target_platform=classic
target_location
string
Target location.

Example: target_location=us-easst
host_flavor
string
When a host_flavor of 'multitenant' is included with the request, IBM Cloud Database's new shared compute groups will be returned

Example: host_flavor=multitenant

Example curl request

curl -X GET  https://api.{region}.databases.cloud.ibm.com/v5/ibm/backups/crn:v1:bluemix:public:databases-for-postgresql:us-south:a%2F40ddc34a953a8c02f10987b59085b60e:f5cdcba4-b5d4-4d7e-a654-9140fa0deb27:backup:d466d37b-88c0-4de1-bd69-1f62a5a37e12/capability/restores?target_platform=classic&target_location=jp-tok  -H 'Authorization: Bearer <>' \

Response

Response Body

object

Status Code

200
capability information
403
Invalid token
422
Unprocessable Entity

Example responses

Status 200: Backup restore is supported

{
  "backup": {
    "type": "postgresql",
    "version": "14",
    "platform": "classic",
    "location": "us-south"
  },
  "options": {
    "target_platform": "classic",
    "target_location": "jp-tok"
  },
  "capability": {
    "restores": {
      "backup_restore_supported": true
    }
  }
}
Copy to clipboard

{ "errors": "bad_request" }

Status 422: Backup restore capability discovery is missing information

{
  "errors": {
    "options.target_platform": [
      "can't be blank"
    ],
    "options.target_location": [
      "can't be blank"
    ]
  }
}
Copy to clipboard

Introduction

IBM Cloud Databases SDKs

Endpoint URLs

Authentication

Error Handling

Event tracking

Deployment IDs and CRNs

Pagination

Rate Limiting

Related APIs

Methods

List all deployable databases

Authorization

Request

No Request Parameters

parameter

ctx

No Request Parameters

No Request Parameters

No Request Parameters

Response

Response Body

deployables

type

versions

version

status

is_preferred

transitions

application

method

from_version

to_version

ListDeployablesResponse

Deployables

Type

Versions

Version

Status

IsPreferred

Transitions

Application

Method

FromVersion

ToVersion

ListDeployablesResponse

deployables

type

versions

version

status

is_preferred

transitions

application

method

from_version

to_version

ListDeployablesResponse

deployables

type

versions

version

status

is_preferred

transitions

application

method

from_version

to_version

Status Code

200

403

List all deployable regions

Authorization

Request

No Request Parameters

parameter

ctx

No Request Parameters

No Request Parameters