Power Cloud DRAutomation API | IBM Cloud API Docs

Introduction

Last updated: 2025-12-12

The IBM Power Virtual Server DR Automation service allows you to easily configure and automate disaster recovery (DR) solutions for your IBM Power Virtual Server environments. It simplifies and automates DR operations for virtual servers running AIX, IBM i, or Linux (RHEL and SLES) workloads, ensuring high availability and business continuity in the event of an outage.

With this service, you can orchestrate the end-to-end DR process, including provisioning, replication, failover, and failback, without complex manual configurations.

To learn about using Power Virtual Server DR Automation, see:

SDKs

SDKs for Java, Node, Python, and Go are available for this API. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries.

To learn about using Power Virtual Server DR Automation, see:

Getting started with Power Virtual Server DR Automation

This documentation describes the Go SDK version 0.74.1. This SDK uses Semantic Versioning, and as such, there may be backward-incompatible changes for any new 0.y.z version. For information about the latest Go SDK, see Releases. For instructions and examples on using IBM Cloud services in an IBM Cloud SDK client library, see Using the SDK.

This documentation describes the Java SDK version 0.27.0. This SDK uses Semantic Versioning, and as such, there may be backward-incompatible changes for any new 0.y.z version. For information about the latest Java SDK, see Releases. For instructions and examples on using IBM Cloud services in an IBM Cloud SDK client library, see Using the SDK.

This documentation describes the Node SDK version 0.28.0. This SDK uses Semantic Versioning, and as such, there may be backward-incompatible changes for any new 0.y.z version. For information about the latest Node SDK, see Releases. For instructions and examples on using IBM Cloud services in an IBM Cloud SDK client library, see Using the SDK.

This documentation describes the Python SDK version 0.31.0. This SDK uses Semantic Versioning, and as such, there may be backward-incompatible changes for any new 0.y.z version. For information about the latest Python SDK, see Releases. For instructions and examples on using IBM Cloud services in an IBM Cloud SDK client library, see Using the SDK.

The code examples on this tab use the client library that is provided for Go.

Installation:

go get github.com/IBM/dra-go-sdk@v1.0.0

For more information, view the project on GitHub: https://github.com/IBM/dra-go-sdk/. See also Using the SDK.

The code examples on this tab use the client library that is provided for Java.

Maven example:

<dependency>
    <groupId>com.ibm.cloud</groupId>
    <artifactId>dr-automation-service</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle example:

compile 'com.ibm.cloud:dr-automation-service:1.0.0'

For more information, view the project on GitHub: https://github.com/IBM/dra-java-sdk/. See also Using the SDK.

The code examples on this tab use the client library that is provided for Node.

Installation:

npm install ibm-dr-automation-service

For more information, view the project on GitHub: https://github.com/IBM/dra-node-sdk/. See also Using the SDK.

The code examples on this tab use the client library that is provided for Python.

Installation:

pip install --upgrade "dra_python_sdk"

For more information, view the project on GitHub: https://github.com/IBM/dra-python-sdk/. See also the Python client library for IBM Cloud VPC Services https://pypi.org/project/ibm-dra-python-sdk/ and Using the SDK.

Endpoint URLs

The Power Virtual Server DR Automation service uses a global endpoint over the public network and seven regional endpoints over the private network.

Automatically generated regional API endpoints (service URL) will default to IBM Cloud Regions, which may cause your request to fail. You should always use the Power Virtual Server DR Automation–specified regions in the service URL.

The following table shows the IBM Cloud® regions and their corresponding Power Virtual Server DR Automation regions where the APIs are available:

Table 1. Power Virtual Server DR Automation public endpoints.
Country	Power Virtual Server DR Automation region	Location	Public end-point (service URL)
Australia	Sydney	syd04 syd05	https://power-dra.cloud.ibm.com
Brazil	Sao Paulo	sao01 sao04	https://power-dra.cloud.ibm.com
Canada	Montreal	mon01	https://power-dra.cloud.ibm.com
	Toronto	tor01	https://power-dra.cloud.ibm.com
Germany	Frankfurt	eu-de-1 eu-de-2	https://power-dra.cloud.ibm.com
UK/Great Britain	London	lon04 lon06	https://power-dra.cloud.ibm.com
India	Chennai	che01	https://power-dra.cloud.ibm.com
Japan	Tokyo	tok04	https://power-dra.cloud.ibm.com
	Osaka	osa21	https://power-dra.cloud.ibm.com
Spain	Madrid	mad02 mad04	https://power-dra.cloud.ibm.com
United States	Washington DC	us-east wdc06 wdc07	https://power-dra.cloud.ibm.com
	Dallas	dal10 dal12 us-south	https://power-dra.cloud.ibm.com

Table 2. Power Virtual Server DR Automation private endpoints.
Country	Power Virtual Server DR Automation region	Location	Private end-point (service URL)
Australia	Sydney	syd04 syd05	https://syd-power-dra.1qfl3nrg0u6c.private.au-syd.codeengine.appdomain.cloud
Brazil	Sao Paulo	sao01 sao04	https://sao-power-dra.1qmp1mucq5l0.private.br-sao.codeengine.appdomain.cloud
Canada	Montreal	mon01	https://us-east-power-dra.1qfelb2s387g.private.us-east.codeengine.appdomain.cloud
	Toronto	tor01	https://us-east-power-dra.1qfelb2s387g.private.us-east.codeengine.appdomain.cloud
Germany	Frankfurt	eu-de-1 eu-de-2	https://eu-de-power-dra.1qm8jq1yx8u9.private.eu-de.codeengine.appdomain.cloud
UK/Great Britain	London	lon04 lon06	https://lon-power-dra.1qm8sjzno2mc.private.eu-gb.codeengine.appdomain.cloud
India	Chennai	che01	https://syd-power-dra.1qfl3nrg0u6c.private.au-syd.codeengine.appdomain.cloud
Japan	Tokyo	tok04	https://osa-power-dra.1qmoz0iqryl2.private.jp-osa.codeengine.appdomain.cloud
	Osaka	osa21	https://osa-power-dra.1qmoz0iqryl2.private.jp-osa.codeengine.appdomain.cloud
Spain	Madrid	mad02 mad04	https://lon-power-dra.1qm8sjzno2mc.private.eu-gb.codeengine.appdomain.cloud
United States	Washington DC	us-east wdc06 wdc07	https://us-east-power-dra.1qfelb2s387g.private.us-east.codeengine.appdomain.cloud
	Dallas	dal10 dal12 us-south	https://us-south-power-dra.1q861580g9o7.private.us-south.codeengine.appdomain.cloud

Curl service URL intro

To call the API through Public end point, you can choose single service URL which is available https://power-dra.cloud.ibm.com and add a method path to form the complete request URL. For example, , to list all the supported disaster recovery locations, make a GET request to https://power-dra.cloud.ibm.com/v1/dr_locations/{instance_id}.

To call the API through Private end point, select the service URL that corresponds to the region of your choice and add a method path to form the complete request URL. For example, to list all the supported disaster recovery locations, make a GET request to https://dra-codeengine-app-us-south-prod-test.1q861580g9o7.private.us-south.codeengine.appdomain.cloud/v1/dr_locations/{instance_id}.

Example request to call the Power Virtual Server DR Automation global service URL:

curl -H "Authorization: Bearer {token}" -X GET "https://power-dra.cloud.ibm.com/v1/dr_locations/{instance_id}"

Replace {token}, {http_method}, and {path} in this example with the values for your particular request.

Authentication

The Power Virtual Server DR Automation API uses Identity and Access Management (IAM) to authenticate requests. To call each API method, you must be assigned a role that includes the required IAM actions. Each method has an Authorization section that lists the required actions and, if applicable, the conditions under which each action is required. Check your access on the IBM Cloud console by navigating to Users > User > Access.

For more information about IAM actions and how they map to roles, see Assigning access to account management services and Managing IAM access for Power Virtual Server DR Automation.

Learn about obtaining an IAM token for an authenticated user or service ID in the IAM Identity Services API. If you first create an API key, you can use it to generate an IAM token.

To use the API, add a valid IAM token to the HTTP Authorization request header. For example, -H 'Authorization: Bearer {token}'.

For specific APIs you must need to include your IBM Cloud IAM access token and the Power Virtual Server DR Automation instance ID, also known as your Cloud Resource Name (CRN), in each request. The first part of your CRN contains your Tenant ID and the second part contains your Cloud Instance ID.

The following example shows a typical CRN:

crn:v1:staging:public:power-dr-automation:us-east:a/abcdefghijklmnopqrstuvwxyzabcdef:121d5ee5-b87d-4a0e-86b8-aaff422135478::

Tenant ID {tenant_id} = abcdefghijklmnopqrstuvwxyzabcdef
Cloud Instance ID {cloud_instance_id} = 121d5ee5-b87d-4a0e-86b8-aaff422135478

You can retrieve an access token by first creating an API key, and then exchanging your API key for a IBM Cloud IAM token. For more information, see Retrieving an access token programmatically and Retrieving your instance ID.

To retrieve your access token:

curl -X POST   "https://iam.cloud.ibm.com/identity/token"   --header 'Content-Type: application/x-www-form-urlencoded'   --header 'Accept: application/json'   --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey'   --data-urlencode 'apikey={api_key}'
Copy to clipboard

To use the API, replace {token} with the token obtained in the previous section from IAM, replace {http_method} with an HTTP method such as POST, and replace {url} with a request URL such as https://us-south.iaas.cloud.ibm.com/v1/workspaces/{workspace_id}:

curl -H "Authorization: Bearer {token}" -X {http_method} "{url}"
     -H "CRN"
