Integration

edgegap.com Dashboard

Create a New Application

Create an application that will regroup application versions.

post

/v1/app

Authorizations

Body

namestring · min: 1 · max: 64required

The application name

Example: Example App

is_activebooleanrequired

If the application can be deployed

Example: true

is_telemetry_agent_activeboolean

If the telemetry agent is installed on the versions of this app.

imagestringrequired

Image base64 string

Example: iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/app' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Example App",
    "is_active": true,
    "is_telemetry_agent_active": false,
    "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg=="
  }'

200

400

401

409

500

{
  "name": "Example App",
  "is_active": true,
  "is_telemetry_agent_active": false,
  "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==",
  "create_time": "2025-03-09 12:02:11.891819",
  "last_updated": "2025-03-09 12:02:11.891819"
}

Success

Update an Application

Update an application with new information.

patch

/v1/app/{app_name}

Authorizations

Path parameters

app_nameanyrequired

Body

namestring · min: 3 · max: 64

Application name

Example: Example App

is_activeboolean

If the application can be deployed

Example: true

is_telemetry_agent_activeboolean

If the telemetry agent is installed on the versions of this app.

imagestring

Image base64 string

Example: iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.edgegap.com//v1/app/{app_name}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Example App",
    "is_active": true,
    "is_telemetry_agent_active": false,
    "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg=="
  }'

200

400

401

404

409

500

{
  "name": "Example App",
  "is_active": true,
  "is_telemetry_agent_active": false,
  "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==",
  "create_time": "2025-03-09 12:02:11.891819",
  "last_updated": "2025-03-09 12:02:11.891819"
}

Success

Get an Application

Retrieve an application and its information.

get

/v1/app/{app_name}

Authorizations

Path parameters

app_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/app/{app_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "name": "Example App",
  "is_active": true,
  "is_telemetry_agent_active": false,
  "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==",
  "create_time": "2025-03-09 12:02:11.891819",
  "last_updated": "2025-03-09 12:02:11.891819"
}

Success

Delete an Application

Delete an application and all its current versions.

delete

/v1/app/{app_name}

Authorizations

Path parameters

