Class ApplicationApi

create a server

Create a new database

POST /api/application/servers/{id}/databases

Create a new user

Example

import { api } from "./ApplicationApi.example";

// create a user

const userData = {
    email: "test@example.com", // email of the user
    username: "test", // username of the user
    first_name: "test", // first name of the user
    last_name: "example", // last name of the User
    password: "example" // (optional) password of the user
}
api.createUser(userData).then(data => {
    console.log(data) // log the output
})
.catch(err => {
    console.error(err) // log error if occurs
})
Copy

Delete a server

DELETE /api/application/servers/{id}

delete a database from server

DELETE /api/application/servers/{id}/databases/{dbID}

Delete a user by ID

Example

import { api } from "./ApplicationApi.example";

api.deleteUser(1 /* user id */).then(data => {
    if(data) {
        console.log("user 1 deleted successfully")
    } else {
        console.error("failed to delete user 1")
    }
}).catch(err => {
    console.error("error deleting user 1", err)
})
Copy

get a egg

get all eggs

get all nests

Get all Servers

Get all users from panel

Example

import { api } from "./ApplicationApi.example" // import the class from the file

// fetch all users from panel
api.getAllUser().then(data => {
    console.log(data) // log output data
}).catch(err => {
    console.error(err) // log error if occurs 
})
Copy

get a nest

Retrieve detailed information about a specific server.

Get a user by email

Example

import { api } from "./ApplicationApi.example" // import the class from the file

// fetch user by there email from panel
api.getAUserByEmail("test@example.com").then(data => {
    console.log(data) // log output data
}).catch(err => {
    console.error(err) // log error if occurs 
})
Copy

Get a user by ID

Example

import { api } from "./ApplicationApi.example";

// get a user by there id from panel
api
  .getAUserById(1)
  .then((data) => console.log(data) /*Log the data*/)
  .catch((err) => console.error(err) /*log if any error occurs */);

Copy

Get a user by username

Example

import { api } from "./ApplicationApi.example";

// get a user by there username from panel
api
  .getAUserByUsername("example")
  .then((data) => console.log(data) /*Log the data*/)
  .catch((err) => console.error(err) /*log if any error occurs */);

Copy

get a server's database details

GET /api/application/servers/{id}/databases/{dbId}

get corresponding server databases

GET /api/application/servers/{id}/databases

Reinstall the corresponding server

POST /api/application/servers/{id}/reinstall

Suspend a server

Remove suspension from a server to allow it to start.

Update Server Build Configuration Update server resource limits and feature limits.

PATCH /api/application/servers/{server}/build

update server database details

PATCH /api/application/servers/{id}/databases/{dbID}

Updates a server's details via the panel API.

Updates server start up settings

PATCH /api/application/servers/{id}/startup

Update a user

Example

import { api } from "./ApplicationApi.example";

// update a user details

const updatedData = {
  // data to be updated
  first_name: "example",
};

api
  .updateUser(
    1, // user id
    updatedData
  )
  .then((data) => console.log(data))
  .catch((err) => {
    console.log(err);
  });

Copy