Copy to clipboard

Auditing

Monitor API activity within your account by using the IBM Cloud Activity Tracker service. Each time you make an API call, one or more events are generated that you can track and audit from within Activity Tracker. Specific auditing event types are listed for each individual method. For more information about Power Virtual Server DR Automation activity tracking, see Activity Tracker events.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

Table 1. HTTP error codes with their descriptions
HTTP Error Code	Description	Recovery
`400`	Bad Request	The input parameters in the request body are either incomplete, malformed, or too large. Be sure to include all required parameters in your request.
`401`	Unauthorized	You are not authorized to make this request. Log in to IBM Cloud and try submitting the request again. If this error persists, contact the account owner to check your permissions.
`403`	Forbidden	The supplied authentication is not authorized to perform the requested operation. Either you do not have valid access through IAM access policies or your request is denied. If this error persists, contact the account owner to check your permissions.
`404`	Not Found	The requested resource could not be found but may be available in the future.
`405`	Method Not Allowed	The requested resource does not support the request method.
`406`	Not Acceptable	The resource the client requested is not available in a format allowed by the `Accept` header supplied by the client.
`408`	Request Timeout	The connection to the server timed out. Wait a few minutes, and try submitting the request again.
`409`	Conflict	The request cannot be completed because of a conflict between the request and the current state of the resource.
`412`	Precondition Failed	The client specified one or more preconditions in its headers, and the server cannot meet those preconditions.
`426`	Upgrade Required	The server refuses to perform the request using the current protocol but might perform the request after the client upgrades to a different protocol.
`500`	Internal Server Error	The request cannot be processed because the client encountered an unexpected condition on the server. Wait a few minutes and try submitting the request again. If this error persists, contact IBM Support.
`501`	Not Implemented	The server either does not recognize the request method, or it lacks the ability to fulfill the request.
`502`	Bad Gateway	The server was acting as a gateway or proxy and received an invalid response from the upstream server.
`503`	Service Unavailable	The server cannot process the request. Generally, this condition is temporary, such as when a server is overloaded or down for scheduled maintenance. This condition could also be due to an unplanned outage of a service that is needed to process the request. Wait a few minutes and try submitting the request again. If this error persists, contact IBM Support.
`504`	Gateway Timeout	The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
`505`	HTTP Version Not Supported	The server does not support the HTTP protocol version that is used in the request.

Release notes

Use the release notes to learn about the latest changes to the Power Virtual Server DR Automation API.

Updating the current API key details for the specified service instance.

PUT /drautomation/v1/apikey/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) UpdateApikey(updateApikeyOptions *UpdateApikeyOptions) (result *ValidationKeyResponse, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) UpdateApikeyWithContext(ctx context.Context, updateApikeyOptions *UpdateApikeyOptions) (result *ValidationKeyResponse, response *core.DetailedResponse, err error)

ServiceCall<ValidationKeyResponse> updateApikey(UpdateApikeyOptions updateApikeyOptions)
Copy to clipboard

updateApikey(params)

update_apikey(
        self,
        instance_id: str,
        api_key: str,
        *,
        accept_language: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.orchestration-settings.update
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.orchestration-settings.update

Request

Instantiate the UpdateApikeyOptions struct and set the fields to provide parameter values for the UpdateApikey method.

Use the UpdateApikeyOptions.Builder to create a UpdateApikeyOptions object that contains the parameter values for the updateApikey method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

Request Body

Required*

UpdateKeyRequest

parameters for the validate key

parameter

WithContext method only

UpdateApikeyOptions

The UpdateApikey options.

UpdateApikeyOptions

The updateApikey options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
apiKey
Required*
string
The new API key value that will replace the existing one.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
api_key
Required*
str
The new API key value that will replace the existing one.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

Example request

curl -X PUT   https://power-dra.cloud.ibm.com/drautomation/v1/apikey/123456d3-1122-3344-b67d-4389b44b7bf9   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"   -H "Content-Type: application/json"   -d '{"api_key":"abcdef-ExAmPlE-ApI-K3Y-1234567890abcdef"}'
Copy to clipboard

Example request

updateApikeyOptions := drAutomationServiceService.NewUpdateApikeyOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
  "adfadfdsafsdfdsf",
)