app_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/app/{app_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

No body

Success

Create a New Application Version

Create an application version associated with an application. The version contains all the specifications to create a deployment.

post

/v1/app/{app_name}/version

Authorizations

Path parameters

app_nameanyrequired

The name of the application associated

Body

namestring · min: 1 · max: 64required

The Version Name

Example: v1

is_activeboolean

If the Version is active currently in the system

docker_repositorystringrequired

The Repository where the image is (i.e. 'harbor.edgegap.com' or 'docker.io')

Example: registry.edgegap.com

docker_imagestringrequired

The name of your image (i.e. 'edgegap/demo')

Example: demo

docker_tagstringrequired

The tag of your image (i.e. '0.1.2')

Example: 0.1.2

private_usernamestring

The username to access the docker repository

Example: username

private_tokenstring

The Private Password or Token of the username (We recommend to use a token)

Example: password

req_cpuinteger · min: 100required

Units of vCPU needed (1024 = 1vcpu)

Example: 256

req_memoryinteger · min: 100required

Units of memory in MB needed (1024 = 1GB)

Example: 256

req_videointeger

Units of GPU needed (1024 = 1 GPU)

Example: 256

max_durationinteger

The Max duration of the game in minute. 0 means forever.

Example: 30

use_telemetryboolean

Allow to inject ASA Variables

inject_context_envboolean

DEPRECATED - The context environment variables are now injected into all deployments by default. No changes are required. (https://docs.edgegap.com/docs/deployment/injected-variables)

whitelisting_activeboolean

ACL Protection is active

force_cacheboolean

Allow faster deployment by caching your container image in every Edge site

kindstring

The kind of the app version. Can be "session" or "non-session"

cache_min_hourinteger · max: 23

Start of the preferred interval for caching your container

cache_max_hourinteger · max: 23

End of the preferred interval for caching your container

time_to_deployinteger · min: 15

Estimated maximum time in seconds to deploy, after this time we will consider it not working and retry.

Example: 15

enable_all_locationsboolean

(Deprecated) Enable every location available. By enabling this, your request will use every potential location, including those which may require a longer time to deploy. This means that your application could take significantly more time before being ready. We do not recommend this feature for live games. This functionality does not support ACL and Caching at the moment.

session_configobject

Parameters defining the behavior of a session-based app version. If set, the app is considered to be session-based.

portsobject[]

probeobject

envsobject[]

verify_imageboolean · default: false

By enabling the verify_image option, your image infos (docker_repository, docker_image, docker_tag) will be tested.

termination_grace_period_secondsinteger · min: 5 · max: 3600

Termination grace period in seconds after the SIGTERM signal has been sent

endpoint_storagestring

The name of the endpoint storage to link

Example: my-storage

commandstring | null

Entrypoint/Command override of your Container

Example: null, "string"

argumentsstring | null

The Arguments to pass to the command

Example: null, "string"

create_timestring · date-time

The creation time of the app version

last_updatedstring · date-time

The last update time of the app version

dns_configstring

The name of the DNS config to link

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/app/{app_name}/version' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "v1",
    "is_active": true,
    "docker_repository": "registry.edgegap.com",
    "docker_image": "demo",
    "docker_tag": "0.1.2",
    "private_username": "username",
    "private_token": "password",
    "req_cpu": 256,
    "req_memory": 256,
    "req_video": 256,
    "max_duration": 30,
    "use_telemetry": true,
    "inject_context_env": true,
    "whitelisting_active": false,
    "force_cache": true,
    "kind": 0,
    "cache_min_hour": 1,
    "cache_max_hour": 1,
    "time_to_deploy": 15,
    "enable_all_locations": false,
    "session_config": {
      "kind": "Seat",
      "sockets": 10,
      "autodeploy": true,
      "empty_ttl": 60,
      "session_max_duration": 60
    },
    "ports": [
      {
        "port": 5555,
        "protocol": "TCP",
        "to_check": true,
        "tls_upgrade": false,
        "name": "Game port"
      }
    ],
    "probe": {
      "optimal_ping": 60,
      "rejected_ping": 180
    },
    "envs": [
      {
        "key": "API_KEY",
        "value": "123456",
        "is_secret": true
      }
    ],
    "verify_image": false,
    "termination_grace_period_seconds": 1,
    "endpoint_storage": "my-storage",
    "command": "null, \"string\"",
    "arguments": "null, \"string\"",
    "create_time": "2025-03-09T23:12:29.402Z",
    "last_updated": "2025-03-09T23:12:29.402Z",
    "dns_config": "text"
  }'

200

400

401

404

409

424

500

{
  "success": true,
  "version": {
    "name": "v1",
    "is_active": true,
    "docker_repository": "registry.edgegap.com",
    "docker_image": "demo",
    "docker_tag": "0.1.2",
    "private_username": "username",
    "private_token": "password",
    "req_cpu": 256,
    "req_memory": 256,
    "req_video": 256,
    "max_duration": 30,
    "use_telemetry": true,
    "inject_context_env": true,
    "whitelisting_active": false,
    "force_cache": true,
    "kind": 0,
    "cache_min_hour": 1,
    "cache_max_hour": 1,
    "time_to_deploy": 15,
    "enable_all_locations": false,
    "session_config": {
      "kind": "Seat",
      "sockets": 10,
      "autodeploy": true,
      "empty_ttl": 60,
      "session_max_duration": 60
    },
    "ports": [
      {
        "port": 5555,
        "protocol": "TCP",
        "to_check": true,
        "tls_upgrade": false,
        "name": "Game port"
      }
    ],
    "probe": {
      "optimal_ping": 60,
      "rejected_ping": 180
    },
    "envs": [
      {
        "key": "API_KEY",
        "value": "123456",
        "is_secret": true
      }
    ],
    "verify_image": false,
    "termination_grace_period_seconds": 1,
    "endpoint_storage": "my-storage",
    "command": "null, \"string\"",
    "arguments": "null, \"string\"",
    "create_time": "2025-03-09T23:12:29.402Z",
    "last_updated": "2025-03-09T23:12:29.402Z",
    "dns_config": "text"
  }
}

Success

Delete an Application Version

Delete a specific version of an application.

delete

/v1/app/{app_name}/version/{version_name}

Authorizations

Path parameters

app_nameanyrequired

The name of the application

version_nameanyrequired

The name of the application version

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/app/{app_name}/version/{version_name}' \
  --header 'authorization: YOUR_API_KEY'

200

401

404

500

{
  "success": true,
  "message": "text"
}

Success

Get an Application Version

Retrieve the specifications of an application version.

get

/v1/app/{app_name}/version/{version_name}

Authorizations

Path parameters

app_nameanyrequired

The name of the application

version_nameanyrequired

The name of the application version

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/app/{app_name}/version/{version_name}' \
  --header 'authorization: YOUR_API_KEY'

200

401

404

500

{
  "name": "v1",
  "is_active": true,
  "docker_repository": "registry.edgegap.com",
  "docker_image": "demo",
  "docker_tag": "0.1.2",
  "private_username": "username",
  "private_token": "password",
  "req_cpu": 256,
  "req_memory": 256,
  "req_video": 256,
  "max_duration": 30,
  "use_telemetry": true,
  "inject_context_env": true,
  "whitelisting_active": false,
  "force_cache": true,
  "kind": 0,
  "cache_min_hour": 1,
  "cache_max_hour": 1,
  "time_to_deploy": 15,
  "enable_all_locations": false,
  "session_config": {
    "kind": "Seat",
    "sockets": 10,
    "autodeploy": true,
    "empty_ttl": 60,
    "session_max_duration": 60
  },
  "ports": [
    {
      "port": 5555,
      "protocol": "TCP",
      "to_check": true,
      "tls_upgrade": false,
      "name": "Game port"
    }
  ],
  "probe": {
    "optimal_ping": 60,
    "rejected_ping": 180
  },
  "envs": [
    {
      "key": "API_KEY",
      "value": "123456",
      "is_secret": true
    }
  ],
  "verify_image": false,
  "termination_grace_period_seconds": 1,
  "endpoint_storage": "my-storage",
  "command": "null, \"string\"",
  "arguments": "null, \"string\"",
  "create_time": "2025-03-09T23:12:29.402Z",
  "last_updated": "2025-03-09T23:12:29.402Z",
  "dns_config": "text"
}

Success

Update an Application Version

Update an application version with new specifications.

patch

/v1/app/{app_name}/version/{version_name}

Authorizations

Path parameters

app_nameanyrequired

The name of the application

version_nameanyrequired

The name of the application version

Body

namestring · min: 1 · max: 64

The Version Name

Example: v1

is_activeboolean

If the Version is active currently in the system

docker_repositorystring

The Repository where the image is (i.e. 'harbor.edgegap.com' or 'docker.io')

Example: registry.edgegap.com

docker_imagestring

The name of your image (i.e. 'edgegap/demo')

Example: demo

docker_tagstring

The tag of your image (i.e. '0.1.2')

Example: 0.1.2

private_usernamestring

The username to access the docker repository

Example: username

private_tokenstring

The Private Password or Token of the username (We recommend to use a token)

Example: password

req_cpuinteger · min: 100

Units of vCPU needed (1024 = 1vcpu)

Example: 256

req_memoryinteger · min: 100

Units of memory in MB needed (1024 = 1GB)

Example: 256

req_videointeger

Units of GPU needed (1024= 1 GPU)

Example: 256

max_durationinteger | null

The Max duration of the game

Example: 30

use_telemetryboolean

Allow to inject ASA Variables

inject_context_envboolean

DEPRECATED - The context environment variables are now injected into all deployments by default. No changes are required. (https://docs.edgegap.com/docs/deployment/injected-variables)

whitelisting_activeboolean

ACL Protection is active

force_cacheboolean

Allow faster deployment by caching your container image in every Edge site

cache_min_hourinteger · max: 23

Start of the preferred interval for caching your container

cache_max_hourinteger · max: 23

End of the preferred interval for caching your container

time_to_deployinteger · min: 15

Estimated maximum time in seconds to deploy, after this time we will consider it not working and retry.

Example: 15

enable_all_locationsboolean

(Deprecated) Enable every location available. By enabling this, your request will use every potential location, including those which may require a longer time to deploy. This means that your application may take up to 2 minutes before being up and ready. This functionality does not support ACL and Caching at the moment.

session_configobject

Parameters defining the behavior of a session-based app version. If set, the app is considered to be session-based.

portsobject[]

probeobject

envsobject[]

termination_grace_period_secondsinteger · min: 5 · max: 3600

Termination grace period in seconds after the SIGTERM signal has been sent

verify_imageboolean · default: false

By enabling the verify_image option, your image infos (docker_repository, docker_image, docker_tag) will be tested.

endpoint_storagestring

The name of the endpoint storage to link

Example: my-storage

commandstring | null

Entrypoint/Command override of your Container

Example: null, "string"

argumentsstring | null

The Arguments to pass to the command

Example: null, "string"

dns_configstring

The name of the DNS config to link

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.edgegap.com//v1/app/{app_name}/version/{version_name}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "v1",
    "is_active": true,
    "docker_repository": "registry.edgegap.com",
    "docker_image": "demo",
    "docker_tag": "0.1.2",
    "private_username": "username",
    "private_token": "password",
    "req_cpu": 256,
    "req_memory": 256,
    "req_video": 256,
    "max_duration": 30,
    "use_telemetry": true,
    "inject_context_env": true,
    "whitelisting_active": true,
    "force_cache": true,
    "cache_min_hour": 1,
    "cache_max_hour": 1,
    "time_to_deploy": 15,
    "enable_all_locations": true,
    "session_config": {
      "kind": "Seat",
      "sockets": 10,
      "autodeploy": true,
      "empty_ttl": 60,
      "session_max_duration": 60
    },
    "ports": [
      {
        "port": 5555,
        "protocol": "TCP",
        "to_check": true,
        "tls_upgrade": false,
        "name": "Game port"
      }
    ],
    "probe": {
      "optimal_ping": 60,
      "rejected_ping": 180
    },
    "envs": [
      {
        "key": "API_KEY",
        "value": "123456",
        "is_secret": true
      }
    ],
    "termination_grace_period_seconds": 1,
    "verify_image": false,
    "endpoint_storage": "my-storage",
    "command": "null, \"string\"",
    "arguments": "null, \"string\"",
    "dns_config": "text"
  }'

200

400

401

404

424

500

{
  "success": true,
  "version": {
    "name": "v1",
    "is_active": true,
    "docker_repository": "registry.edgegap.com",
    "docker_image": "demo",
    "docker_tag": "0.1.2",
    "private_username": "username",
    "private_token": "password",
    "req_cpu": 256,
    "req_memory": 256,
    "req_video": 256,
    "max_duration": 30,
    "use_telemetry": true,
    "inject_context_env": true,
    "whitelisting_active": false,
    "force_cache": true,
    "kind": 0,
    "cache_min_hour": 1,
    "cache_max_hour": 1,
    "time_to_deploy": 15,
    "enable_all_locations": false,
    "session_config": {
      "kind": "Seat",
      "sockets": 10,
      "autodeploy": true,
      "empty_ttl": 60,
      "session_max_duration": 60
    },
    "ports": [
      {
        "port": 5555,
        "protocol": "TCP",
        "to_check": true,
        "tls_upgrade": false,
        "name": "Game port"
      }
    ],
    "probe": {
      "optimal_ping": 60,
      "rejected_ping": 180
    },
    "envs": [
      {
        "key": "API_KEY",
        "value": "123456",
        "is_secret": true
      }
    ],
    "verify_image": false,
    "termination_grace_period_seconds": 1,
    "endpoint_storage": "my-storage",
    "command": "null, \"string\"",
    "arguments": "null, \"string\"",
    "create_time": "2025-03-09T23:12:29.402Z",
    "last_updated": "2025-03-09T23:12:29.402Z",
    "dns_config": "text"
  }
}

Success

List All Versions for an Application

List all versions of a specific application.

get

/v1/app/{app_name}/versions

Authorizations

Path parameters

app_nameanyrequired

The name of the application

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/app/{app_name}/versions' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "versions": [
    {
      "name": "v1",
      "is_active": true,
      "docker_repository": "registry.edgegap.com",
      "docker_image": "demo",
      "docker_tag": "0.1.2",
      "private_username": "username",
      "private_token": "password",
      "req_cpu": 256,
      "req_memory": 256,
      "req_video": 256,
      "max_duration": 30,
      "use_telemetry": true,
      "inject_context_env": true,
      "whitelisting_active": false,
      "force_cache": true,
      "kind": 0,
      "cache_min_hour": 1,
      "cache_max_hour": 1,
      "time_to_deploy": 15,
      "enable_all_locations": false,
      "session_config": {
        "kind": "Seat",
        "sockets": 10,
        "autodeploy": true,
        "empty_ttl": 60,
        "session_max_duration": 60
      },
      "ports": [
        {
          "port": 5555,
          "protocol": "TCP",
          "to_check": true,
          "tls_upgrade": false,
          "name": "Game port"
        }
      ],
      "probe": {
        "optimal_ping": 60,
        "rejected_ping": 180
      },
      "envs": [
        {
          "key": "API_KEY",
          "value": "123456",
          "is_secret": true
        }
      ],
      "verify_image": false,
      "termination_grace_period_seconds": 1,
      "endpoint_storage": "my-storage",
      "command": "null, \"string\"",
      "arguments": "null, \"string\"",
      "create_time": "2025-03-09T23:12:29.402Z",
      "last_updated": "2025-03-09T23:12:29.402Z",
      "dns_config": "text"
    }
  ],
  "total_count": 1
}

