Download OpenAPI specification:Download
VNG Cloud Container Registry service.
Region endpoints
| repoId required | string The repo id |
| imageName required | string imageName |
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D/images/artifacts', qs: { imageName: 'SOME_STRING_VALUE', name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoId required | string The repo id |
| digest required | string digest |
| imageName required | string imageName |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'DELETE', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D/images/artifacts/delete', qs: {digest: 'SOME_STRING_VALUE', imageName: 'SOME_STRING_VALUE'}, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoId required | string The repo id |
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D/images', qs: { name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoId required | string The repo id |
| imageName required | string imageName |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'DELETE', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D/images/delete', qs: {imageName: 'SOME_STRING_VALUE'}, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoId required | string The repo id |
| imageName required | string imageName |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D/images/detail', qs: {imageName: 'SOME_STRING_VALUE'}, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Manages vCR Repositories: create, list, get, delete, update quota, attach/detach Repository Users, and read per-repository usage history.
| accessLevel | string accessLevel |
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/repository', qs: { accessLevel: 'SOME_STRING_VALUE', name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| Authorization required | string Access Token |
createRepoRequest
| isPublic required | boolean Access level of project |
| quotaLimit required | integer <int32> Quota limit of project, unit: GB |
| repoName required | string Name of project |
{- "isPublic": true,
- "quotaLimit": 20,
- "repoName": "network-interface"
}| repoId required | string The repo id |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoId required | string The repository id |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'DELETE', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoId required | string The repo id |
| Authorization required | string Access Token |
request
| repoId required | string Repository Uuid |
required | Array of objects (RepoUserPermissionRequest) Repository User list |
{- "repoId": 20,
- "repoUserList": 20
}| repoId required | string The repo id |
| Authorization required | string Access Token |
request
| repoId required | string Repository Uuid |
| repoUserUuidList required | Array of strings Repository User list |
{- "repoId": 20,
- "repoUserUuidList": 20
}| repoId required | string The repo id |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D/history', qs: {page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE'}, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoId required | string The repo id |
| Authorization required | string Access Token |
request
| quotaLimit required | integer <int32> Quota limit of project, unit: GB |
| repoId required | string Uuid of repository |
{- "quotaLimit": 20,
- "repoId": "repo-02c6851e-2427-4cc3-938b-db0fe5f5b184"
}| repoId required | string The repo id |
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/repository/%7BrepoId%7D/user', qs: { name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Manages vCR Repository Users used for docker login: list, create, update permissions, regenerate secret key, and remove.
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/user', qs: { name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| Authorization required | string Access Token |
request
| description | string Description of Repository User |
| duration | integer <int32> The duration of the Repo User in days |
| name required | string Name of Repository User |
required | Array of objects (RepoPermissionRequest) Permission list |
{- "description": "network-interface",
- "duration": true,
- "name": "network-interface",
- "permissionRequestList": 20
}const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/user/permissions', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoUserId required | string The repository user id |
| Authorization required | string Access Token |
request
| description | string Description of Repository User |
| duration | integer <int32> The duration of the Repo User in days |
| repoUserId required | string Repository User Id |
{- "description": "network-interface",
- "duration": true,
- "repoUserId": "ra-08b64fae-2a04-49c9-a396-53d4af3a818f"
}| repoUserId required | string The repository user id |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'DELETE', url: 'https://vcr.api.vngcloud.vn/v1/user/%7BrepoUserId%7D', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoUserId required | string The repository user id |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'PUT', url: 'https://vcr.api.vngcloud.vn/v1/user/%7BrepoUserId%7D/disable', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoUserId required | string The repository user id |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'PUT', url: 'https://vcr.api.vngcloud.vn/v1/user/%7BrepoUserId%7D/enable', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| repoUserId required | string The repository user id |
| Authorization required | string Access Token |
request
required | Array of objects (RepoPermissionRequest) Permission list |
| repoUserId required | string Repository User Id |
{- "permissionRequestList": 20,
- "repoUserId": "ra-08b64fae-2a04-49c9-a396-53d4af3a818f"
}| repoUserId required | string The repository user id |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'https://vcr.api.vngcloud.vn/v1/user/%7BrepoUserId%7D/refresh', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });