search
edgegap.comCommunity DiscordDashboard

Application

hashtag
What Is an Application on Edgegap

An application is what you make deployments with. At its core, an application only contains a few options. Most of the configurations and settings are created in the version.

circle-check

Applications are made to regroup multiple versions. A good rule of thumb is to create an application per game title or application.

hashtag
What You Can Configure in Your Application

name: The name of your application. It must be unique since it will be used in your deployment request.

is_active: If the application can be deployed. If is_active is false, the application cannot be deployed and will result in an errored deployment.

image: A base64 string of your application image (logo, icon, etc). You need to use a small sized image otherwise you won't be able to create the application.

circle-info

The field image is the logo associated with your application. It will be displayed in the Edgegap dashboard. When using the image converter, you will need to remove the `data:image/png;base64,` part. This is completely unrelated to the container image.

hashtag
Create an Application

hashtag
With the API

To automate this process, first, we have to get our API token. You have to generate a POST request to Edgegap to the following path.

circle-info

API Endpoint https://api.edgegap.com/v1/app

Include your API Token in your Headers like this:

{
  "Content-Type": "application/json",
  "Authorization": "token super_secret_bearer_token_1234"
}

REST payload example

Sending The Request

The response will follow this format:

hashtag
With the Dashboard

Creating an application from the dashboard is very simple. You just need to click on the "Create Application" button on the top right corner of the page. A modal will appear and you will be able to fill the form with the application's information.

You can check the API Reference for more details on the other available operations.

Last updated

Was this helpful?