Success

List All Applications

List all the applications that you own.

get

/v1/apps

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/apps' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

500

{
  "applications": [
    {
      "name": "Example App",
      "is_active": true,
      "is_telemetry_agent_active": false,
      "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==",
      "create_time": "2025-03-09 12:02:11.891819",
      "last_updated": "2025-03-09 12:02:11.891819"
    }
  ]
}

Success

List All Tags for a Registry Image

List all tags of a specific registry image.

get

/v1/container-registry/images/{image_name}/tags

Authorizations

Path parameters

image_nameanyrequired

The name of the image

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/container-registry/images/{image_name}/tags' \
  --header 'authorization: YOUR_API_KEY'

200

401

404

500

{
  "data": [
    {
      "tag": "tag1",
      "last_push_at": "2025-03-09T23:12:29.402Z",
      "artifact": {
        "artifact_deleted": true,
        "remaining_tags": [
          "tag1",
          "tag2"
        ],
        "image_hash": "sha256:1234567890abcdef",
        "size_mb": 1
      }
    }
  ]
}

Success

Delete Tag For a Registry Image

Delete a single tag from a artifact in the registry.

delete

/v1/container-registry/images/{image_name}/tags/{tag_name}

Authorizations

Path parameters

image_nameanyrequired

The name of the image

