{"id":19272346,"url":"https://github.com/sdslabs/gasper-api-client","last_synced_at":"2026-06-10T20:31:07.936Z","repository":{"id":56095445,"uuid":"218118410","full_name":"sdslabs/Gasper-API-Client","owner":"sdslabs","description":"API Client for Gasper in javascript","archived":false,"fork":false,"pushed_at":"2020-12-14T06:58:58.000Z","size":210,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-23T20:32:06.235Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/sdslabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-28T18:32:15.000Z","updated_at":"2020-11-25T16:41:10.000Z","dependencies_parsed_at":"2022-08-15T13:01:11.889Z","dependency_job_id":null,"html_url":"https://github.com/sdslabs/Gasper-API-Client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sdslabs/Gasper-API-Client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdslabs%2FGasper-API-Client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdslabs%2FGasper-API-Client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdslabs%2FGasper-API-Client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdslabs%2FGasper-API-Client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sdslabs","download_url":"https://codeload.github.com/sdslabs/Gasper-API-Client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdslabs%2FGasper-API-Client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34170162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2024-11-09T20:36:22.343Z","updated_at":"2026-06-10T20:31:07.919Z","avatar_url":"https://github.com/sdslabs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gasper_kaze_api\n\nGasperKazeApi - JavaScript client for gasper_kaze_api\nHandles authentication, creation/management of applications, databases, users and also provides a superuser API. \u003cbr\u003e\u003cbr\u003e Only a superuser can avail the superuser API. A superuser can **grant/revoke** superuser privileges to other users. A default  superuser is created every time a Gasper instance is launched whose credentials are defined in the `admin` section of `config.toml`, the main configuration file. A sample configuration file is available [here](https://github.com/sdslabs/gasper/blob/develop/config.sample.toml#L37).\u003cbr\u003e\u003cbr\u003e **Note:-** Normally the applications and databases can only be managed by their owners but the superuser can bypass that check.\u003cbr\u003e\u003cbr\u003e **PS:-** If you want to programmatically generate a client for this API, you can find the corresponding OpenAPI specifications [here](https://github.com/sdslabs/gasper/tree/develop/docs/content/api/specs). We recommend using [OpenAPI-Generator](https://openapi-generator.tech/) for generating clients.\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0\n- Package version: 1.0\n- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen\nFor more information, please visit [https://chat.sdslabs.co](https://chat.sdslabs.co)\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nTo publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in [\"Publishing npm packages\"](https://docs.npmjs.com/getting-started/publishing-npm-packages).\n\nThen install it via:\n\n```shell\nnpm install gasper_kaze_api --save\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n##### Local development\n\nTo use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nTo use the link you just defined in your project, switch to the directory you want to use your gasper_kaze_api from, and run:\n\n```shell\nnpm link /path/to/\u003cJAVASCRIPT_CLIENT_DIR\u003e\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n#### git\n\nIf the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID\nthen install it via:\n\n```shell\n    npm install GIT_USER_ID/GIT_REPO_ID --save\n```\n\n### For browser\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/). After following\nthe above steps with Node.js and installing browserify with `npm install -g browserify`,\nperform the following (assuming *main.js* is your entry file):\n\n```shell\nbrowserify main.js \u003e bundle.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar GasperKazeApi = require('gasper_kaze_api');\n\nvar defaultClient = GasperKazeApi.ApiClient.instance;\n// Configure Bearer (JWT) access token for authorization: bearerAuth\nvar bearerAuth = defaultClient.authentications['bearerAuth'];\nbearerAuth.accessToken = \"YOUR ACCESS TOKEN\"\n\nvar api = new GasperKazeApi.AdminApi()\nvar authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9; // {String} Bearer Token Authentication\nvar app = \"app_example\"; // {String} The name of the application\napi.deleteAppByAdmin(authorization, app).then(function(data) {\n  console.log('API called successfully. Returned data: ' + data);\n}, function(error) {\n  console.error(error);\n});\n\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:3000*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*GasperKazeApi.AdminApi* | [**deleteAppByAdmin**](docs/AdminApi.md#deleteAppByAdmin) | **DELETE** /admin/apps/{app} | Delete an application\n*GasperKazeApi.AdminApi* | [**deleteDbByAdmin**](docs/AdminApi.md#deleteDbByAdmin) | **DELETE** /admin/dbs/{db} | Delete a single database\n*GasperKazeApi.AdminApi* | [**deleteUserByAdmin**](docs/AdminApi.md#deleteUserByAdmin) | **DELETE** /admin/users/{userEmail} | Delete a single user\n*GasperKazeApi.AdminApi* | [**fetchAppByAdmin**](docs/AdminApi.md#fetchAppByAdmin) | **GET** /admin/apps/{app} | Fetch a single application\n*GasperKazeApi.AdminApi* | [**fetchAppsByAdmin**](docs/AdminApi.md#fetchAppsByAdmin) | **GET** /admin/apps | Fetch all applications with/without a filter defined by query params\n*GasperKazeApi.AdminApi* | [**fetchDbByAdmin**](docs/AdminApi.md#fetchDbByAdmin) | **GET** /admin/dbs/{db} | Fetch a single database\n*GasperKazeApi.AdminApi* | [**fetchDbsByAdmin**](docs/AdminApi.md#fetchDbsByAdmin) | **GET** /admin/dbs | Fetch all databases with/without a filter defined by query params\n*GasperKazeApi.AdminApi* | [**fetchNodeByAdmin**](docs/AdminApi.md#fetchNodeByAdmin) | **GET** /admin/nodes/{type} | Fetch bind addresses(IP:Port) of a single microservice on all nodes\n*GasperKazeApi.AdminApi* | [**fetchNodesByAdmin**](docs/AdminApi.md#fetchNodesByAdmin) | **GET** /admin/nodes | Fetch bind addresses(IP:Port) of all microservices on all nodes\n*GasperKazeApi.AdminApi* | [**fetchUserByAdmin**](docs/AdminApi.md#fetchUserByAdmin) | **GET** /admin/users/{userEmail} | Fetch a single user\n*GasperKazeApi.AdminApi* | [**fetchUsersByAdmin**](docs/AdminApi.md#fetchUsersByAdmin) | **GET** /admin/users | Fetch all users with/without a filter defined by query params\n*GasperKazeApi.AdminApi* | [**grantSuperuserPrivilege**](docs/AdminApi.md#grantSuperuserPrivilege) | **PATCH** /admin/users/{userEmail}/grant | Grant superuser privileges to a single user\n*GasperKazeApi.AdminApi* | [**revokeSuperuserPrivilege**](docs/AdminApi.md#revokeSuperuserPrivilege) | **PATCH** /admin/users/{userEmail}/revoke | Revoke superuser privileges from a single user\n*GasperKazeApi.AppsApi* | [**createApp**](docs/AppsApi.md#createApp) | **POST** /apps/{language} | Create an application\n*GasperKazeApi.AppsApi* | [**deleteAppByUser**](docs/AppsApi.md#deleteAppByUser) | **DELETE** /apps/{app} | Delete an application owned by a user\n*GasperKazeApi.AppsApi* | [**fetchAppByUser**](docs/AppsApi.md#fetchAppByUser) | **GET** /apps/{app} | Fetch a single application owned by a user\n*GasperKazeApi.AppsApi* | [**fetchAppsByUser**](docs/AppsApi.md#fetchAppsByUser) | **GET** /apps | Fetch all applications owned by a user\n*GasperKazeApi.AppsApi* | [**fetchLogsByUser**](docs/AppsApi.md#fetchLogsByUser) | **GET** /apps/{app}/logs | Fetch logs of an application\n*GasperKazeApi.AppsApi* | [**fetchMetricsByUser**](docs/AppsApi.md#fetchMetricsByUser) | **GET** /apps/{app}/metrics | Fetch metrics of an application\n*GasperKazeApi.AppsApi* | [**fetchTerminalByUser**](docs/AppsApi.md#fetchTerminalByUser) | **GET** /apps/{app}/term | Fetch a browser terminal instance for an application owned by a user\n*GasperKazeApi.AppsApi* | [**rebuildAppByUser**](docs/AppsApi.md#rebuildAppByUser) | **PATCH** /apps/{app}/rebuild | Rebuild an application\n*GasperKazeApi.AppsApi* | [**transferAppByUser**](docs/AppsApi.md#transferAppByUser) | **PATCH** /apps/{app}/transfer/{userEmail} | Transfer ownership of an application to another user\n*GasperKazeApi.AppsApi* | [**updateAppByUser**](docs/AppsApi.md#updateAppByUser) | **PUT** /apps/{app} | Update an application owned by a user\n*GasperKazeApi.AuthApi* | [**login**](docs/AuthApi.md#login) | **POST** /auth/login | Login to get a Bearer token\n*GasperKazeApi.AuthApi* | [**refresh**](docs/AuthApi.md#refresh) | **GET** /auth/refresh | Refresh JWT token using existing token\n*GasperKazeApi.AuthApi* | [**register**](docs/AuthApi.md#register) | **POST** /auth/register | Register a user\n*GasperKazeApi.DbsApi* | [**createDB**](docs/DbsApi.md#createDB) | **POST** /dbs/{databaseType} | Create a database\n*GasperKazeApi.DbsApi* | [**deleteDbByUser**](docs/DbsApi.md#deleteDbByUser) | **DELETE** /dbs/{db} | Delete a single database owned by a user\n*GasperKazeApi.DbsApi* | [**fetchDbByUser**](docs/DbsApi.md#fetchDbByUser) | **GET** /dbs/{db} | Fetch a single database owned by a user\n*GasperKazeApi.DbsApi* | [**fetchDbsByUser**](docs/DbsApi.md#fetchDbsByUser) | **GET** /dbs | Fetch all databases owned by a user\n*GasperKazeApi.DbsApi* | [**transferDbByUser**](docs/DbsApi.md#transferDbByUser) | **PATCH** /dbs/{db}/transfer/{userEmail} | Transfer ownership of a database to another user\n*GasperKazeApi.UserApi* | [**deleteUser**](docs/UserApi.md#deleteUser) | **DELETE** /user | Delete user\n*GasperKazeApi.UserApi* | [**fetchUser**](docs/UserApi.md#fetchUser) | **GET** /user | Fetch logged in user\u0026#39;s info\n*GasperKazeApi.UserApi* | [**updatePassword**](docs/UserApi.md#updatePassword) | **PUT** /user/password | Update the password of the logged in user\n\n\n## Documentation for Models\n\n - [GasperKazeApi.Application](docs/Application.md)\n - [GasperKazeApi.Context](docs/Context.md)\n - [GasperKazeApi.CreatedApplication](docs/CreatedApplication.md)\n - [GasperKazeApi.CreatedDatabase](docs/CreatedDatabase.md)\n - [GasperKazeApi.CreatedUser](docs/CreatedUser.md)\n - [GasperKazeApi.Database](docs/Database.md)\n - [GasperKazeApi.Git](docs/Git.md)\n - [GasperKazeApi.InlineObject](docs/InlineObject.md)\n - [GasperKazeApi.InlineResponse200](docs/InlineResponse200.md)\n - [GasperKazeApi.InlineResponse2001](docs/InlineResponse2001.md)\n - [GasperKazeApi.InlineResponse20010](docs/InlineResponse20010.md)\n - [GasperKazeApi.InlineResponse20011](docs/InlineResponse20011.md)\n - [GasperKazeApi.InlineResponse20012](docs/InlineResponse20012.md)\n - [GasperKazeApi.InlineResponse20013](docs/InlineResponse20013.md)\n - [GasperKazeApi.InlineResponse20014](docs/InlineResponse20014.md)\n - [GasperKazeApi.InlineResponse2001Resources](docs/InlineResponse2001Resources.md)\n - [GasperKazeApi.InlineResponse2002](docs/InlineResponse2002.md)\n - [GasperKazeApi.InlineResponse2003](docs/InlineResponse2003.md)\n - [GasperKazeApi.InlineResponse2004](docs/InlineResponse2004.md)\n - [GasperKazeApi.InlineResponse2005](docs/InlineResponse2005.md)\n - [GasperKazeApi.InlineResponse2006](docs/InlineResponse2006.md)\n - [GasperKazeApi.InlineResponse2007](docs/InlineResponse2007.md)\n - [GasperKazeApi.InlineResponse2008](docs/InlineResponse2008.md)\n - [GasperKazeApi.InlineResponse2009](docs/InlineResponse2009.md)\n - [GasperKazeApi.InlineResponse400](docs/InlineResponse400.md)\n - [GasperKazeApi.InlineResponse401](docs/InlineResponse401.md)\n - [GasperKazeApi.InlineResponse500](docs/InlineResponse500.md)\n - [GasperKazeApi.Login](docs/Login.md)\n - [GasperKazeApi.LoginResponse](docs/LoginResponse.md)\n - [GasperKazeApi.Metrics](docs/Metrics.md)\n - [GasperKazeApi.User](docs/User.md)\n\n\n## Documentation for Authorization\n\n\n\n### bearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdslabs%2Fgasper-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdslabs%2Fgasper-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdslabs%2Fgasper-api-client/lists"}