1.4.6 • Published 3 years ago

rl-cloud-api-sdk v1.4.6

Weekly downloads
1
License
BSD-3-Clause
Repository
github
Last release
3 years ago

About

This NodeJS module is an SDK for the Redis Cloud REST API. You can use this module to develop againts Redis Cloud REST API.

Quick Start

Install the module

Run the following command in your terminal:

npm i rl-cloud-api-sdk

Initialize the module

To start using to API you first need to enable it and generate your API keys. You can follow the instructions here.

It is recommended not to save your API secrets inside your code.

This is how you create a client:

const client = new CloudAPISDK({
    accessKey: 'API access key',
    secretKey: 'API secret key',
});

This is how you call a specific API:

//basic usage
const accountInformation = await client.getAccountInformation();

Existing functions vs API Endpoints

SectionFunctionAPI endpointUsage
AccountgetAccountInformation/await client.getAccountInformation()
AccountgetDataPersistences/data-persistenceawait client.getDataPersistence()
AccountgetDatabaseModules/database-modulesawait client.getDatabasesModules()
AccountgetSystemLogs/logs?limit=1&offset=3await client.getSystemLogs(1, 3)
AccountgetPaymentMethods/payment-methodsawait client.getPaymentMethods()
AccountgetPlans/plans?provider=AWSawait client.getPlans('AWS')
AccountgetRegions/regions?provider=AWSawait client.getRegions('AWS')
SusbscriptionsgetSubscriptions/subscriptionsawait client.getSubscriptions()
SusbscriptionscreateSubscription/subscriptionsawait client.createSubscription({name: 'sub1', ....})
SusbscriptionsgetSubscription/subscriptions/1await client.updateSubscription(1, {name: 'sub1'...})
SusbscriptionsupdateSubscription/subscriptions/1await client.updateSubscription(1, {name: 'sub1'...})
SusbscriptionsdeleteSubscription/subscriptions/1await client.deleteSubscription(1)
SusbscriptionsgetSubscriptionCidrWhitelist/subscriptions/1/cidrawait client.getSubscriptionCidrWhitelist(1)
SusbscriptionsupdateSubscriptionCidrWhitelists/subscriptions/1/cidrawait client.updateSubscriptionCidrWhitelists(1, {cidrIps: [...], ..})
SusbscriptionsgetVpcPeerings/subscriptions/1/peeringsawait client.getVpcPeerings(1)
SusbscriptionscreateSubscriptionVpcPeering/subscriptions/1/peeringsawait client.createSubscriptionVpcPeering(1, {region: 'us-east-1',...})
SusbscriptionsdeleteSubscriptionVpcPeering/subscriptions/1/peerings/1await client.deleteSubscriptionVpcPeering(1, 1)
DatabasesgetDatabases/subscriptions/1/databasesawait client.getDatabases()
DatabasescreateDatabase/subscriptions/1/databasesawait client.createDatabase(1, {name: 'db1', ..})
DatabasesgetDatabase/subscriptions/1/databases/1await client.getDatabase(1, 1)
DatabasesupdateDatabase/subscriptions/1/databases/1await client.updateDatabase(1, 1, {name: 'db2', ..})
DatabasesdeleteDatabase/subscriptions/1/databases/1await client.deleteDatabase(1, 1)
DatabasesbackupDatabase/subscriptions/1/databases/1/backupawait client.backupDatabase(1, 1)
DatabasesimportIntoDatabase/subscriptions/1/databases/1/importawait client.importIntoDatabase(1, 1, {importFromUri: 's3://...'})
Cloud AccountsgetCloudAccounts/cloud-accountsawait client.getCloudAccounts()
Cloud AccountscreateCloudAccount/cloud-accoutsawait client.createCloudAccount({name: 'c1'...})
Cloud AccountsgetCloudAccount/cloud-accounts/1await client.getCloudAccount(1)
Cloud AccountsupdateCloudAccount/cloud-accounts/1await client.updateCloudAccount(1)
Cloud AccountsdeleteCloudAccount/cloud-accounts/1await client.deleteCloudAccount(1)
TasksgetTasks/tasksawait client.getTasks()
TasksgetTask/tasks/1await client.getTask()

You can find the API documentation here

Unit testing

1.4.6

3 years ago

1.4.5

3 years ago

1.4.4

3 years ago

1.4.3

3 years ago

1.4.2

3 years ago

1.4.1

3 years ago

1.4.0

3 years ago

1.3.9

3 years ago

1.3.8

3 years ago

1.3.7

3 years ago

1.3.6

3 years ago

1.3.5

3 years ago

1.3.4

3 years ago

1.3.3

3 years ago

1.3.2

3 years ago

1.3.1

3 years ago

1.2.8

3 years ago

1.2.7

3 years ago

1.2.6

3 years ago

1.3.0

3 years ago

1.2.9

3 years ago

1.2.5

3 years ago

1.2.4

3 years ago

1.2.3

3 years ago

1.2.2

3 years ago

1.2.0

3 years ago

1.1.9

3 years ago

1.2.1

3 years ago

1.1.8

3 years ago

1.1.7

3 years ago

1.1.6

3 years ago

1.1.5

3 years ago

1.1.4

3 years ago

1.1.3

3 years ago

1.1.2

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago