Using APIs to manage, protect or restore PostgreSQL

This topic lists the APIs to manage, protect or restore the PostgreSQL instances and databases. Only the important variables and options are mentioned in this topic.

Following sections are part of this topic:

For detailed information on the APIs, use these references:

All the NetBackup APIs are listed at the following location:
Services and Operations Readiness Tools (SORT) > Knowledge Base > Documents

Add a PostgreSQL instance

Table: Add a PostgreSQL instance

API	Important variables and options
POST /netbackup/asset-service/queries GET /netbackup/asset-service/queries/{aqcId} GET /netbackup/asset-service/workloads /postgresql/assets	clientName is the name of the PostgreSQL instance. sqlHostName is hostname of a NetBackup client. credentialName are credentials associated with PostgreSQL instance. Note: The credential must exist with credentialName mentioned. port is port number of PostgreSQL instance.

API

Important variables and options

POST
/netbackup/asset-service/queries

GET
/netbackup/asset-service/queries/{aqcId}

GET
/netbackup/asset-service/workloads 
/postgresql/assets

clientName is the name of the PostgreSQL instance.
sqlHostName is hostname of a NetBackup client.
credentialName are credentials associated with PostgreSQL instance.
Note:
The credential must exist with credentialName mentioned.
port is port number of PostgreSQL instance.

PostgreSQL Discovery API

Table: Discover the PostgreSQL asset for given client

API	Important variables and options
POST /netbackup/admin/discovery /workloads/postgresql/start POST /netbackup/admin/discovery/workloads /postgresql/stop GET /netbackup/admin/discovery/workloads /postgresql/status POST /netbackup/admin/discovery/workloads /postgresql/allclientsdiscovery	serverName is used to identify instance or database discoveryHost is hostname where discovery needs to be triggered allclientsdiscovery triggers discovery for all the clients host associated with the primary.

API

Important variables and options

POST
/netbackup/admin/discovery
/workloads/postgresql/start

POST 
/netbackup/admin/discovery/workloads
/postgresql/stop

GET
/netbackup/admin/discovery/workloads
/postgresql/status

POST 
/netbackup/admin/discovery/workloads
/postgresql/allclientsdiscovery

serverName is used to identify instance or database
discoveryHost is hostname where discovery needs to be triggered
allclientsdiscovery triggers discovery for all the clients host associated with the primary.

Create a PostgreSQL Protection Plan

Table: Create a PostgreSQL Protection Plan

API	Important variables and options
POST /netbackup/servicecatalog/slos POST /netbackup/servicecatalog/slos/{sloId} /subscriptions POST /netbackup/servicecatalog/slos/{sloId} /backup-now	policyType is DataStore. Add scheduleName can have values like FULL_AUTO or INCR_AUTO for adding PostgreSQL instance. keyword can have the following values to back up an instance or database using different backup options: pg_dump pg_basebackup Snapshot pg_dumpall pgbackrest sloId is the identifier to protection plan selectionId is the AssetId which needs to be subscribed with given sloId

API

Important variables and options

POST 
/netbackup/servicecatalog/slos

POST
/netbackup/servicecatalog/slos/{sloId}
/subscriptions

POST
/netbackup/servicecatalog/slos/{sloId}
/backup-now

policyType is DataStore.
Add scheduleName can have values like FULL_AUTO or INCR_AUTO for adding PostgreSQL instance.
keyword can have the following values to back up an instance or database using different backup options:
- pg_dump
- pg_basebackup
- Snapshot
- pg_dumpall
- pgbackrest
sloId is the identifier to protection plan
selectionId is the AssetId which needs to be subscribed with given sloId

After you create a protection plan, other processes like creating the schedule for the policy or triggering the policy backup remain the same.

PostgreSQL Recovery point Service API

Table: PostgreSQL asset backup instances available for recovery

API	Important variables and options
GET /netbackup/recovery-point-service /workloads/postgresql/recovery-points GET /netbackup/recovery-point-service /workloads/postgresql/recovery-points /{backupId} GET /netbackup/wui/workloads/postgresql /recovery-point-calendar-summary	backupId is identifier that was used at the time of backup. assetId is identifier that was used to identify instance or database. client hostname is name of backup client.

API

Important variables and options

GET
/netbackup/recovery-point-service
/workloads/postgresql/recovery-points

GET
/netbackup/recovery-point-service
/workloads/postgresql/recovery-points
/{backupId}

GET
/netbackup/wui/workloads/postgresql
/recovery-point-calendar-summary

backupId is identifier that was used at the time of backup.
assetId is identifier that was used to identify instance or database.
client hostname is name of backup client.

Restore the PostgreSQL instance and database at the original location

Table: Restore the PostgreSQL instance and database at the original location

API	Important variables and options
POST /netbackup/recovery/workloads/postgresql/ scenarios/instance-complete-recovery /recover POST /netbackup/recovery/workloads/postgresql /scenarios/database-complete-recovery /recover	backupId is identifier that was used at the time of backup. assetId is identifier that was used to identify instance or database. Client is server that is to be used as the PostgreSQL recovery host to perform this recovery. Set the following value: renameAllFilesToSameLocation

API

Important variables and options

POST
/netbackup/recovery/workloads/postgresql/
scenarios/instance-complete-recovery  
/recover

POST 
/netbackup/recovery/workloads/postgresql   
/scenarios/database-complete-recovery
/recover

backupId is identifier that was used at the time of backup.
assetId is identifier that was used to identify instance or database.
Client is server that is to be used as the PostgreSQL recovery host to perform this recovery. Set the following value:
```
renameAllFilesToSameLocation 
```

Restore the PostgreSQL instance and database to an alternate location

Table: Restore the PostgreSQL instance and database to an alternate location

API	Important variables and options
POST /netbackup/recovery/workloads/postgresql/ scenarios/instance-complete-recovery /recover POST /netbackup/recovery/workloads/postgresql /scenarios/database-complete-recovery /recover	backupId is identifier that was used at the time of backup. assetId is identifier that was used to identify instance or database. Client is server that is to be used as the PostgreSQL recovery host to perform this recovery. Set the following value: renameEachFileToDifferentLocation

API

Important variables and options

POST
/netbackup/recovery/workloads/postgresql/
scenarios/instance-complete-recovery
/recover

POST 
/netbackup/recovery/workloads/postgresql
/scenarios/database-complete-recovery
/recover

backupId is identifier that was used at the time of backup.
assetId is identifier that was used to identify instance or database.
Client is server that is to be used as the PostgreSQL recovery host to perform this recovery. Set the following value:
```
renameEachFileToDifferentLocation  
```

Using APIs to manage, protect or restore PostgreSQL

Feedback

Feedback