tag_nameanyrequired

The name of the tag

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/container-registry/images/{image_name}/tags/{tag_name}' \
  --header 'authorization: YOUR_API_KEY'

200

401

404

500

{
  "artifact": {
    "artifact_deleted": true,
    "size_mb": 1,
    "remaining_tags": [
      "text"
    ],
    "image_hash": "text"
  },
  "deleted_tag": "text"
}

Success

Create a New Endpoint Storage

Create an endpoint storage to store your container logs at the end of a deployment.

post

/v1/storage/endpoint

Authorizations

Body

namestringrequired

Name of the Endpoint Storage

Example: my-s3-bucket

access_key_idstringrequired

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

endpointstringrequired

Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain

Example: https://us-east-1.your-s3-provider.com

bucketstringrequired

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-bucket

secret_access_keystringrequired

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-secret-access

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/storage/endpoint' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "my-s3-bucket",
    "access_key_id": "my-access-key-id",
    "endpoint": "https://us-east-1.your-s3-provider.com",
    "bucket": "my-bucket",
    "secret_access_key": "my-secret-access"
  }'

200

400

401

500

{
  "name": "my-s3-bucket",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

Delete an Endpoint Storage

Delete an endpoint storage. All the application versions linked to it won't be able to store logs anymore.

delete

/v1/storage/endpoint/{endpoint_name}

Authorizations

Path parameters

endpoint_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}' \
  --header 'authorization: YOUR_API_KEY'

