Endpoints - SelyanSel/AppLink GitHub Wiki

💻 Endpoints


This will list every AppLink endpoint. References

LIST NOT FINISHED! FOR FULL ENDPOINTS, CHECK OUT THE CODE HERE


  • /api/openApp View in source
    description -> Opens a application on the computer, specified by it's name. Must be referenced in the appsRegistery.json.
    params -> name == the name of the app (referenced in the appsRegistery.json | pass == the password (=accessPassword , see .env)

    return | Success: {status:"ok"}
    return | Unknown app: {status:"Unknown command or app."}
    return | Failure: {status:"Unauthorized."}

  • /api/stopServer View in source
    description -> Stops the server.
    params -> pass (=accessPassword , see .env)

    return | Success: {status:"Server stopped."}
    return | Failure: {status:"Unauthorized."}

  • /api/ping View in source
    description -> Pings the server.

    return | Success: "Pong!"

  • /api/isUsingPassword View in source
    description -> Returns if the server requires password for any action.

    return | Success: "true"/"false"

  • /api/getApps View in source
    description -> Gets the available apps in a JSON format. If server requires password, you need to specify the "pass" parameter.
    params -> pass (=accessPassword , see .env)

    return | Success: {apps in json format}
    return | Failure: {status:"Unauthorized."}

More getting referenced soon.

⚠️ **GitHub.com Fallback** ⚠️