validationKeyResponse, response, err := drAutomationServiceService.UpdateApikey(updateApikeyOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(validationKeyResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

UpdateApikeyOptions updateApikeyOptions = new UpdateApikeyOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .apiKey("adfadfdsafsdfdsf")
  .build();

Response<ValidationKeyResponse> response = drAutomationServiceService.updateApikey(updateApikeyOptions).execute();
ValidationKeyResponse validationKeyResponse = response.getResult();

System.out.println(validationKeyResponse);
Copy to clipboard

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
  apiKey: 'adfadfdsafsdfdsf',
};

let res;
try {
  res = await drAutomationServiceService.updateApikey(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.update_apikey(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
  api_key='adfadfdsafsdfdsf',
)
validation_key_response = response.get_result()

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

Response

Response Body

ValidationKeyResponse

Response object for API key validation, including ID, status, and description.

ValidationKeyResponse

Response object for API key validation, including ID, status, and description.

ValidationKeyResponse

Response object for API key validation, including ID, status, and description.

ValidationKeyResponse

Response object for API key validation, including ID, status, and description.

ValidationKeyResponse

Response object for API key validation, including ID, status, and description.

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
410
Gone
500
Internal Server Error

Example responses

Status 200

{
  "description": "Key is valid.",
  "status": "Active"
}
Copy to clipboard

Success example

{
  "description": "Key is valid.",
  "status": "Active"
}
Copy to clipboard

Retrieves the (GRS) location pairs associated with the specified service instance based on managed VMs.

GET /drautomation/v1/dr_grs_location_pairs/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetDrGrsLocationPair(getDrGrsLocationPairOptions *GetDrGrsLocationPairOptions) (result *GetGRSLocationPairResponse, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetDrGrsLocationPairWithContext(ctx context.Context, getDrGrsLocationPairOptions *GetDrGrsLocationPairOptions) (result *GetGRSLocationPairResponse, response *core.DetailedResponse, err error)

ServiceCall<GetGRSLocationPairResponse> getDrGrsLocationPair(GetDrGrsLocationPairOptions getDrGrsLocationPairOptions)
Copy to clipboard

getDrGrsLocationPair(params)

get_dr_grs_location_pair(
        self,
        instance_id: str,
        *,
        accept_language: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.dr-operation.read
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.dr-operation.read

Request

Instantiate the GetDrGrsLocationPairOptions struct and set the fields to provide parameter values for the GetDrGrsLocationPair method.

Use the GetDrGrsLocationPairOptions.Builder to create a GetDrGrsLocationPairOptions object that contains the parameter values for the getDrGrsLocationPair method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

parameter

WithContext method only

GetDrGrsLocationPairOptions

The GetDrGrsLocationPair options.

GetDrGrsLocationPairOptions

The getDrGrsLocationPair options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/dr_grs_location_pairs/123456d3-1122-3344-b67d-4389b44b7bf9   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

getDrGrsLocationPairOptions := drAutomationServiceService.NewGetDrGrsLocationPairOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
)

getGrsLocationPairResponse, response, err := drAutomationServiceService.GetDrGrsLocationPair(getDrGrsLocationPairOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(getGrsLocationPairResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

GetDrGrsLocationPairOptions getDrGrsLocationPairOptions = new GetDrGrsLocationPairOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .build();

Response<GetGRSLocationPairResponse> response = drAutomationServiceService.getDrGrsLocationPair(getDrGrsLocationPairOptions).execute();
GetGRSLocationPairResponse getGrsLocationPairResponse = response.getResult();

System.out.println(getGrsLocationPairResponse);

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
};

let res;
try {
  res = await drAutomationServiceService.getDrGrsLocationPair(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.get_dr_grs_location_pair(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
)
get_grs_location_pair_response = response.get_result()

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

Response

Response Body

GetGRSLocationPairResponse

Response body containing GRS location pairs

GetGRSLocationPairResponse

Response body containing GRS location pairs.

Examples:

GetGRSLocationPairResponse

Response body containing GRS location pairs.

Examples:

GetGRSLocationPairResponse

Response body containing GRS location pairs.

Examples:

GetGRSLocationPairResponse

Response body containing GRS location pairs.

Examples:

Status Code

200
Successfully fetched GRS location pairs
400
Bad Request (Instance ID not found)
403
Forbidden
404
Not Found
409
Conflict
500
Internal Server Error

Example responses

Status 200

{
  "location_pairs": {
    "dal10": "lon06",
    "eu-de": "us-south",
    "us-south": "eu-de"
  }
}
Copy to clipboard

Success example

{
  "location_pairs": {
    "dal10": "lon06",
    "eu-de": "us-south",
    "us-south": "eu-de"
  }
}
Copy to clipboard

Retrieves the list of disaster recovery (DR) locations available for the specified service instance.

GET /drautomation/v1/dr_locations/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetDrLocations(getDrLocationsOptions *GetDrLocationsOptions) (result *GetDrLocationsResponse, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetDrLocationsWithContext(ctx context.Context, getDrLocationsOptions *GetDrLocationsOptions) (result *GetDrLocationsResponse, response *core.DetailedResponse, err error)

ServiceCall<GetDrLocationsResponse> getDrLocations(GetDrLocationsOptions getDrLocationsOptions)
Copy to clipboard

getDrLocations(params)

get_dr_locations(
        self,
        instance_id: str,
        *,
        accept_language: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.dr-operation.read
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.dr-operation.read

Request

Instantiate the GetDrLocationsOptions struct and set the fields to provide parameter values for the GetDrLocations method.

Use the GetDrLocationsOptions.Builder to create a GetDrLocationsOptions object that contains the parameter values for the getDrLocations method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

parameter

WithContext method only

GetDrLocationsOptions

The GetDrLocations options.

GetDrLocationsOptions

The getDrLocations options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/dr_locations/123456d3-1122-3344-b67d-4389b44b7bf9   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

getDrLocationsOptions := drAutomationServiceService.NewGetDrLocationsOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
)

getDrLocationsResponse, response, err := drAutomationServiceService.GetDrLocations(getDrLocationsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(getDrLocationsResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

GetDrLocationsOptions getDrLocationsOptions = new GetDrLocationsOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .build();

Response<GetDrLocationsResponse> response = drAutomationServiceService.getDrLocations(getDrLocationsOptions).execute();
GetDrLocationsResponse getDrLocationsResponse = response.getResult();

System.out.println(getDrLocationsResponse);

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
};

let res;
try {
  res = await drAutomationServiceService.getDrLocations(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.get_dr_locations(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
)
get_dr_locations_response = response.get_result()

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

Response

Response Body

GetDrLocationsResponse

Response object containing a list of disaster recovery locations.

GetDrLocationsResponse

Response object containing a list of disaster recovery locations.

GetDrLocationsResponse

Response object containing a list of disaster recovery locations.

GetDrLocationsResponse

Response object containing a list of disaster recovery locations.

GetDrLocationsResponse

Response object containing a list of disaster recovery locations.

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error

Example responses

Status 200

{
  "dr_locations": [
    {
      "id": "loc-001",
      "name": "us-south"
    },
    {
      "id": "loc-002",
      "name": "eu-de"
    }
  ]
}
Copy to clipboard

Success example

{
  "dr_locations": [
    {
      "id": "loc-001",
      "name": "us-south"
    },
    {
      "id": "loc-002",
      "name": "eu-de"
    }
  ]
}
Copy to clipboard

Retrieves the list of disaster recovery (DR) managed virtual machines for the specified service instance.

GET /drautomation/v1/dr_managed_vms/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetDrManagedVm(getDrManagedVmOptions *GetDrManagedVmOptions) (result *ManagedVmMapResponse, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetDrManagedVmWithContext(ctx context.Context, getDrManagedVmOptions *GetDrManagedVmOptions) (result *ManagedVmMapResponse, response *core.DetailedResponse, err error)

ServiceCall<ManagedVmMapResponse> getDrManagedVm(GetDrManagedVmOptions getDrManagedVmOptions)
Copy to clipboard

getDrManagedVm(params)

get_dr_managed_vm(
        self,
        instance_id: str,
        *,
        accept_language: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.orchestrator-vm.read
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.orchestrator-vm.read

Request

Instantiate the GetDrManagedVmOptions struct and set the fields to provide parameter values for the GetDrManagedVm method.

Use the GetDrManagedVmOptions.Builder to create a GetDrManagedVmOptions object that contains the parameter values for the getDrManagedVm method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

parameter

WithContext method only

GetDrManagedVmOptions

The GetDrManagedVm options.

GetDrManagedVmOptions

The getDrManagedVm options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/dr_managed_vms/123456d3-1122-3344-b67d-4389b44b7bf9   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

getDrManagedVMOptions := drAutomationServiceService.NewGetDrManagedVMOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
)

managedVMMapResponse, response, err := drAutomationServiceService.GetDrManagedVM(getDrManagedVMOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(managedVMMapResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

GetDrManagedVmOptions getDrManagedVmOptions = new GetDrManagedVmOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .build();

Response<ManagedVmMapResponse> response = drAutomationServiceService.getDrManagedVm(getDrManagedVmOptions).execute();
ManagedVmMapResponse managedVmMapResponse = response.getResult();

System.out.println(managedVmMapResponse);

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
};

let res;
try {
  res = await drAutomationServiceService.getDrManagedVm(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.get_dr_managed_vm(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
)
managed_vm_map_response = response.get_result()

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

Response

Response Body

ManagedVmMapResponse

Map of VM IDs to managed VM details.

ManagedVmMapResponse

Map of VM IDs to managed VM details.

Examples:

ManagedVmMapResponse

Map of VM IDs to managed VM details.

Examples:

ManagedVmMapResponse

Map of VM IDs to managed VM details.

Examples:

ManagedVmMapResponse

Map of VM IDs to managed VM details.

Examples:

Status Code

200
Successfully fetched managed VMs
400
Bad Request (Instance ID not found)
401
Unauthorized
403
Forbidden
404
Not Found
409
Conflict
500
Internal Server Error

Example responses

Status 200

{
  "managed_vm_list": {
    "3f2e1a09-1234-4d56-7890-abcd1234ef56": {
      "core": "0.50",
      "dr_average_time": "10",
      "dr_region": "nyc02",
      "memory": "4",
      "region": "nyc01",
      "vm_name": "example_vm",
      "workgroup_name": "Example_Workgroup",
      "workspace_name": "Example_Workspace"
    },
    "9b8a7c65-4321-0fed-cba9-87654321abcd": {
      "core": "1.00",
      "dr_average_time": "5",
      "dr_region": "sfo04",
      "memory": "8",
      "region": "sfo03",
      "vm_name": "another_vm",
      "workgroup_name": "Another_Workgroup",
      "workspace_name": "Another_Workspace"
    }
  }
}
Copy to clipboard

Success example

{
  "managed_vm_list": {
    "3f2e1a09-1234-4d56-7890-abcd1234ef56": {
      "core": "0.50",
      "dr_average_time": "10",
      "dr_region": "nyc02",
      "memory": "4",
      "region": "nyc01",
      "vm_name": "example_vm",
      "workgroup_name": "Example_Workgroup",
      "workspace_name": "Example_Workspace"
    },
    "9b8a7c65-4321-0fed-cba9-87654321abcd": {
      "core": "1.00",
      "dr_average_time": "5",
      "dr_region": "sfo04",
      "memory": "8",
      "region": "sfo03",
      "vm_name": "another_vm",
      "workgroup_name": "Another_Workgroup",
      "workspace_name": "Another_Workspace"
    }
  }
}
Copy to clipboard

Retrieves the disaster recovery (DR) summary details for the specified service instance, including key configuration, status information and managed vm details.

GET /drautomation/v1/dr_summary/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetDrSummary(getDrSummaryOptions *GetDrSummaryOptions) (result *DrAutomationGetSummaryResponse, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetDrSummaryWithContext(ctx context.Context, getDrSummaryOptions *GetDrSummaryOptions) (result *DrAutomationGetSummaryResponse, response *core.DetailedResponse, err error)

ServiceCall<DrAutomationGetSummaryResponse> getDrSummary(GetDrSummaryOptions getDrSummaryOptions)
Copy to clipboard

getDrSummary(params)

get_dr_summary(
        self,
        instance_id: str,
        *,
        accept_language: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.dr-summary.read
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.dr-summary.read

Request

Instantiate the GetDrSummaryOptions struct and set the fields to provide parameter values for the GetDrSummary method.

Use the GetDrSummaryOptions.Builder to create a GetDrSummaryOptions object that contains the parameter values for the getDrSummary method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

parameter

WithContext method only

GetDrSummaryOptions

The GetDrSummary options.

GetDrSummaryOptions

The getDrSummary options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/dr_summary/123456d3-1122-3344-b67d-4389b44b7bf9   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

getDrSummaryOptions := drAutomationServiceService.NewGetDrSummaryOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
)

drAutomationGetSummaryResponse, response, err := drAutomationServiceService.GetDrSummary(getDrSummaryOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(drAutomationGetSummaryResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

GetDrSummaryOptions getDrSummaryOptions = new GetDrSummaryOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .build();

Response<DrAutomationGetSummaryResponse> response = drAutomationServiceService.getDrSummary(getDrSummaryOptions).execute();
DrAutomationGetSummaryResponse drAutomationGetSummaryResponse = response.getResult();

System.out.println(drAutomationGetSummaryResponse);

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
};

let res;
try {
  res = await drAutomationServiceService.getDrSummary(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.get_dr_summary(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
)
dr_automation_get_summary_response = response.get_result()

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

Response

Response Body

DrAutomationGetSummaryResponse

Response object containing all DR automation summary information

DrAutomationGetSummaryResponse

Response object containing all DR automation summary information.

DrAutomationGetSummaryResponse

Response object containing all DR automation summary information.

DrAutomationGetSummaryResponse

Response object containing all DR automation summary information.

DrAutomationGetSummaryResponse

Response object containing all DR automation summary information.

Status Code

200
OK
400
Bad Request
401
Unauthorized Entity
403
Forbidden
404
Not Found
409
Conflict
500
Internal Server Error

Example responses

Status 200

{
  "managed_vm_list": [
    {
      "id": "vm-01-1234-5678-90ab",
      "name": "test-aix-vm1"
    },
    {
      "id": "vm-02-2234-5678-90cd",
      "name": "test-aix-vm2"
    }
  ],
  "orchestrator_details": {
    "location_id": "dal10",
    "mfa_enabled": "false",
    "orch_ext_connectivity_status": "Connected",
    "orch_standby_node_addition_status": "Success",
    "orchestrator_cluster_message": "Cluster operational",
    "orchestrator_config_status": "Configured",
    "orchestrator_group_leader": "primary0906",
    "orchestrator_location_type": "off-premises",
    "orchestrator_name": "primary0906",
    "orchestrator_status": "Active",
    "orchestrator_workspace_name": "vpcdr6-abc-power-workspace",
    "proxy_ip": "10.0.0.5",
    "schematic_workspace_name": "us-south.workspace.projects-service.3ae96a02",
    "schematic_workspace_status": "Available",
    "ssh_key_name": "mani_key",
    "standby_orchestrator_name": "standby0906",
    "standby_orchestrator_status": "Active",
    "standby_orchestrator_workspace_name": "Test_workspace_frankfurt",
    "transit_gateway_name": "dra-tg-01",
    "vpc_name": "vpc-primary-us-south"
  },
  "service_details": {
    "crn": "crn:v1:staging:public:power-dr-automation:global:a/b68c234e719144b18598ae4a7b80c44c:03e32707-1234-zzsd-kkjh-4d790e863d5a09061::",
    "deployment_name": "defect_testing6abc0906",
    "description": "5/5: Primary orchestrator primary0906 is successfully deployed in 3m17s",
    "orchestrator_ha": true,
    "primary_ip_address": "10.51.0.123",
    "primary_orchestrator_dashboard_url": "",
    "recovery_location": "eu-de",
    "resource_group": "default-rg",
    "standby_description": "4/4: Standby orchestrator standby0906 is successfully deployed in 5m37s",
    "standby_ip_address": "10.0.9.123",
    "standby_orchestrator_dashboard_url": "",
    "standby_status": "Active",
    "status": "Active"
  }
}
Copy to clipboard

Success example

{
  "managed_vm_list": [
    {
      "id": "vm-01-1234-5678-90ab",
      "name": "test-aix-vm1"
    },
    {
      "id": "vm-02-2234-5678-90cd",
      "name": "test-aix-vm2"
    }
  ],
  "orchestrator_details": {
    "location_id": "dal10",
    "mfa_enabled": "false",
    "orch_ext_connectivity_status": "Connected",
    "orch_standby_node_addition_status": "Success",
    "orchestrator_cluster_message": "Cluster operational",
    "orchestrator_config_status": "Configured",
    "orchestrator_group_leader": "primary0906",
    "orchestrator_location_type": "off-premises",
    "orchestrator_name": "primary0906",
    "orchestrator_status": "Active",
    "orchestrator_workspace_name": "vpcdr6-abc-power-workspace",
    "proxy_ip": "10.0.0.5",
    "schematic_workspace_name": "us-south.workspace.projects-service.3ae96a02",
    "schematic_workspace_status": "Available",
    "ssh_key_name": "mani_key",
    "standby_orchestrator_name": "standby0906",
    "standby_orchestrator_status": "Active",
    "standby_orchestrator_workspace_name": "Test_workspace_frankfurt",
    "transit_gateway_name": "dra-tg-01",
    "vpc_name": "vpc-primary-us-south"
  },
  "service_details": {
    "crn": "crn:v1:staging:public:power-dr-automation:global:a/b68c234e719144b18598ae4a7b80c44c:03e32707-1234-zzsd-kkjh-4d790e863d5a09061::",
    "deployment_name": "defect_testing6abc0906",
    "description": "5/5: Primary orchestrator primary0906 is successfully deployed in 3m17s",
    "orchestrator_ha": true,
    "primary_ip_address": "10.51.0.123",
    "primary_orchestrator_dashboard_url": "",
    "recovery_location": "eu-de",
    "resource_group": "default-rg",
    "standby_description": "4/4: Standby orchestrator standby0906 is successfully deployed in 5m37s",
    "standby_ip_address": "10.0.9.123",
    "standby_orchestrator_dashboard_url": "",
    "standby_status": "Active",
    "status": "Active"
  }
}
Copy to clipboard

Retrieves the status of the last operation performed on the specified service instance, such as provisioning, updating, or deprovisioning.

GET /drautomation/v1/last_operation/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetLastOperation(getLastOperationOptions *GetLastOperationOptions) (result *ServiceInstanceStatus, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetLastOperationWithContext(ctx context.Context, getLastOperationOptions *GetLastOperationOptions) (result *ServiceInstanceStatus, response *core.DetailedResponse, err error)

ServiceCall<ServiceInstanceStatus> getLastOperation(GetLastOperationOptions getLastOperationOptions)
Copy to clipboard

getLastOperation(params)

get_last_operation(
        self,
        instance_id: str,
        *,
        accept_language: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.dr-operation.read
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.dr-operation.read

Request

Instantiate the GetLastOperationOptions struct and set the fields to provide parameter values for the GetLastOperation method.

Use the GetLastOperationOptions.Builder to create a GetLastOperationOptions object that contains the parameter values for the getLastOperation method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

parameter

WithContext method only

GetLastOperationOptions

The GetLastOperation options.

GetLastOperationOptions

The getLastOperation options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/last_operation/123456d3-1122-3344-b67d-4389b44b7bf9   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

getLastOperationOptions := drAutomationServiceService.NewGetLastOperationOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
)

serviceInstanceStatus, response, err := drAutomationServiceService.GetLastOperation(getLastOperationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(serviceInstanceStatus, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

GetLastOperationOptions getLastOperationOptions = new GetLastOperationOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .build();

Response<ServiceInstanceStatus> response = drAutomationServiceService.getLastOperation(getLastOperationOptions).execute();
ServiceInstanceStatus serviceInstanceStatus = response.getResult();

System.out.println(serviceInstanceStatus);

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
};

let res;
try {
  res = await drAutomationServiceService.getLastOperation(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.get_last_operation(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
)
service_instance_status = response.get_result()

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

Response

Response Body

ServiceInstanceStatus

Represents the current status and details of a service instance including orchestrator state, networking, and recovery information.

ServiceInstanceStatus

Represents the current status and details of a service instance including orchestrator state, networking, and recovery information.

ServiceInstanceStatus

Represents the current status and details of a service instance including orchestrator state, networking, and recovery information.

ServiceInstanceStatus

Represents the current status and details of a service instance including orchestrator state, networking, and recovery information.

ServiceInstanceStatus

Represents the current status and details of a service instance including orchestrator state, networking, and recovery information.

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
410
Gone
500
Internal Server error

Example responses

Status 200

{
  "crn": "crn:v1:staging:public:power-dr-automation:global:a/2c5d7270091f495795350e9adfa8399c:86e0c9a9-80f4-4fcf-88a0-07643de01bb8::",
  "deployment_name": "dr-deployment-instance-1",
  "last_updated_orchestrator_deployment_time": "2025-10-30T11:25:00.000Z",
  "last_updated_standby_orchestrator_deployment_time": "2025-10-30T11:40:00.000Z",
  "mfa_enabled": "false",
  "orch_ext_connectivity_status": "Connected",
  "orch_standby_node_addtion_status": "Completed",
  "orchestrator_cluster_message": "Cluster healthy",
  "orchestrator_config_status": "Configured",
  "orchestrator_ha": true,
  "plan_name": "standard",
  "primary_description": "2/5: Creating primary orchestrator VM.",
  "primary_ip_address": "192.168.1.10",
  "primary_orchestrator_status": "orchestrator-VM-creation-in-progress",
  "recovery_location": "us-east",
  "resource_group": "Default",
  "standby_description": "1/4: Service instance is downloading orchestrator image for standby VM creation.",
  "standby_ip_address": "192.168.1.11",
  "standby_status": "downloading-orchestrator-image",
  "status": "Running"
}
Copy to clipboard

Success example

{
  "crn": "crn:v1:staging:public:power-dr-automation:global:a/2c5d7270091f495795350e9adfa8399c:86e0c9a9-80f4-4fcf-88a0-07643de01bb8::",
  "deployment_name": "dr-deployment-instance-1",
  "last_updated_orchestrator_deployment_time": "2025-10-30T11:25:00.000Z",
  "last_updated_standby_orchestrator_deployment_time": "2025-10-30T11:40:00.000Z",
  "mfa_enabled": "false",
  "orch_ext_connectivity_status": "Connected",
  "orch_standby_node_addtion_status": "Completed",
  "orchestrator_cluster_message": "Cluster healthy",
  "orchestrator_config_status": "Configured",
  "orchestrator_ha": true,
  "plan_name": "standard",
  "primary_description": "2/5: Creating primary orchestrator VM.",
  "primary_ip_address": "192.168.1.10",
  "primary_orchestrator_status": "orchestrator-VM-creation-in-progress",
  "recovery_location": "us-east",
  "resource_group": "Default",
  "standby_description": "1/4: Service instance is downloading orchestrator image for standby VM creation.",
  "standby_ip_address": "192.168.1.11",
  "standby_status": "downloading-orchestrator-image",
  "status": "Running"
}
Copy to clipboard

Retrieves the list of supported machine types for the given workspace. This endpoint is used to identify machine types available for disaster recovery automation.

GET /drautomation/v1/machinetypes/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetMachineType(getMachineTypeOptions *GetMachineTypeOptions) (result *MachineTypesByWorkspace, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetMachineTypeWithContext(ctx context.Context, getMachineTypeOptions *GetMachineTypeOptions) (result *MachineTypesByWorkspace, response *core.DetailedResponse, err error)

ServiceCall<MachineTypesByWorkspace> getMachineType(GetMachineTypeOptions getMachineTypeOptions)
Copy to clipboard

getMachineType(params)

get_machine_type(
        self,
        instance_id: str,
        primary_workspace_name: str,
        *,
        accept_language: Optional[str] = None,
        standby_workspace_name: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.dr-operation.read
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.dr-operation.read

Request

Instantiate the GetMachineTypeOptions struct and set the fields to provide parameter values for the GetMachineType method.

Use the GetMachineTypeOptions.Builder to create a GetMachineTypeOptions object that contains the parameter values for the getMachineType method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

Query Parameters

primary_workspace_name
Required*
string
The primary Power virtual server workspace name

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[a-zA-Z0-9\-_]+$
Example: Test-workspace-wdc06
standby_workspace_name
string
The standby Power virtual server workspace name

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[a-zA-Z0-9\-_]+$
Example: Test-workspace-wdc07

parameter

WithContext method only

GetMachineTypeOptions

The GetMachineType options.

GetMachineTypeOptions

The getMachineType options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
primaryWorkspaceName
Required*
string
The primary Power virtual server workspace name.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/
standbyWorkspaceName
string
The standby Power virtual server workspace name.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
primary_workspace_name
Required*
str
The primary Power virtual server workspace name.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/
standby_workspace_name
str
The standby Power virtual server workspace name.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/machinetypes/123456d3-1122-3344-b67d-4389b44b7bf9?primary_workspace_name=Test-workspace-wdc06&standby_workspace_name=Test-workspace-wdc07   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

getMachineTypeOptions := drAutomationServiceService.NewGetMachineTypeOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
  "Test-workspace-wdc06",
)
getMachineTypeOptions.SetStandbyWorkspaceName("Test-workspace-wdc07")

machineTypesByWorkspace, response, err := drAutomationServiceService.GetMachineType(getMachineTypeOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(machineTypesByWorkspace, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

GetMachineTypeOptions getMachineTypeOptions = new GetMachineTypeOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .primaryWorkspaceName("Test-workspace-wdc06")
  .standbyWorkspaceName("Test-workspace-wdc07")
  .build();

Response<MachineTypesByWorkspace> response = drAutomationServiceService.getMachineType(getMachineTypeOptions).execute();
MachineTypesByWorkspace machineTypesByWorkspace = response.getResult();

System.out.println(machineTypesByWorkspace);
Copy to clipboard

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
  primaryWorkspaceName: 'Test-workspace-wdc06',
  standbyWorkspaceName: 'Test-workspace-wdc07',
};

let res;
try {
  res = await drAutomationServiceService.getMachineType(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.get_machine_type(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
  primary_workspace_name='Test-workspace-wdc06',
  standby_workspace_name='Test-workspace-wdc07',
)
machine_types_by_workspace = response.get_result()

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

Response

Response Body

MachineTypesByWorkspace

The Response body containing machine types supported by power virtual server workspace

MachineTypesByWorkspace

The Response body containing machine types supported by power virtual server workspace.

Examples:

MachineTypesByWorkspace

The Response body containing machine types supported by power virtual server workspace.

Examples:

MachineTypesByWorkspace

The Response body containing machine types supported by power virtual server workspace.

Examples:

MachineTypesByWorkspace

The Response body containing machine types supported by power virtual server workspace.

Examples:

Status Code

200
Successfully fetched machine types
400
Bad Request (Instance ID not found)
401
Unauthorized
403
Forbidden
404
Not Found
409
Conflict
500
Internal Server error

Example responses

Status 200

{
  "workspaces": {
    "test-workspace-WDC": [
      "e980",
      "s922"
    ]
  }
}
Copy to clipboard

Success example

{
  "workspaces": {
    "test-workspace-WDC": [
      "e980",
      "s922"
    ]
  }
}
Copy to clipboard

Retrieves the power virtual server workspaces for primary and standby orchestrator based on location id.

GET /drautomation/v1/powervs_workspaces/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetPowervsWorkspaces(getPowervsWorkspacesOptions *GetPowervsWorkspacesOptions) (result *DrData, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetPowervsWorkspacesWithContext(ctx context.Context, getPowervsWorkspacesOptions *GetPowervsWorkspacesOptions) (result *DrData, response *core.DetailedResponse, err error)

ServiceCall<DrData> getPowervsWorkspaces(GetPowervsWorkspacesOptions getPowervsWorkspacesOptions)
Copy to clipboard

getPowervsWorkspaces(params)

get_powervs_workspaces(
        self,
        instance_id: str,
        location_id: str,
        **kwargs,
    ) -> DetailedResponse

Authorization

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

power-dr-automation.dr-operation.read
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.dr-operation.read

Request

Instantiate the GetPowervsWorkspacesOptions struct and set the fields to provide parameter values for the GetPowervsWorkspaces method.

Use the GetPowervsWorkspacesOptions.Builder to create a GetPowervsWorkspacesOptions object that contains the parameter values for the getPowervsWorkspaces method.

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

Query Parameters

location_id
Required*
string
Location ID value

Possible values: 1 ≤ length ≤ 32, Value must match regular expression ^[a-zA-Z0-9\-_]+$

parameter

WithContext method only

GetPowervsWorkspacesOptions

The GetPowervsWorkspaces options.

GetPowervsWorkspacesOptions

The getPowervsWorkspaces options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
locationId
Required*
string
Location ID value.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
location_id
Required*
str
Location ID value.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/powervs_workspaces/123456d3-1122-3344-b67d-4389b44b7bf9?location_id=dal10   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

getPowervsWorkspacesOptions := drAutomationServiceService.NewGetPowervsWorkspacesOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
  "testString",
)

drData, response, err := drAutomationServiceService.GetPowervsWorkspaces(getPowervsWorkspacesOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(drData, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

GetPowervsWorkspacesOptions getPowervsWorkspacesOptions = new GetPowervsWorkspacesOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .locationId("testString")
  .build();

Response<DrData> response = drAutomationServiceService.getPowervsWorkspaces(getPowervsWorkspacesOptions).execute();
DrData drData = response.getResult();

System.out.println(drData);
Copy to clipboard

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
  locationId: 'testString',
};

let res;
try {
  res = await drAutomationServiceService.getPowervsWorkspaces(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.get_powervs_workspaces(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
  location_id='testString',
)
dr_data = response.get_result()

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

Response

Response Body

DrData

The list of primary and standby disaster recovery Power virtual server workspaces.

DrData

The list of primary and standby disaster recovery Power virtual server workspaces.

DrData

The list of primary and standby disaster recovery Power virtual server workspaces.

DrData

The list of primary and standby disaster recovery Power virtual server workspaces.

DrData

The list of primary and standby disaster recovery Power virtual server workspaces.

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Unprocessable Entity
404
Not Found
410
Gone
429
Too Many Requests
500
Internal Server error

Example responses

Status 200

{
  "dr_standby_workspaces": [
    {
      "details": {
        "crn": "crn:v1:bluemix:public:power-iaas:us-south:abc123:8aac93a4-f0cf-4b19-8d6d-9ba10883985d::"
      },
      "id": "8aac93a4-f0cf-4b19-8d6d-9ba10883985d",
      "location": {
        "region": "us-south",
        "type": "region",
        "url": "https://us-south.power-iaas.cloud.ibm.com"
      },
      "name": "ws-dallas-standby",
      "status": "active"
    }
  ],
  "dr_workspaces": [
    {
      "details": {
        "crn": "crn:v1:bluemix:public:power-iaas:us-south:abc123:9a9688a8-57e1-40b5-8c7d-f07e0a1cb305::"
      },
      "id": "9a9688a8-57e1-40b5-8c7d-f07e0a1cb305",
      "location": {
        "region": "us-south",
        "type": "region",
        "url": "https://us-south.power-iaas.cloud.ibm.com"
      },
      "name": "ws-dallas-primary",
      "status": "active"
    }
  ]
}
Copy to clipboard

Success example

{
  "dr_standby_workspaces": [
    {
      "details": {
        "crn": "crn:v1:bluemix:public:power-iaas:us-south:abc123:8aac93a4-f0cf-4b19-8d6d-9ba10883985d::"
      },
      "id": "8aac93a4-f0cf-4b19-8d6d-9ba10883985d",
      "location": {
        "region": "us-south",
        "type": "region",
        "url": "https://us-south.power-iaas.cloud.ibm.com"
      },
      "name": "ws-dallas-standby",
      "status": "active"
    }
  ],
  "dr_workspaces": [
    {
      "details": {
        "crn": "crn:v1:bluemix:public:power-iaas:us-south:abc123:9a9688a8-57e1-40b5-8c7d-f07e0a1cb305::"
      },
      "id": "9a9688a8-57e1-40b5-8c7d-f07e0a1cb305",
      "location": {
        "region": "us-south",
        "type": "region",
        "url": "https://us-south.power-iaas.cloud.ibm.com"
      },
      "name": "ws-dallas-primary",
      "status": "active"
    }
  ]
}
Copy to clipboard

Creates DR Deployment by creating Orchestrator instance in the given PowerVS workspace and configuration. Orchestrator instance can be used to manage multiple virtual servers and ensure continuous availability. For more details, refer Deploying the Orchestrator - https://cloud.ibm.com/docs/dr-automation-powervs?topic=dr-automation-powervs-idep-the-orch

Creates DR Deployment by creating Orchestrator instance in the given PowerVS workspace and configuration. Orchestrator instance can be used to manage multiple virtual servers and ensure continuous availability. For more details, refer Deploying the Orchestrator - https://cloud.ibm.com/docs/dr-automation-powervs?topic=dr-automation-powervs-idep-the-orch.

POST /drautomation/v1/manage_dr/{instance_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) CreateManageDr(createManageDrOptions *CreateManageDrOptions) (result *ServiceInstanceManageDR, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) CreateManageDrWithContext(ctx context.Context, createManageDrOptions *CreateManageDrOptions) (result *ServiceInstanceManageDR, response *core.DetailedResponse, err error)

ServiceCall<ServiceInstanceManageDR> createManageDr(CreateManageDrOptions createManageDrOptions)
Copy to clipboard

createManageDr(params)

create_manage_dr(
        self,
        instance_id: str,
        *,
        api_key: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        guid: Optional[str] = None,
        location_id: Optional[str] = None,
        machine_type: Optional[str] = None,
        orchestrator_ha: Optional[bool] = None,
        orchestrator_location_type: Optional[str] = None,
        orchestrator_name: Optional[str] = None,
        orchestrator_password: Optional[str] = None,
        orchestrator_workspace_id: Optional[str] = None,
        orchestrator_workspace_location: Optional[str] = None,
        proxy_ip: Optional[str] = None,
        region_id: Optional[str] = None,
        resource_instance: Optional[str] = None,
        secondary_workspace_id: Optional[str] = None,
        secret: Optional[str] = None,
        secret_group: Optional[str] = None,
        ssh_key_name: Optional[str] = None,
        standby_machine_type: Optional[str] = None,
        standby_orchestrator_name: Optional[str] = None,
        standby_orchestrator_workspace_id: Optional[str] = None,
        standby_orchestrator_workspace_location: Optional[str] = None,
        standby_tier: Optional[str] = None,
        tenant_name: Optional[str] = None,
        tier: Optional[str] = None,
        stand_by_redeploy: Optional[str] = None,
        accept_language: Optional[str] = None,
        accepts_incomplete: Optional[bool] = 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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.orchestrator-vm.update
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.orchestrator-vm.update

Request

Instantiate the CreateManageDrOptions struct and set the fields to provide parameter values for the CreateManageDr method.

Use the CreateManageDrOptions.Builder to create a CreateManageDrOptions object that contains the parameter values for the createManageDr method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

Query Parameters

stand_by_redeploy
string
Flag to indicate if standby should be redeployed (must be "true" or "false")

Possible values: 1 ≤ length ≤ 5, Value must match regular expression ^(true|false)$
accepts_incomplete
boolean
A value of true indicates that both the IBM Cloud platform and the requesting client support asynchronous deprovisioning.

Default: true

Request Body

Required*

ServiceInstanceManageDRRequest

parameters for the requested service instance manage-dr

Examples:

parameter

WithContext method only

CreateManageDrOptions

The CreateManageDr options.

CreateManageDrOptions

The createManageDr options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
apiKey
string
The api Key of the service instance for deploying the disaster recovery service.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
clientId
string
The Client Id created for MFA authentication API.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
clientSecret
string
The client secret created for MFA authentication API.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
guid
string
The global unique identifier of the service instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
locationId
string
The location or data center identifier where the service instance is deployed.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
machineType
string
The machine type used for deploying orchestrator.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
orchestratorHa
boolean
Indicates whether the orchestrator High Availability (HA) is enabled for the service instance.
Examples:
orchestratorLocationType
string
The cloud location where your orchestator need to be created.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
orchestratorName
string
The username used for the orchestrator.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
orchestratorPassword
string
The password that you can use to access your orchestrator.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression /^[\\x20-\\x7E]*$/
orchestratorWorkspaceId
string
The unique identifier orchestrator workspace.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
orchestratorWorkspaceLocation
string
The location of the orchestrator workspace.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
proxyIp
string
Proxy IP for the Communication between Orchestrator and Service broker.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9.\\-_:]+$/
Examples:
regionId
string
The power virtual server region where the service instance is deployed.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
resourceInstance
string
The uniquie identifier of the associated IBM Cloud resource instance.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^crn:v1:[a-zA-Z0-9\\-_]+:public:resource-controller:[a-zA-Z0-9\\-_]+:[a-zA-Z0-9\\-_\/]+:[a-zA-Z0-9\\-_]+::$/
Examples:
secondaryWorkspaceId
string
The unique identifier of the secondary workspace used for the disaster recovery.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
secret
string
The secret name or identifier used for retrieving credentials from secrets manager.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
secretGroup
string
The secret group name in IBM Cloud Secrets Manager containing sensitive data for the service instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
sshKeyName
string
The name of the SSH key used for deploying the orchestator.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standbyMachineType
string
The machine type used for deploying standby virtual machines.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standbyOrchestratorName
string
The username for the standby orchestrator management interface.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standbyOrchestratorWorkspaceId
string
The unique identifier of the standby orchestrator workspace.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standbyOrchestratorWorkspaceLocation
string
The location of the standby orchestrator workspace.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standbyTier
string
The storage tier used for deploying standby orchestrator.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
tenantName
string
The tenant name for MFA authentication API.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9.\\-]+$/
Examples:
tier
string
The storage tier used for deploying primary orchestrator.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standByRedeploy
string
Flag to indicate if standby should be redeployed (must be "true" or "false").

Possible values: 1 ≤ length ≤ 5, Value must match regular expression /^(true|false)$/
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/
acceptsIncomplete
boolean
A value of true indicates that both the IBM Cloud platform and the requesting client support asynchronous deprovisioning.

Default: true

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
api_key
str
The api Key of the service instance for deploying the disaster recovery service.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
client_id
str
The Client Id created for MFA authentication API.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
client_secret
str
The client secret created for MFA authentication API.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
guid
str
The global unique identifier of the service instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
location_id
str
The location or data center identifier where the service instance is deployed.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
machine_type
str
The machine type used for deploying orchestrator.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
orchestrator_ha
bool
Indicates whether the orchestrator High Availability (HA) is enabled for the service instance.
Examples:
orchestrator_location_type
str
The cloud location where your orchestator need to be created.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
orchestrator_name
str
The username used for the orchestrator.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
orchestrator_password
str
The password that you can use to access your orchestrator.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression /^[\\x20-\\x7E]*$/
orchestrator_workspace_id
str
The unique identifier orchestrator workspace.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
orchestrator_workspace_location
str
The location of the orchestrator workspace.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
proxy_ip
str
Proxy IP for the Communication between Orchestrator and Service broker.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9.\\-_:]+$/
Examples:
region_id
str
The power virtual server region where the service instance is deployed.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
resource_instance
str
The uniquie identifier of the associated IBM Cloud resource instance.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^crn:v1:[a-zA-Z0-9\\-_]+:public:resource-controller:[a-zA-Z0-9\\-_]+:[a-zA-Z0-9\\-_\/]+:[a-zA-Z0-9\\-_]+::$/
Examples:
secondary_workspace_id
str
The unique identifier of the secondary workspace used for the disaster recovery.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
secret
str
The secret name or identifier used for retrieving credentials from secrets manager.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
secret_group
str
The secret group name in IBM Cloud Secrets Manager containing sensitive data for the service instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
ssh_key_name
str
The name of the SSH key used for deploying the orchestator.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standby_machine_type
str
The machine type used for deploying standby virtual machines.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standby_orchestrator_name
str
The username for the standby orchestrator management interface.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standby_orchestrator_workspace_id
str
The unique identifier of the standby orchestrator workspace.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standby_orchestrator_workspace_location
str
The location of the standby orchestrator workspace.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
standby_tier
str
The storage tier used for deploying standby orchestrator.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
tenant_name
str
The tenant name for MFA authentication API.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9.\\-]+$/
Examples:
tier
str
The storage tier used for deploying primary orchestrator.

Possible values: 1 ≤ length ≤ 32, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
stand_by_redeploy
str
Flag to indicate if standby should be redeployed (must be "true" or "false").

Possible values: 1 ≤ length ≤ 5, Value must match regular expression /^(true|false)$/
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/
accepts_incomplete
bool
A value of true indicates that both the IBM Cloud platform and the requesting client support asynchronous deprovisioning.

Default: true

Example request

curl -X POST https://power-dra.cloud.ibm.com/drautomation/v1/manage_dr/123456d3-1122-3344-b67d-4389b44b7bf9   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"   -H "Content-Type: application/json"   -d '{"client_id":"abcd-97d2-1234-bf62-8eaecc67a1234","client_secret":"abcd1234xM1y123wK6qR9123456789bE2jG0pabcdefgh","dr_location_id":"dal10","dr_orchestrator_name":"drautomationprimary","dr_orchestrator_password":"Password1234567","dr_orchestrator_workspace_id":"75cbf05b-78f6-406e-afe7-a904f646d798","machine_type":"s922","orchestrator_ha":false,"orchestrator_location_type":"off-premises","proxy_ip":"10.30.40.10:8888","ssh_key_name":"vijaykey","standby_machine_type":"s922","standby_orchestrator_name":"drautomationstandby","standby_orchestrator_workspace_id":"71027b79-0e31-44f6-a499-63eca1a66feb","tenant_name":"xxx.ibm.com","tier":"tier1"}'
Copy to clipboard

Example request

createManageDrOptions := drAutomationServiceService.NewCreateManageDrOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
)
createManageDrOptions.SetOrchestratorHa(true)
createManageDrOptions.SetOrchestratorLocationType("off-premises")
createManageDrOptions.SetLocationID("dal10")
createManageDrOptions.SetOrchestratorWorkspaceID("75cbf05b-78f6-406e-afe7-a904f646d798")
createManageDrOptions.SetOrchestratorName("drautomationprimarybyh1105")
createManageDrOptions.SetOrchestratorPassword("EverytimeNewPassword@1")
createManageDrOptions.SetMachineType("s922")
createManageDrOptions.SetTier("tier1")
createManageDrOptions.SetSSHKeyName("vijaykey")
createManageDrOptions.SetAPIKey("key should pass")
// Standby fields (only for HA)
createManageDrOptions.SetStandbyOrchestratorName("drautomationstandbyh1105")
createManageDrOptions.SetStandbyOrchestratorWorkspaceID("71027b79-0e31-44f6-a499-63eca1a66feb")
createManageDrOptions.SetStandbyMachineType("s922")
createManageDrOptions.SetStandbyTier("tier1")
createManageDrOptions.SetStandByRedeploy("false")
// mfa
createManageDrOptions.SetClientID("123abcd-97d2-4b14-bf62-8eaecc67a122")
createManageDrOptions.SetClientSecret("abcdefgT5rS8wK6qR9dD7vF1hU4sA3bE2jG0pL9oX7yC")
createManageDrOptions.SetTenantName("xxx.ibm.com")

serviceInstanceManageDr, response, err := drAutomationServiceService.CreateManageDr(createManageDrOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(serviceInstanceManageDr, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

CreateManageDrOptions createManageDrOptions = new CreateManageDrOptions.Builder()
  .instanceId("crn:v1:staging:public:power-dr-automation:global:a/2b4ee2a3fe594a1c89f0e1a9f002a599:f36d1c39-f0af-425e-aee8-03ea9143013::")
  .standByRedeploy("false")
  .orchestratorHa(true)
  .orchestratorLocationType("off-premises")
  .locationId("dal10")
  .orchestratorWorkspaceId("75cbf05b-78f6-406e-afe7-a904f646d798")
  .orchestratorName("drautomationprimaryjavah1")
  .orchestratorPassword("EverytimeNewPassword@1")
  .machineType("s922")
  .tier("tier1")
  .sshKeyName("vijaykey")
  .apiKey("apikey should be passed")
  // Standby fields
  .standbyOrchestratorName("drautomationstandbyjavah1")
  .standbyOrchestratorWorkspaceId("71027b79-0e31-44f6-a499-63eca1a66feb")
  .standbyMachineType("s922")
  .standbyTier("tier1")
  // Mfa
  .clientId("123abcd-97d2-4b14-bf62-8eaecc67a122")
  .clientSecret("abcdefgT5rS8wK6qR9dD7vF1hU4sA3bE2jG0pL9oX7yC")
  .tenantName("xxx.ibm.com")
  .build();

Response<ServiceInstanceManageDR> response = drAutomationServiceService.createManageDr(createManageDrOptions).execute();
ServiceInstanceManageDR serviceInstanceManageDr = response.getResult();

System.out.println(serviceInstanceManageDr);
Copy to clipboard

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
};

let res;
try {
  res = await drAutomationServiceService.createManageDr(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.create_manage_dr(
    instance_id='crn:v1:staging:public:power-dr-automation:global:a/a123456fb04ceebfb4a9fd38c22334455:123456d3-1122-3344-b67d-4389b44b7bf9pyha1::',
    stand_by_redeploy='false',
    
    orchestrator_ha=True,
    orchestrator_location_type='off-premises',
    location_id='dal10',
    orchestrator_workspace_id='75cbf05b-78f6-406e-afe7-a904f646d798',
    orchestrator_name='drautomationprimarybypyh1105',
    orchestrator_password='EverytimeNewPassword@1',
    machine_type='s922',
    tier='tier1',
    ssh_key_name='vijaykey',
    api_key='apikey should pass',
    # Standby fields (only for HA)
    standby_orchestrator_name='drautomationstandbypyh1105',
    standby_orchestrator_workspace_id='71027b79-0e31-44f6-a499-63eca1a66feb',
    standby_machine_type='s922',
    standby_tier='tier1',

    # MFA fields
    client_id='123abcd-97d2-4b14-bf62-8eaecc67a122',
    client_secret='abcdefgT5rS8wK6qR9dD7vF1hU4sA3bE2jG0pL9oX7yC',
    tenant_name='xxx.ibm.com'
)

service_instance_manage_dr = response.get_result()

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

Response

Response Body

ServiceInstanceManageDR

Represents the response details for managing a DR service instance.

ServiceInstanceManageDR

Represents the response details for managing a DR service instance.

ServiceInstanceManageDR

Represents the response details for managing a DR service instance.

ServiceInstanceManageDR

Represents the response details for managing a DR service instance.

ServiceInstanceManageDR

Represents the response details for managing a DR service instance.

Status Code

200
OK
201
Accepted
400
Bad Request
401
Unauthorized
403
Unprocessable Entity
404
Not Found
409
Conflict
500
Internal Server error

Example responses

Status 200

{
  "dashboard_url": "https://power-dra.test.cloud.ibm.com/power-dra-ui?instance_id=crn:v1:bluemix:public:power-dr-automation:us-south:a/fe3c2ccd058e407c81e1dba2b5c0e0d6:e3d09875-bbf8-4d8a-b52c-abefb67a53c5::",
  "id": "crn:v1:staging:public:power-dr-automation:global:a/a123456fb04ceebfb4a9fd38c22334455:123456d3-1122-3344-b67d-4389b44b7bf9::"
}
Copy to clipboard

Success example

{
  "dashboard_url": "https://power-dra.test.cloud.ibm.com/power-dra-ui?instance_id=crn:v1:bluemix:public:power-dr-automation:us-south:a/fe3c2ccd058e407c81e1dba2b5c0e0d6:e3d09875-bbf8-4d8a-b52c-abefb67a53c5::",
  "id": "crn:v1:staging:public:power-dr-automation:global:a/a123456fb04ceebfb4a9fd38c22334455:123456d3-1122-3344-b67d-4389b44b7bf9::"
}
Copy to clipboard

Status 201

{
  "dashboard_url": "https://power-dra.test.cloud.ibm.com/power-dra-ui?instance_id=crn:v1:staging:public:power-dr-automation:global:a/a123456fb04ceebfb4a9fd38c22334455:123456d3-1122-3344-b67d-4389b44b7bf9::",
  "operation": "provision"
}
Copy to clipboard

Success example

{
  "dashboard_url": "https://power-dra.test.cloud.ibm.com/power-dra-ui?instance_id=crn:v1:staging:public:power-dr-automation:global:a/a123456fb04ceebfb4a9fd38c22334455:123456d3-1122-3344-b67d-4389b44b7bf9::",
  "operation": "provision"
}
Copy to clipboard

Retrieves the list of events from the specified service instance ID.

GET /drautomation/v1/service_instances/{instance_id}/events

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) ListEvents(listEventsOptions *ListEventsOptions) (result *EventCollection, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) ListEventsWithContext(ctx context.Context, listEventsOptions *ListEventsOptions) (result *EventCollection, response *core.DetailedResponse, err error)

ServiceCall<EventCollection> listEvents(ListEventsOptions listEventsOptions)
Copy to clipboard

listEvents(params)

list_events(
        self,
        instance_id: str,
        *,
        from_time: Optional[str] = None,
        to_time: Optional[str] = None,
        accept_language: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.event.list
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.event.list

Request

Instantiate the ListEventsOptions struct and set the fields to provide parameter values for the ListEvents method.

Use the ListEventsOptions.Builder to create a ListEventsOptions object that contains the parameter values for the listEvents method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9

Query Parameters

from_time
string
A from query time in either ISO 8601 or unix epoch format

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^(\d{10}|\d{13}|\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+\-]\d{2}:\d{2})?)$
Example: 2025-06-19T00:00:00.000Z
to_time
string
A to query time in either ISO 8601 or unix epoch format

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^(\d{10}|\d{13}|\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+\-]\d{2}:\d{2})?)$
Example: 2025-06-19T23:59:59.000Z

parameter

WithContext method only

ListEventsOptions

The ListEvents options.

ListEventsOptions

The listEvents options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
fromTime
string
A from query time in either ISO 8601 or unix epoch format.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^(\\d{10}|\\d{13}|\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+\\-]\\d{2}:\\d{2})?)$/
Examples:
toTime
string
A to query time in either ISO 8601 or unix epoch format.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^(\\d{10}|\\d{13}|\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+\\-]\\d{2}:\\d{2})?)$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
from_time
str
A from query time in either ISO 8601 or unix epoch format.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^(\\d{10}|\\d{13}|\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+\\-]\\d{2}:\\d{2})?)$/
Examples:
to_time
str
A to query time in either ISO 8601 or unix epoch format.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^(\\d{10}|\\d{13}|\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+\\-]\\d{2}:\\d{2})?)$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/service_instances/123456d3-1122-3344-b67d-4389b44b7bf9/events?from_time=2025-06-19T00:00:00Z&to_time=2025-06-19T23:59:59Z   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

listEventsOptions := drAutomationServiceService.NewListEventsOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
)
listEventsOptions.SetTime("2025-06-19T23:59:59Z")
listEventsOptions.SetFromTime("2025-06-19T00:00:00Z")
listEventsOptions.SetToTime("2025-06-19T23:59:59Z")

eventCollection, response, err := drAutomationServiceService.ListEvents(listEventsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(eventCollection, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

ListEventsOptions listEventsOptions = new ListEventsOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .time("2025-06-19T23:59:59Z")
  .fromTime("2025-06-19T00:00:00Z")
  .toTime("2025-06-19T23:59:59Z")
  .build();

Response<EventCollection> response = drAutomationServiceService.listEvents(listEventsOptions).execute();
EventCollection eventCollection = response.getResult();

System.out.println(eventCollection);
Copy to clipboard

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
  time: '2025-06-19T23:59:59Z',
  fromTime: '2025-06-19T00:00:00Z',
  toTime: '2025-06-19T23:59:59Z',
};

let res;
try {
  res = await drAutomationServiceService.listEvents(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.list_events(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
  time='2025-06-19T23:59:59Z',
  from_time='2025-06-19T00:00:00Z',
  to_time='2025-06-19T23:59:59Z',
)
event_collection = response.get_result()

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

Response

Response Body

EventCollection

Container object holding a list of events.

EventCollection

Container object holding a list of events.

EventCollection

Container object holding a list of events.

EventCollection

Container object holding a list of events.

EventCollection

Container object holding a list of events.

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Unprocessable Entity
404
Not Found
410
Gone
500
Internal Server error
524
Timeout Error

Example responses

Status 200

{
  "events": [
    {
      "action": "create",
      "event_id": "1cecfe43-43cd-4b1b-86be-30c2d3d2a25f",
      "level": "info",
      "message": "Service Instance '7222c899-a31a-4a0c-be03-75920d23cd16' has been created successfully.",
      "messageData": {
        "InstanceID": {
          "id": "7222c899-a31a-4a0c-be03-75920d23cd16"
        }
      },
      "metadata": {},
      "resource": "ProvisionID",
      "time": "2025-06-23T07:12:49.840Z",
      "timestamp": "1750662769",
      "user": {
        "user_id": "admin"
      }
    },
    {
      "action": "create",
      "event_id": "c49f0ced-2a78-48a6-929c-6b824555ddc6",
      "level": "info",
      "message": "Disaster recovery for Service Instance '7222c899-a31a-4a0c-be03-75920d23cd16' has been managed successfully.",
      "messageData": {
        "InstanceID": {
          "id": "7222c899-a31a-4a0c-be03-75920d23cd16"
        }
      },
      "metadata": {},
      "resource": "managedr",
      "time": "2025-06-23T07:14:53.871Z",
      "timestamp": "1750662893",
      "user": {
        "email": "abcuser@ibm.com",
        "user_id": "IBMid-695000ab7E"
      }
    }
  ]
}
Copy to clipboard

Success example

{
  "events": [
    {
      "action": "create",
      "event_id": "1cecfe43-43cd-4b1b-86be-30c2d3d2a25f",
      "level": "info",
      "message": "Service Instance '7222c899-a31a-4a0c-be03-75920d23cd16' has been created successfully.",
      "messageData": {
        "InstanceID": {
          "id": "7222c899-a31a-4a0c-be03-75920d23cd16"
        }
      },
      "metadata": {},
      "resource": "ProvisionID",
      "time": "2025-06-23T07:12:49.840Z",
      "timestamp": "1750662769",
      "user": {
        "user_id": "admin"
      }
    },
    {
      "action": "create",
      "event_id": "c49f0ced-2a78-48a6-929c-6b824555ddc6",
      "level": "info",
      "message": "Disaster recovery for Service Instance '7222c899-a31a-4a0c-be03-75920d23cd16' has been managed successfully.",
      "messageData": {
        "InstanceID": {
          "id": "7222c899-a31a-4a0c-be03-75920d23cd16"
        }
      },
      "metadata": {},
      "resource": "managedr",
      "time": "2025-06-23T07:14:53.871Z",
      "timestamp": "1750662893",
      "user": {
        "email": "abcuser@ibm.com",
        "user_id": "IBMid-695000ab7E"
      }
    }
  ]
}
Copy to clipboard

Retrieves the details of a specific event for the given service instance provision ID.

GET /drautomation/v1/service_instances/{instance_id}/events/{event_id}

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetEvent(getEventOptions *GetEventOptions) (result *Event, response *core.DetailedResponse, err error)

(powerCloudDrAutomationApi *PowerCloudDrAutomationApiV1) GetEventWithContext(ctx context.Context, getEventOptions *GetEventOptions) (result *Event, response *core.DetailedResponse, err error)

ServiceCall<Event> getEvent(GetEventOptions getEventOptions)
Copy to clipboard

getEvent(params)

get_event(
        self,
        instance_id: str,
        event_id: str,
        *,
        accept_language: Optional[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 actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

power-dr-automation.event.read
Grants access to this and other methods.
power-dr-automation.orchestration-settings.read

Auditing

Calling this method generates the following auditing event.

power-dr-automation.event.read

Request

Instantiate the GetEventOptions struct and set the fields to provide parameter values for the GetEvent method.

Use the GetEventOptions.Builder to create a GetEventOptions object that contains the parameter values for the getEvent method.

Custom Headers

Accept-Language
string
The language requested for the return document

Possible values: 1 ≤ length ≤ 50, Value must match regular expression ^[a-zA-Z\-_,;=.*]+$

Path Parameters

instance_id
Required*
string
instance id of instance to provision

Possible values: 1 ≤ length ≤ 512, Value must match regular expression ^[a-zA-Z0-9\-_:/.]+$
Example: 123456d3-1122-3344-b67d-4389b44b7bf9
event_id
Required*
string
Event ID

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[a-zA-Z0-9\-_]+$
Example: 00116b2a-9326-4024-839e-fb5364b76898

parameter

WithContext method only

GetEventOptions

The GetEvent options.

GetEventOptions

The getEvent options.

parameters

instanceId
Required*
string
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
eventId
Required*
string
Event ID.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
acceptLanguage
string
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

parameters

instance_id
Required*
str
instance id of instance to provision.

Possible values: 1 ≤ length ≤ 512, Value must match regular expression /^[a-zA-Z0-9\\-_:\/.]+$/
Examples:
event_id
Required*
str
Event ID.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
Examples:
accept_language
str
The language requested for the return document.

Possible values: 1 ≤ length ≤ 50, Value must match regular expression /^[a-zA-Z\\-_,;=.*]+$/

Example request

curl -X GET   https://power-dra.cloud.ibm.com/drautomation/v1/service_instances/123456d3-1122-3344-b67d-4389b44b7bf9/events/1cecfe43-43cd-4b1b-86be-30c2d3d2a25f   -H "Authorization: Bearer ${iam_token}"   -H "Accept: application/json"
Copy to clipboard

Example request

getEventOptions := drAutomationServiceService.NewGetEventOptions(
  "123456d3-1122-3344-b67d-4389b44b7bf9",
  "00116b2a-9326-4024-839e-fb5364b76898",
)

event, response, err := drAutomationServiceService.GetEvent(getEventOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(event, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Example request

GetEventOptions getEventOptions = new GetEventOptions.Builder()
  .instanceId("123456d3-1122-3344-b67d-4389b44b7bf9")
  .eventId("00116b2a-9326-4024-839e-fb5364b76898")
  .build();

Response<Event> response = drAutomationServiceService.getEvent(getEventOptions).execute();
Event event = response.getResult();

System.out.println(event);
Copy to clipboard

Example request

const params = {
  instanceId:
    '123456d3-1122-3344-b67d-4389b44b7bf9',
  eventId: '00116b2a-9326-4024-839e-fb5364b76898',
};

let res;
try {
  res = await drAutomationServiceService.getEvent(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
Copy to clipboard

Example request

response = dr_automation_service_service.get_event(
  instance_id='123456d3-1122-3344-b67d-4389b44b7bf9',
  event_id='00116b2a-9326-4024-839e-fb5364b76898',
)
event = response.get_result()

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

Response

Response Body

Event

Represents an individual event in the system, including details about action, resource, user, and timestamps.

Event

Represents an individual event in the system, including details about action, resource, user, and timestamps.

Event

Represents an individual event in the system, including details about action, resource, user, and timestamps.

Event

Represents an individual event in the system, including details about action, resource, user, and timestamps.

Event

Represents an individual event in the system, including details about action, resource, user, and timestamps.

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Unprocessable Entity
404
Not Found
410
Gone
500
Internal Server error

Example responses

Status 200

{
  "action": "create",
  "api_source": "dr-automation-api",
  "event_id": "1cecfe43-43cd-4b1b-86be-30c2d3d2a25f",
  "level": "info",
  "message": "Service Instance created successfully",
  "message_data": {
    "InstanceID": {
      "id": "7222c899-a31a-4a0c-be03-75920d23cd16"
    },
    "request_id": {
      "id": "req-12345"
    }
  },
  "metadata": {},
  "resource": "ProvisionID",
  "time": "2025-06-23T07:12:49.840Z",
  "timestamp": "1750662769",
  "user": {
    "user_email": "example.user@ibm.com",
    "user_id": "IBMid-123456"
  }
}
Copy to clipboard

Success example

{
  "action": "create",
  "api_source": "dr-automation-api",
  "event_id": "1cecfe43-43cd-4b1b-86be-30c2d3d2a25f",
  "level": "info",
  "message": "Service Instance created successfully",
  "message_data": {
    "InstanceID": {
      "id": "7222c899-a31a-4a0c-be03-75920d23cd16"
    },
    "request_id": {
      "id": "req-12345"
    }
  },
  "metadata": {},
  "resource": "ProvisionID",
  "time": "2025-06-23T07:12:49.840Z",
  "timestamp": "1750662769",
  "user": {
    "user_email": "example.user@ibm.com",
    "user_id": "IBMid-123456"
  }
}
Copy to clipboard

Introduction

SDKs

Endpoint URLs

Curl service URL intro

Authentication

Auditing

Error handling

Release notes

Methods

Updates the API key for the specified service instance

Authorization

Auditing

Request

Custom Headers

Accept-Language

Path Parameters

instance_id

Request Body

api_key

parameter

ctx

UpdateApikeyOptions

InstanceID

ApiKey

AcceptLanguage

UpdateApikeyOptions

instanceId

apiKey

acceptLanguage

parameters

instanceId

apiKey

acceptLanguage

parameters

instance_id

api_key

accept_language

Response

Response Body

description

id

status

ValidationKeyResponse

Description

ID

Status

ValidationKeyResponse

description

id

status

ValidationKeyResponse

description

id

status

ValidationKeyResponse

description

id

status

Status Code

200

400

401

403

404

410

500

Get GRS location pairs based on managed vms

Authorization

Auditing

Request

Custom Headers

Accept-Language

Path Parameters

instance_id

parameter

ctx

GetDrGrsLocationPairOptions

InstanceID

AcceptLanguage

GetDrGrsLocationPairOptions