Service endpoints

Access IBM Cloud Backup and Recovery by using the listed endpoints for each supported IBM Cloud location.

Private endpoints

Private endpoints restrict access to the IBM Cloud private network. Both the API and service backup support private endpoints.

List of IBM Cloud Backup and Recovery private endpoints
Geography Region API Endpoint Backup Endpoint
United States Washington MZR (us-east) <instance_ID>.private.us-east.backup-recovery.cloud.ibm.com <instance_ID>.private.us-east.backup-recovery.cloud.ibm.com

When you connect by using a VPE or CSE, use port 443 with API and and port 29991 with the backup endpoints.

Querying the service endpoints with the CLI

To retrieve the service endpoints of a IBM Cloud Backup and Recovery instance using IBM Cloud CLI, use the command illustrated below:

ibmcloud resource service-instance (NAME|ID) --output json

The endpoint information for a service is available as part of the extensions blob in the response json.

{
    "extensions": {
        "endpoints": {
           "public": "https://<instance_ID>.us-east.backup-recovery.cloud.ibm.com",
           "private": "https://<instance_ID>.private.us-east.backup-recovery.cloud.ibm.com"
        }
    }
}

Querying the service endpoints with the API

The service endpoint information can be queried using the Global Search API as illustrated below:

# Search using service instance name
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: bearer <your IAM token>' -d '{"query": "type:resource-instance AND name:ABC","fields": ["*"]}' 'https://api.global-search-tagging.cloud.ibm.com/v3/resources/search?limit=1'

# Search using service instance guid
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: bearer <your IAM token>' -d '{"query": "type:resource-instance AND service_instance:9613ab9d-9749-4ef7-82b9-56cd023492e5","fields": ["doc.extensions.endpoints.private"]}' 'https://api.global-search-tagging.cloud.ibm.com/v3/resources/search?limit=1'