204

401

404

500

No body

No Content

Get an Endpoint Storage

Retrieve an endpoint storage. The secret_access_key won't be displayed.

get

/v1/storage/endpoint/{endpoint_name}

Authorizations

Path parameters

endpoint_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "name": "my-s3-endpoint",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

Update an Endpoint Storage

Update an Endpoint Storage with new specifications.

patch

/v1/storage/endpoint/{endpoint_name}

Authorizations

Path parameters

endpoint_nameanyrequired

Body

namestring

Name of the Endpoint Storage

Example: my-s3-endpoint

access_key_idstring

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

endpointstring

Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain

Example: https://us-east-1.your-s3-provider.com

bucketstring

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-bucket

secret_access_keystring

Your secret access key to connect to your S3 Bucket. Will be encrypted.

Example: my-secret-access

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "my-s3-endpoint",
    "access_key_id": "my-access-key-id",
    "endpoint": "https://us-east-1.your-s3-provider.com",
    "bucket": "my-bucket",
    "secret_access_key": "my-secret-access"
  }'

200

400

401

404

500

{
  "name": "my-s3-endpoint",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

Create a New Pull Profile

Create a pull profile. Pull profile will upload data from an endpoint storage to a deployment container on boot. You must link the application version to the pull profile first.

post

/v1/storage/endpoint/{endpoint_name}/pull-profile

Authorizations

Path parameters

endpoint_nameanyrequired

Body

namestringrequired

Name of the pull profile

Example: pull_profile_name

sourcestringrequired

Source in the S3 bucket to fetch from

Example: /my-bucket/config.cfg

source_typestring · enumrequired

If the source is a File or a Directory

Example: File

Options: File, Folder

destinationstringrequired

Destination path where your source will be uploaded in your container. Make sure to avoid protected destinations, such as /etc/, as this will prevent the files from being copied to your deployment, and will make your deployment fail. Make sure a normal user can write to the destination folder.

Example: /usr/share/configs

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}/pull-profile' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "pull_profile_name",
    "source": "/my-bucket/config.cfg",
    "source_type": "File",
    "destination": "/usr/share/configs"
  }'

