{"id":24540803,"url":"https://github.com/code-gio/cloudways-js-client","last_synced_at":"2025-10-24T07:38:08.918Z","repository":{"id":177641186,"uuid":"660501586","full_name":"code-gio/cloudways-js-client","owner":"code-gio","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-15T20:20:22.000Z","size":253,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-18T11:35:12.303Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://svelte-profile.codegio.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/code-gio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-30T06:42:26.000Z","updated_at":"2024-12-30T07:03:32.000Z","dependencies_parsed_at":"2024-03-05T20:45:08.627Z","dependency_job_id":"a87f495f-f908-4834-bf3c-6a7890b71565","html_url":"https://github.com/code-gio/cloudways-js-client","commit_stats":null,"previous_names":["code-gio/cloudways-js-client"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/code-gio/cloudways-js-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fcloudways-js-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fcloudways-js-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fcloudways-js-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fcloudways-js-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-gio","download_url":"https://codeload.github.com/code-gio/cloudways-js-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fcloudways-js-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259302507,"owners_count":22837155,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-22T18:14:56.622Z","updated_at":"2025-10-24T07:38:08.841Z","avatar_url":"https://github.com/code-gio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1\u003eCloudways JS Client\u003c/h1\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://badge.fury.io/js/cloudways-js-client\"\u003e\u003cimg src=\"https://badge.fury.io/js/cloudways-js-client.svg\" alt=\"npm version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg\" alt=\"License\"\u003e\u003c/a\u003e\n  \u003cspan\u003e\u003cimg src=\"https://img.shields.io/badge/TypeScript-Ready-blue\" alt=\"TypeScript Ready\"\u003e\u003c/span\u003e\n\u003c/p\u003e\n\n\u003ch2\u003eDescription\u003c/h2\u003e\n\n\u003cp\u003e\n  Cloudways JS Client is a \u003cstrong\u003eTypeScript-based\u003c/strong\u003e client library that allows you to power your applications with the Cloudways API.\n  It provides a convenient and strongly-typed way to interact with the Cloudways API, enabling you to manage servers, perform automation,\n  and integrate Cloudways functionality into your web applications.\n\u003c/p\u003e\n\n\u003ch2\u003e🚧 Under Development 🚧\u003c/h2\u003e\n\n\u003cp\u003e\nPlease note that this library is still under development. Although it's functional and can be used, some features might be incomplete or subject to changes.\n\u003c/p\u003e\n\n\u003ch2\u003eFeatures\u003c/h2\u003e\n\n\u003cul\u003e\n  \u003cli\u003eEasy-to-use client library for the Cloudways API.\u003c/li\u003e\n  \u003cli\u003eSimplifies server management and web app integration.\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003eBuilt with TypeScript\u003c/strong\u003e for improved type safety and development experience.\u003c/li\u003e\n  \u003cli\u003eComprehensive documentation and code examples, including JSDoc comments.\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003ch2\u003eInstallation\u003c/h2\u003e\n\n\u003cp\u003eYou can install the package via npm:\u003c/p\u003e\n\n\u003cpre\u003e\u003ccode\u003enpm install cloudways-js-client\n\u003c/code\u003e\u003c/pre\u003e\n\n\u003ch2\u003eUsage\u003c/h2\u003e\n\n\u003cp\u003eThe Cloudways JS Client library makes it easy to interact with the Cloudways API for various operations. Below are some examples to help you get started.\u003c/p\u003e  \u003ch3\u003eInitializing the API\u003c/h3\u003e\n\u003cp\u003eBefore performing any operations, initialize the API with your Cloudways account credentials:\u003c/p\u003e\n  \n```javascript\nimport { initializeCloudwaysApi } from 'cloudways-js-client';\n\nconst email = 'your_email@example.com'; // Replace with your Cloudways account email\nconst apiKey = 'your_api_key'; // Replace with your Cloudways API key\n\ninitializeCloudwaysApi(email, apiKey);\n```\n \u003ch3\u003eDeleting a Server\u003c/h3\u003e\n \u003cp\u003eTo delete a server, use the \u003ccode\u003edeleteServer\u003c/code\u003e function. Ensure you have the correct server ID:\u003c/p\u003e\n\n```javascript\nimport { deleteServer } from \"cloudways-js-client\";\n\nasync function deleteServerA() {\n  const serverId = 12345; // Replace with the server ID you want to delete\n  await deleteServer(serverId);\n  console.log(\"Server deleted successfully.\");\n}\n```\n\n  \u003ch3\u003eGetting the List of Servers\u003c/h3\u003e\n   \u003cp\u003eYou can retrieve the list of servers associated with your account using the \u003ccode\u003egetServersList\u003c/code\u003e function:\u003c/p\u003e\n\n```javascript\nimport { getServersList } from \"cloudways-js-client\";\n\nasync function listServers() {\n  try {\n    const servers = await getServersList();\n    console.log(\"Servers List:\", servers);\n  } catch (error) {\n    console.error(\"Error fetching servers list:\", error);\n  }\n}\n\nlistServers();\n```\n\n\u003ch3\u003eCombining Operations\u003c/h3\u003e\n\u003cp\u003eYou can combine these functions to perform multiple operations. For example, to delete a server and then get the updated list of servers:\u003c/p\u003e\n\n```javascript\nasync function deleteServerAndGetList() {\n  const serverId = 12345; // Replace with the server ID to delete\n  await deleteServer(serverId);\n  console.log(\"Server deleted successfully.\");\n  console.log(\"Updated Servers List:\", await getServersList());\n}\n\ndeleteServerAndGetList();\n```\n\n\u003ch2\u003eIssues\u003c/h2\u003e\n\n\u003cp\u003eIf you find any issues or have any feature requests, please open an \u003ca href=\"https://github.com/code-gio/cloudways-js-client/issues\"\u003eissue\u003c/a\u003e on GitHub.\u003c/p\u003e\n\n\u003ch2\u003eLicense\u003c/h2\u003e\n\n\u003cp\u003eThis project is open source and available under the \u003ca href=\"https://opensource.org/licenses/MIT\"\u003eMIT License\u003c/a\u003e.\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-gio%2Fcloudways-js-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-gio%2Fcloudways-js-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-gio%2Fcloudways-js-client/lists"}