vStorage API (v2.0)

Download OpenAPI specification:Download

billing

Billing operation endpoint

This API is used to retrieve the summary request of specific project in a range date

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

query Parameters
endTime
required
string

dd/MM/yyyy

startTime
required
string

dd/MM/yyyy

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/billing/statistics/projects/{project_id}/request',
  qs: {endTime: 'SOME_STRING_VALUE', startTime: 'SOME_STRING_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve the summary traffic of specific project in a range date

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

query Parameters
endTime
required
string

dd/MM/yyyy

startTime
required
string

dd/MM/yyyy

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/billing/statistics/projects/{project_id}/traffic',
  qs: {endTime: 'SOME_STRING_VALUE', startTime: 'SOME_STRING_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve the summary usage of specific project in a range date

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

query Parameters
endTime
required
string

dd/MM/yyyy

startTime
required
string

dd/MM/yyyy

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/billing/statistics/projects/{project_id}/usage',
  qs: {endTime: 'SOME_STRING_VALUE', startTime: 'SOME_STRING_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve the current quota of specific project

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/quota',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve current traffic (total outgoing traffic) of a project.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/traffic',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve traffic (total outgoing traffic) of project in a date time range.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

query Parameters
endTime
required
string

MM/dd/yyyy HH:mm

startTime
required
string

MM/dd/yyyy HH:mm

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/traffic/search',
  qs: {endTime: 'SOME_STRING_VALUE', startTime: 'SOME_STRING_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve current usage of a project.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/usage',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve usage of a project in a date time range.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

query Parameters
endTime
required
string

MM/dd/yyyy HH:mm

startTime
required
string

MM/dd/yyyy HH:mm

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/usage/search',
  qs: {endTime: 'SOME_STRING_VALUE', startTime: 'SOME_STRING_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve usage of all projects of an user in a date time range.

Authorizations:
Bearer_Token
path Parameters
user_id
required
string

The user portal id

query Parameters
end_time
required
string

MM/dd/yyyy HH:mm

start_time
required
string

MM/dd/yyyy HH:mm

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/users/{user_id}/usage',
  qs: {end_time: 'SOME_STRING_VALUE', start_time: 'SOME_STRING_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

container

Container operation endpoint

This API is used to retrieve all containers of a project.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

query Parameters
limit
ref
Example: limit=20

Page size

marker
ref

Last container name of previous page

permission
ref

Retrieve public (PUBLIC_READ) or private (PRIVATE_READ) containers

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}',
  qs: {
    limit: 'SOME_REF_VALUE',
    marker: 'SOME_REF_VALUE',
    permission: 'SOME_REF_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to create a new container on a project.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'POST',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}',
  headers: {
    accept: 'application/json',
    'content-type': '*/*',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

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

  console.log(body);
});

This API is used to delete a container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to get list access control list of a container

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/acls',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to replace all exists access control list of a container

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Request Body schema: application/json

req

Array of objects (UserRoleMapping)

Responses

Request samples

Content type
application/json
{
  • "userRoles": [
    ]
}

This API is used to set CORS of a container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Request Body schema: application/json

req

headers
Array of strings

Value for the Access-Control-Allow-Headers header

hosts
Array of strings

Value for the Access-Control-Allow-Origin header

Responses

Request samples

Content type
application/json
{
  • "headers": [
    ],
  • "hosts": [
    ]
}

This API is used to remove CORS of a container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/cors',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to check if a container has public access permission

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/public_access',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to set public access permission of a container

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Request Body schema: application/json

req

enable
required
boolean

Allow public access to containers or not

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

This API is used to set a container as a static website.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'POST',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/static_web',
  headers: {
    accept: 'application/json',
    'content-type': '*/*',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

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

  console.log(body);
});

This API is used to remove a container as a static website.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/static_web',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve storage URL of a container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/url',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to search by name for containers of a project.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

Request Body schema: application/json

req

page
required
integer <int32>
pageSize
required
integer <int32>
searchNameOperator
string

Search operator by name

searchText
string

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "searchNameOperator": "match_prefix|match_suffix|match_all|match_phrase",
  • "searchText": "string"
}

This API is used to retrieve detail information of a container (ex: object count, size).

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/{container}/details',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

object

Object operation endpoint

This API is used to retrieve all objects of a directory.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

query Parameters
directoryName
ref

The directory name

limit
ref

Page size

marker
ref

Last object name of previous page

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}',
  qs: {
    directoryName: 'SOME_REF_VALUE',
    limit: 'SOME_REF_VALUE',
    marker: 'SOME_REF_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve all directories of a container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/directories',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to create a directory of a container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Request Body schema: application/json

req

directoryName
required
string

Responses

Request samples

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

This API is used to delete a directory of a container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

directory
required
string

The directory name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/directories/{directory}',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve GET tempurl of a directory. With this GET tempurl, user can use it to download one or many objects from it.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

directory
required
string

The directory name

project_id
required
string

The project id

query Parameters
expiredTime
ref
Example: expiredTime=3600

The expired time of tempURL in second

viewMode
ref
Example: viewMode=view|download

View or download with tempURL

Responses

Request samples

const request = require('request');

const options = {
  method: 'POST',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/directories/{directory}/download_tempurls',
  qs: {expiredTime: 'SOME_REF_VALUE', viewMode: 'SOME_REF_VALUE'},
  headers: {
    accept: 'application/json',
    'content-type': '*/*',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

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

  console.log(body);
});

This API is used to retrieve PUT tempurl of a directory. With this PUT tempurl, user can use it to upload one or many objects to it.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

directory
required
string

The directory name

project_id
required
string

The project id

Request Body schema: application/json

req

expiredTime
required
integer <int64>

The expired time of tempURL in second

Responses

Request samples

Content type
application/json
{
  • "expiredTime": 0
}

This API is used to search by name for objects of a container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

project_id
required
string

The project id

Request Body schema: application/json

req

page
required
integer <int32>
pageSize
required
integer <int32>
searchBy
required
string

Search by name or tag

searchNameOperator
string

Search operator by name

searchText
string

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "searchBy": "name|tag",
  • "searchNameOperator": "match_prefix|match_all|match_phrase|match_wildcard|match_regex",
  • "searchText": "string"
}

This API is used to delete a object of a directory or container.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

object
required
string

The object name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/objects/{object}',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve detail information of an object.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

object
required
string

The object name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/objects/{object}/details',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve GET tempurl of a object. With these GET tempurl, then user can use them to download object.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

object
required
string

The object name

project_id
required
string

The project id

Request Body schema: application/json

req

accessKey
string

Required with URL type s3

secretKey
string

Required with URL type s3

timeExpire
required
integer <int64>

The expired time of tempURL in second

urlType
string

URL type

viewMode
string

View or download with tempURL

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "secretKey": "string",
  • "timeExpire": 0,
  • "urlType": "swift|s3",
  • "viewMode": "view|download"
}

This API is used to retrieve metadata of an object.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

object
required
string

The object name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/objects/{object}/metadata',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to update metadata for one or more objects.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

object
required
string

The object name

project_id
required
string

The project id

Request Body schema: application/json

req

required
object

Map of metadata

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    }
}

This API is used to retrieve tag of one or more objects.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

object
required
string

The object name

project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/objects/{object}/tags',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to add tag one or more objects.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

object
required
string

The object name

project_id
required
string

The project id

Request Body schema: application/json

req

tags
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

This API is used to retrieve PUT tempurl of a object. With these PUT tempurl, then user can use them to upload object.

Authorizations:
Bearer_Token
path Parameters
container
required
string

The container name

object
required
string

The object name

project_id
required
string

The project id

Request Body schema: application/json

req

timeExpire
required
integer <int64>

The expired time of tempURL in second

Responses

Request samples

Content type
application/json
{
  • "timeExpire": 0
}

project

Project operation endpoint

This API is used to retrieve all projects of an user.

Authorizations:
Bearer_Token

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is to create a new project in a region.

Authorizations:
Bearer_Token
Request Body schema: application/json

req

archivePeriod
integer <int32>
enableAutoRenew
boolean
isPoc
boolean
projectName
required
string
projectType
required
string

Select which tier you want to set this project as

quotaInGBytes
required
integer <int64>

Determine the quota of this project

Responses

Request samples

Content type
application/json
{
  • "archivePeriod": 0,
  • "enableAutoRenew": true,
  • "isPoc": true,
  • "projectName": "string",
  • "projectType": "Gold|Instant Archive",
  • "quotaInGBytes": 0
}

This API is used to delete a project. After deleting, all containers and all objects of the project will be deleted.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve detail information of a project.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/details',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to retrieve all members of a project (list of users the project shared.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/members',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is used to update quota for a project.

Authorizations:
Bearer_Token
path Parameters
project_id
required
string

The project id

Request Body schema: application/json

req

quotaInGBytes
required
integer <int64>

Determine the new quota of this project

Responses

Request samples

Content type
application/json
{
  • "quotaInGBytes": 0
}

region

Region operation endpoint

This API is to retrieve list of regions.

Authorizations:
Bearer_Token

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/regions',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});

This API is to retrieve detail information of a region.

Authorizations:
Bearer_Token
path Parameters
region_id
required
string

The region id

Responses

Request samples

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://hcm03-api.vstorage.vngcloud.vn/api/v1/regions/{region_id}',
  headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'}
};

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

  console.log(body);
});