API docs by Redocly

VBackup Gateway API Definition (v1)

Download OpenAPI specification:Download

Backup Policy

Backup Policy Endpoint

Get a Backup Policy

Get a backup policy by ID

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-pol-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup policy.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-policies/bk-pol-6861d000-bb2e-11ed-afa1-0242ac120002',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Update a backup policy

Update a backup policy.

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-pol-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup policy.

Request Body schema: application/json
required

The information is used for update a backup policy.

backendId
string

The backend ID.

projectId
string

The project ID.

name
string

The name of backup policy

object (BackupPolicyConfig)

Configuration of the backup policy

Responses

Request samples

Content type
application/json
{
  • "backendId": "backup-id",
  • "projectId": "you-project Id",
  • "name": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Delete a backup policy

Delete a backup policy.

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-pol-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup policy.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-policies/bk-pol-6861d000-bb2e-11ed-afa1-0242ac120002',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

List Backup Policy

List Backup Policy with pagination and filtering.

Authorizations:
Authorization
query Parameters
backendId
string
Example: backendId=6861d000-bb2e-11ed-afa1-0242ac120002

A backend ID to filter backup policy by.

projectId
string
Example: projectId=pro-6861d000-bb2e-11ed-afa1-0242ac120002

A project ID to filter backup policy by.

name
string
Example: name=your-name

A name to filter backup policy by.

page
integer <int32>
Example: page=1

The page of items. It must start at 1.

size
integer <int32>
Example: size=50

The size of items

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-policies',
  qs: {
    backendId: 'SOME_STRING_VALUE',
    projectId: 'SOME_STRING_VALUE',
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Create a backup policy

Create a backup policy Endpoint.

Authorizations:
Authorization
Request Body schema: application/json
required

The information is used to create a new backup policy.

backendId
string

The backend ID.

projectId
string

The project ID.

name
string

The name of backup policy

object (BackupPolicyConfig)

Configuration of the backup policy

Responses

Request samples

Content type
application/json
{
  • "backendId": "backup-id",
  • "projectId": "you-project Id",
  • "name": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Backup Endpoint support for vServer

Backup Endpoint support for vServer

List Backup Server for vServer

List Backup Server for vServer

Authorizations:
Authorization
query Parameters
backendId
string
Example: backendId=6861d000-bb2e-11ed-afa1-0242ac120002

A backend ID to filter backup server by.

projectId
string
Example: projectId=pro-6861d000-bb2e-11ed-afa1-0242ac120002

A project ID to filter backup server by.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/vserver/backup-instances',
  qs: {backendId: 'SOME_STRING_VALUE', projectId: 'SOME_STRING_VALUE'},
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Create a Backup Server from vServer

Create a Backup Server from vServer.

Authorizations:
Authorization
Request Body schema: application/json
required

The information is used for create backup server

projectId
string

The project ID.

serverIds
Array of strings

List Server IDs

Responses

Request samples

Content type
application/json
{
  • "projectId": "you-project Id",
  • "serverIds": [
    ]
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Get a backup volume point for vServer

Get a backup volume point for vServer

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-vol-pt-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup volume point.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/vserver/backup-volume-points/bk-vol-pt-6861d000-bb2e-11ed-afa1-0242ac120002',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Get a backup server for vServer

Get a backup server for vServer

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/vserver/backup-instances/bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

List backup server points for vServer

List backup server points for vServer

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/vserver/backup-instances/bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002/backup-instance-points',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Get a backup server point for vServer

Get a backup server point for vServer

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-pt-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server point.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/vserver/backup-instance-points/bk-ins-pt-6861d000-bb2e-11ed-afa1-0242ac120002',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

List backup volume points for vServer

List backup volume points for vServer

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-pt-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server point.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/vserver/backup-instance-points/bk-ins-pt-6861d000-bb2e-11ed-afa1-0242ac120002/backup-volume-points',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

History

History Endpoint

List Restore History

List Restore History with pagination and filtering.

Authorizations:
Authorization
query Parameters
backendId
string
Example: backendId=6861d000-bb2e-11ed-afa1-0242ac120002

A backend ID to filter restore history by.

projectId
string
Example: projectId=pro-6861d000-bb2e-11ed-afa1-0242ac120002

A project ID to filter restore history by.

id
string
Example: id=vsr-res-6861d000-bb2e-11ed-afa1-0242ac120002

A restore history ID to filter backup restore history by.

serverId
string
Example: serverId=ins-6861d000-bb2e-11ed-afa1-0242ac120002

A server ID to filter backup restore history by.

backupInstanceId
string
Example: backupInstanceId=bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

A backup server ID to filter backup restore history by.

backupInstancePointId
string
Example: backupInstancePointId=bk-ins-pt-6861d000-bb2e-11ed-afa1-0242ac120002

A backup server point ID to filter backup restore history by.

volumeId
string
Example: volumeId=vol-6861d000-bb2e-11ed-afa1-0242ac120002

A volume ID to filter backup restore history by.

backupVolumePointId
string
Example: backupVolumePointId=bk-vol-pt-6861d000-bb2e-11ed-afa1-0242ac120002

A backup volume point ID to filter backup restore history by.

page
integer <int32>
Example: page=1

The page of items. It must start at 1.

size
integer <int32>
Example: size=50

The size of items

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/histories/restoration',
  qs: {
    backendId: 'SOME_STRING_VALUE',
    projectId: 'SOME_STRING_VALUE',
    id: 'SOME_STRING_VALUE',
    serverId: 'SOME_STRING_VALUE',
    backupInstanceId: 'SOME_STRING_VALUE',
    backupInstancePointId: 'SOME_STRING_VALUE',
    volumeId: 'SOME_STRING_VALUE',
    backupVolumePointId: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

List Backup Server History

List Backup Server History with pagination and filtering.

Authorizations:
Authorization
query Parameters
backendId
string
Example: backendId=6861d000-bb2e-11ed-afa1-0242ac120002

A backend ID to filter backup server history by.

projectId
string
Example: projectId=pro-6861d000-bb2e-11ed-afa1-0242ac120002

A project ID to filter backup server history by.

id
string
Example: id=bk-ins-pt-6861d000-bb2e-11ed-afa1-0242ac120002

A backup server point ID to filter backup server history by.

serverId
string
Example: serverId=ins-6861d000-bb2e-11ed-afa1-0242ac120002

A server ID to filter backup server history by.

backupInstanceId
string
Example: backupInstanceId=bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

A backup server ID to filter backup server history by.

page
integer <int32>
Example: page=1

The page of items. It must start at 1.

size
integer <int32>
Example: size=50

The size of items

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/histories/backup-instances',
  qs: {
    backendId: 'SOME_STRING_VALUE',
    projectId: 'SOME_STRING_VALUE',
    id: 'SOME_STRING_VALUE',
    serverId: 'SOME_STRING_VALUE',
    backupInstanceId: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Backend

Backend Endpoint

List Backends

List Backends with pagination and filtering.

Authorizations:
Authorization
query Parameters
backend
string
Example: backend=6861d000-bb2e-11ed-afa1-0242ac120002

The backend ID or name to filter backend by.

page
integer <int32>
Example: page=1

The page of items. It must start at 1.

size
integer <int32>
Example: size=50

The size of items

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backends',
  qs: {
    backend: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Backup Server

Backup Server Endpoint

List Volumes of a Backup Server

List Volumes of a Backup Server

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-instances/bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002/volumes',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Update Backup Volume.

Update Backup Volume.

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Request Body schema: application/json
required

The information is used to update backup volume.

volumeId
string

The ID of volume

backupEnabled
boolean

Allow backup volume

Responses

Request samples

Content type
application/json
{
  • "volumeId": "string",
  • "backupEnabled": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Update policy of a backup server

Update policy of a backup server.

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Request Body schema: application/json
required

The information is used for update policy of backup server.

id
string

The ID of backup policy

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Enable Backup Server

Enable Backup Server.

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'PUT',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-instances/bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002/enabled',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Disable Backup Server

Disable Backup Server

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'PUT',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-instances/bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002/disabled',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

List Backup Server

List Backup Server with pagination and filtering.

Authorizations:
Authorization
query Parameters
backendId
string
Example: backendId=6861d000-bb2e-11ed-afa1-0242ac120002

A backend ID to filter backup server by.

projectId
string
Example: projectId=pro-6861d000-bb2e-11ed-afa1-0242ac120002

A project ID to filter backup server by.

id
string
Example: id=bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

A ID to filter backup server by.

name
string
Example: name=your-name

A name to filter backup server by.

serverId
string
Example: serverId=ins-6861d000-bb2e-11ed-afa1-0242ac120002

A server ID to filter backup server by.

page
integer <int32>
Example: page=1

The page of items. It must start at 1.

size
integer <int32>
Example: size=50

The size of items

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-instances',
  qs: {
    backendId: 'SOME_STRING_VALUE',
    projectId: 'SOME_STRING_VALUE',
    id: 'SOME_STRING_VALUE',
    name: 'SOME_STRING_VALUE',
    serverId: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Create a Backup Server

Create a Backup Server Endpoint.

Authorizations:
Authorization
Request Body schema: application/json
required

The information is used to create a backup server.

backendId
string

The backend ID.

projectId
string

The project ID.

Array of objects (ServerConfig)

The configuration of the selected server.

description
string

The description of the backup server

backupEnabled
boolean

Allow backup running

backupPolicyId
string

The Backup Policy ID

backupDestinationId
string

The backup location ID

Responses

Request samples

Content type
application/json
{
  • "backendId": "backup-id",
  • "projectId": "you-project Id",
  • "serverConfig": [
    ],
  • "description": "string",
  • "backupEnabled": true,
  • "backupPolicyId": "string",
  • "backupDestinationId": "string"
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Get a Backup Server

Get a backup server by ID.

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-instances/bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Delete a Backup Server

Delete a backup server by ID.

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-instances/bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

List Backup Server Points of a Backup Server

List Backup Server Points of a Backup Server

Authorizations:
Authorization
path Parameters
id
required
string
Example: bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002

The id of backup server.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-instances/bk-ins-6861d000-bb2e-11ed-afa1-0242ac120002/backup-instance-points',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

List Protected Server

List Protected Server Endpoint.

Authorizations:
Authorization
query Parameters
backendId
string
Example: backendId=6861d000-bb2e-11ed-afa1-0242ac120002

A backend ID to filter backup server by.

projectId
string
Example: projectId=pro-6861d000-bb2e-11ed-afa1-0242ac120002

A project ID to filter backup server by.

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-instances/protected-servers',
  qs: {backendId: 'SOME_STRING_VALUE', projectId: 'SOME_STRING_VALUE'},
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Volume Usage

Volume Usage Endpoint

List Volume Usage

List Volume Usage

Authorizations:
Authorization
Request Body schema: application/json
required

The information is used for get the usage of volumes

backendId
string

The backend ID.

projectId
string

The project ID.

volumeIds
Array of strings

List of volume IDs.

Responses

Request samples

Content type
application/json
{
  • "backendId": "backup-id",
  • "projectId": "you-project Id",
  • "volumeIds": [
    ]
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Configuration

Configuration Endpoint

Get configuration

Get configuration Endpoint

Authorizations:
Authorization

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/configurations',
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}

Backup Location

Backup Location Endpoint

List Backup Location

List Backup Location with pagination and filtering.

Authorizations:
Authorization
query Parameters
backendId
string
Example: backendId=6861d000-bb2e-11ed-afa1-0242ac120002

A backend ID to filter backup location by.

projectId
string
Example: projectId=pro-6861d000-bb2e-11ed-afa1-0242ac120002

A project ID to filter backup location by.

name
string
Example: name=your-name

A name to filter backup location by.

type
string
Example: type=your-type

A type to filter backup location by.

page
integer <int32>
Example: page=1

The page of items. It must start at 1.

size
integer <int32>
Example: size=50

The size of items

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm-3.api.vngcloud.vn/vbackup-gateway/v1/backup-destinations',
  qs: {
    backendId: 'SOME_STRING_VALUE',
    projectId: 'SOME_STRING_VALUE',
    name: 'SOME_STRING_VALUE',
    type: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "message": "string"
}