200

400

401

404

500

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

Delete a Pull Profile

Delete a pull profile. All the application versions linked won't receive the data upload anymore. It will not delete your endpoint storage.

delete

/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}

Authorizations

Path parameters

endpoint_nameanyrequired

pull_profile_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}' \
  --header 'authorization: YOUR_API_KEY'

204

400

401

404

500

No body

No Content

Get a Pull Profile

Retrieve a pull profile and its specifications.

get

/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}

Authorizations

Path parameters

endpoint_nameanyrequired

pull_profile_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

Update a Pull Profile

Update a pull profile with new specifications.

patch

/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}

Authorizations

Path parameters

endpoint_nameanyrequired

pull_profile_nameanyrequired

Body

namestring

Name of the pull profile

Example: pull_profile_name

sourcestring

Source in the S3 bucket to fetch from

Example: /my-bucket/config.cfg

source_typestring · enum

If the source is a File or a Directory

Example: File

Options: File, Folder

destinationstring

Example: /usr/share/configs

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "pull_profile_name",
    "source": "/my-bucket/config.cfg",
    "source_type": "File",
    "destination": "/usr/share/configs"
  }'

200

400

401

404

500

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

Link a Pull Profile to an Application Version

Link a pull profile to an app version. Without a link, the pull profile by itself will do nothing.

put

/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name}

Authorizations

