{"_id":"@apihawk/acronis-sdk","name":"@apihawk/acronis-sdk","dist-tags":{"latest":"2.0.2"},"versions":{"2.0.2":{"name":"@apihawk/acronis-sdk","version":"2.0.2","description":"Acronis REST API client","main":"lib/index.js","types":"lib/index.d.ts","scripts":{"test":"jest","lint":"tslint -p tsconfig.json","build":"tsc","watch":"tsc --watch --incremental","prepare":"npm run build","preversion":"npm run lint","version":"git add -A src","postversion":"git push && git push --tags"},"repository":{"type":"git","url":"git@git.apihawk.tech:billia-frontend/apihawk-private/acronis-sdk.git"},"keywords":["Acronis","Acronis Cloud","Acronis Backup"],"author":{"name":"Tsvetan Ganev","email":"ts.ganev@apihawk.com"},"license":"MIT","devDependencies":{"@types/debug":"^4.1.5","@types/jest":"24.0.23","@types/md5":"2.1.33","@types/nock":"10.0.3","@types/node":"12.6.8","@types/qs":"6.5.3","husky":"^4.2.3","jest":"24.8.0","ncp":"2.0.0","nock":"~10.0.6","ts-jest":"24.0.2","ts-node":"^8.6.2","tslint":"5.18.0","typescript":"3.4.5"},"dependencies":{"axios":"~0.19.2","debug":"~4.1.1","qs":"~6.7.0"},"gitHead":"e484ec9b61add056ec956ca92beb6f5d9f83453b","_id":"@apihawk/acronis-sdk@2.0.2","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-/N52QElYG8VR3r2xihvqaK9vFDkQ2oFPMmdQ69+xlLVi6Kgmq2vO39Fm6gDM/KfQYrPFX1l7rHf8kmBVBR97UQ==","shasum":"5a5f194aaafd9dff27e832c29f51c451d832997f","tarball":"https://registry.npmjs.org/@apihawk/acronis-sdk/-/acronis-sdk-2.0.2.tgz","fileCount":14,"unpackedSize":42903,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDB2rf9LxFT0l8KGn4HBg3aB6G4BcfeJLOfGI0ybUQKsQIhALJxzfe9tPWUKw/E7SLZ4Ra0LX89Wsd8IDhBH6cAjkuX"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj0T/UACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpMeQ//S81QVdOTxGVa8NsmyD2GWO8sXdfRI7XMXVceZ/lca7fyXjCA\r\nPcaakab30sbpq3nyVL9K4l/uMZ9G1ob3u8YjUFam4HxxAVvveJq3nP3hiotJ\r\nCvOtJhy7SG5SczcMR5fThgiPsDjubwyQDziVFapnHmVr8dYGWXrVTovsKPiW\r\nIucWq1mMvsF/p3dj0q2sULmrI0jhe0Gb81f1eHJXPjRXTs6nQtGaN4v9XJsR\r\nPtz/BdMVQKHMTkjx3ofMvb5hJFBge/KeXp9uEIjEOnVAdWnZp6W34TkM/PsZ\r\nFDmK0mzOet8O1WtbPClMAXdHdYv1Fnln/dBOAB/6rdnVHcNAVUTeouB6r97/\r\ncrK02++w9SNVpeJnZMt+ynqD8NMhqeOm58xzRsepT/LG3yuzAWvkC1tDeZEb\r\n6Eqi+5uyTPve7ZTcwT9pSRDJZzafFRXWhI3l2kXliqkZCIAG5Uvnawi5blEV\r\nuid0x6xPweCfZ5Nlb7clMOLtoelwTzrELQfb2QyZKg+68yvySwvCAwZ0Mh/z\r\n/G858BQXNAqXu0D/RTo/7sYOo4BEJU9BFzzJ6fNHj9oV3kk5Bmy2Ah3bd/QV\r\naQslYIFW6RxpgIwXO0KJXTzXkn9U7XwzShzcSh83xY+AQ9hMtbvfG/PgIcng\r\ncxBjArTtzTDZ9Nvnu6VSpDSP6pmPj6humpk=\r\n=xZGD\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"a-katsarov","email":"anton@webface.bg"},"directories":{},"maintainers":[{"name":"pavkatar","email":"p.nikolov@apihawk.com"},{"name":"palazliev","email":"palazliev@gmail.com"},{"name":"tsvetan-ganev","email":"tsvetan.ganev@hotmail.com"},{"name":"a-katsarov","email":"anton@webface.bg"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/acronis-sdk_2.0.2_1674657748468_0.26711020853504563"},"_hasShrinkwrap":false}},"time":{"created":"2023-01-25T14:42:28.389Z","2.0.2":"2023-01-25T14:42:28.662Z","modified":"2023-01-25T14:42:28.841Z"},"maintainers":[{"name":"pavkatar","email":"p.nikolov@apihawk.com"},{"name":"palazliev","email":"palazliev@gmail.com"},{"name":"tsvetan-ganev","email":"tsvetan.ganev@hotmail.com"},{"name":"a-katsarov","email":"anton@webface.bg"}],"description":"Acronis REST API client","keywords":["Acronis","Acronis Cloud","Acronis Backup"],"repository":{"type":"git","url":"git@git.apihawk.tech:billia-frontend/apihawk-private/acronis-sdk.git"},"author":{"name":"Tsvetan Ganev","email":"ts.ganev@apihawk.com"},"license":"MIT","readme":"## Acronis REST API client for Node.js\n\n## How to Install\n\n```bash\n$ npm i @apihawk-private/acronis-sdk\n```\n\n## Prerequisites\n\nIn order to use this library (and the REST API on its own), you must have a registered client application in Acronis Cloud. You need to obtain the API client ID and API client secret key for that application and provide them in the constructor.\n\n### How to register a client application\n\nYou must have an administrator account in Acronis Cloud. You will need its username and password in order to authenticate for this endpoint.\n\nHeaders:\n\n```\n> POST /api/2/clients HTTP/1.1\n> Host: eu2-cloud.acronis.com\n> Content-Type: application/json\n> Authorization: Basic base64(admin_username:admin_password)\n> Accept: application/json\n```\n\nBody:\n\n```json\n{\n \"type\": \"agent\",\n \"tenant_id\": \"\",\n \"token_endpoint_auth_method\": \"client_secret_basic\",\n \"data\": {\n \"name\": \"Billia\",\n \"company\": \"Apihawk\"\n }\n}\n```\n\nResponse:\n\n```json\n{\n \"tenant_id\": \"\",\n \"client_id\": \"\", // save this\n \"client_secret\": \"\", // save this\n \"data\": {\n \"name\": \"Billia\",\n \"company\": \"Apihawk\"\n },\n \"token_endpoint_auth_method\": \"client_secret_basic\",\n \"type\": \"agent\",\n \"client_secret_expires_at\": 0,\n \"registration_access_token\": \"\"\n}\n```\n\n## Example\n\nBasic example:\n\n```ts\nimport { AcronisClient } from '@apihawk-private/acronis-sdk';\n\n// initialize the SDK\nconst acronis = new AcronisClient({\n api: 'https://eu2-cloud.acronis.com/api/2'\n clientId: '',\n clientSecret: ''\n});\n\n// authenticate yourself with the Acronis API server\nawait acronis.authorize();\n\n// you can now call methods which require authorization\nconst users = await acronis.User.getUsers();\nconst tenant = await acronis.Tenant.getTenantById('');\n```\n\nYou can run the example scripts which are located in the `/examples` folder in the following way:\n\n```bash\n$ npx ts-node examples/provision.ts\n```\n\nYou need to provide the following environmental variables:\n\n```bash\nexport ACRONIS_API=https://eu2-cloud.acronis.com/api/2\nexport ACRONIS_CLIENT_ID=\nexport ACRONIS_CLIENT_SECRET=\n```\n\nPlease use a test/demo account!\n\n## Test\n\nYou can run the integration tests:\n\n```bash\n$ npm test\n```\n\n## Logging\n\nYou can turn on HTTP requests logging by setting the `DEBUG` environmental variable:\n\n```bash\nexport DEBUG=acronis-sdk*\n```\n\n### Resources\n\nIt's strongly advised to get familiar with the Acronis REST API before using this library.\n\n- https://developer.acronis.com/doc/platform/management/v2/\n","readmeFilename":"README.md"}