BackupsApi

All URIs are relative to https://api.ionos.com/databases/postgresql

Method	HTTP request	Description
clusterBackupsGet	GET /clusters/{clusterId}/backups	List backups of cluster
clustersBackupsFindById	GET /clusters/backups/{backupId}	Fetch a cluster backup
clustersBackupsGet	GET /clusters/backups	List cluster backups

clusterBackupsGet

clusterBackupsGet(clusterId, opts)

List backups of cluster

Retrieves a list of all backups of the given PostgreSQL cluster.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-postgres');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.BackupsApi(config);
// List backups of cluster
api_instance
  .clusterBackupsGet({
    clusterId: 498ae72f-411f-11eb-9d07-046c59cc737e,
    limit: 100,
    offset: 200, 
    options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name	Type	Description	Notes
clusterId	string	The unique ID of the cluster.	[default to undefined]
limit	number	The maximum number of elements to return. Use together with 'offset' for pagination.	[optional][default to 100]
offset	number	The first element to return. Use together with 'limit' for pagination.	[optional][default to 0]

Return type

ClusterBackupList

Authorization

basicAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined

• Accept: application/json

clustersBackupsFindById

clustersBackupsFindById(backupId)

Fetch a cluster backup

Retrieve a PostgreSQL cluster backup by using its ID. This value can be found when you GET a list of PostgreSQL cluster backups.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-postgres');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.BackupsApi(config);
// Fetch a cluster backup
api_instance
  .clustersBackupsFindById({
    backupId: 498ae72f-411f-11eb-9d07-046c59cc737e-4oymiqu-12
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name	Type	Description	Notes
backupId	string	The unique ID of the backup.	[default to undefined]

Return type

BackupResponse

Authorization

basicAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined

• Accept: application/json

clustersBackupsGet

clustersBackupsGet(opts)

List cluster backups

Retrieves a list of all PostgreSQL cluster backups.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-postgres');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.BackupsApi(config);
// List cluster backups
api_instance
  .clustersBackupsGet({
    limit: 100,
    offset: 200
    options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

Name	Type	Description	Notes
limit	number	The maximum number of elements to return. Use together with 'offset' for pagination.	[optional][default to 100]
offset	number	The first element to return. Use together with 'limit' for pagination.	[optional][default to 0]

Return type

ClusterBackupList

Authorization

basicAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined

• Accept: application/json