Path parameters

endpoint_nameanyrequired

pull_profile_nameanyrequired

app_nameanyrequired

version_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "app": "app_name",
  "app_version": "version_name",
  "endpoint": "endpoint_name",
  "pull_profile": "pull_profile_name",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

Unlink a Pull Profile From an Application Version

Unlink a pull profile from an app version. It will not delete the pull profile.

delete

/v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name}

Authorizations

Path parameters

endpoint_nameanyrequired

pull_profile_nameanyrequired

app_nameanyrequired

version_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name}' \
  --header 'authorization: YOUR_API_KEY'

204

400

401

404

500

No body

Success

List All Pull Profile of an Endpoint Storage

List all pull profiles of an endpoint storage.

get

/v1/storage/endpoint/{endpoint_name}/pull-profiles

Authorizations

Path parameters

endpoint_nameanyrequired

Query parameters

pageany

Page number for pagination

limitany

Limit of pull profiles for each page

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/storage/endpoint/{endpoint_name}/pull-profiles' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "pull_profiles": [
    {
      "name": "pull_profile_name",
      "source": "/my-bucket/config.cfg",
      "source_type": "File",
      "destination": "/usr/share/configs",
      "create_time": "2022-01-01 00:00:00.000000",
      "last_updated": "2022-01-01 00:00:00.000000"
    }
  ],
  "pagination": {
    "number": 1,
    "next_page_number": 1,
    "previous_page_number": 1,
    "paginator": {
      "num_pages": 1
    },
    "has_next": true,
    "has_previous": true
  }
}

Success

List All Endpoint Storage

List all endpoint storage.

get

/v1/storage/endpoints

Authorizations

Query parameters

pageany

Page number for pagination

limitany

Limit of Fleet for each page

Header parameters

X-Fieldsany

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/storage/endpoints' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

500

{
  "endpoints": [
    {
      "name": "my-s3-endpoint",
      "access_key_id": "my-access-key-id",
      "endpoint": "https://us-east-1.your-s3-provider.com",
      "bucket": "my-bucket",
      "create_time": "2022-01-01 00:00:00.000000",
      "last_updated": "2022-01-01 00:00:00.000000"
    }
  ],
  "pagination": {
    "number": 1,
    "next_page_number": 1,
    "previous_page_number": 1,
    "paginator": {
      "num_pages": 1
    },
    "has_next": true,
    "has_previous": true
  }
}

Success

📦 Applications

💾 Container Registry

🗒️ Log Storage

📦 Applications

💾 Container Registry

🗒️ Log Storage

Create a New Application

Update an Application

Get an Application

Delete an Application

Create a New Application Version

Delete an Application Version

Get an Application Version

Update an Application Version

List All Versions for an Application

List All Applications

List All Tags for a Registry Image

Delete Tag For a Registry Image

Create a New Endpoint Storage

Delete an Endpoint Storage

Get an Endpoint Storage

Update an Endpoint Storage

Create a New Pull Profile

Delete a Pull Profile

Get a Pull Profile

Update a Pull Profile

Link a Pull Profile to an Application Version

Unlink a Pull Profile From an Application Version

List All Pull Profile of an Endpoint Storage

List All Endpoint Storage

📦 Applications

💾 Container Registry

🗒️ Log Storage

📦 Applications

💾 Container Registry

🗒️ Log Storage

Create a New Application

Update an Application

Get an Application

Delete an Application

Create a New Application Version

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Delete an Application Version

Get an Application Version

Update an Application Version

Show child attributes

Show child attributes

Show child attributes

Show child attributes

List All Versions for an Application

List All Applications

List All Tags for a Registry Image

Delete Tag For a Registry Image

Create a New Endpoint Storage

Delete an Endpoint Storage

Get an Endpoint Storage

Update an Endpoint Storage

Create a New Pull Profile

Delete a Pull Profile

Get a Pull Profile

Update a Pull Profile

Link a Pull Profile to an Application Version

Unlink a Pull Profile From an Application Version

List All Pull Profile of an Endpoint Storage

List All Endpoint Storage