Gestion des versions

📦 Applications

Create a New Application

post

Create an application that will regroup application versions.

Autorisations

authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Corps

namestring · min: 1 · max: 64Requis

The application name

Example: Example App

is_activebooleanRequis

If the application can be deployed

Example: true

is_telemetry_agent_activebooleanOptionnel

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

imagestringRequis

Image base64 string

Example: iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post

/v1/app

POST /v1/app HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "name": "Example App",
  "is_active": true,
  "is_telemetry_agent_active": false,
  "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg=="
}

{
  "name": "Example App",
  "is_active": true,
  "is_telemetry_agent_active": false,
  "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==",
  "create_time": "2026-02-12 00:01:09.004146",
  "last_updated": "2026-02-12 00:01:09.004146"
}

Update an Application

patch

Update an application with new information.

Autorisations

authorizationstringRequis

Paramètres de chemin

app_namestringRequis

Corps

namestring · min: 3 · max: 64Optionnel

Application name

Example: Example App

is_activebooleanOptionnel

If the application can be deployed

Example: true

is_telemetry_agent_activebooleanOptionnel

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

imagestringOptionnel

Image base64 string

Example: iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

patch

/v1/app/{app_name}

PATCH /v1/app/{app_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "name": "Example App",
  "is_active": true,
  "is_telemetry_agent_active": false,
  "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg=="
}

{
  "name": "Example App",
  "is_active": true,
  "is_telemetry_agent_active": false,
  "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==",
  "create_time": "2026-02-12 00:01:09.004146",
  "last_updated": "2026-02-12 00:01:09.004146"
}

Get an Application

get

Retrieve an application and its information.

Autorisations

authorizationstringRequis

Paramètres de chemin

app_namestringRequis

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v1/app/{app_name}

GET /v1/app/{app_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "name": "Example App",
  "is_active": true,
  "is_telemetry_agent_active": false,
  "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==",
  "create_time": "2026-02-12 00:01:09.004146",
  "last_updated": "2026-02-12 00:01:09.004146"
}

Delete an Application

delete

Delete an application and all its current versions.

Autorisations

authorizationstringRequis

Paramètres de chemin

app_namestringRequis

Réponses

200

Success

Aucun contenu

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/v1/app/{app_name}

DELETE /v1/app/{app_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

Aucun contenu

Create a New Application Version

post

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

Autorisations

authorizationstringRequis

Paramètres de chemin

app_namestringRequis

The name of the application associated

Corps

namestring · min: 1 · max: 64Requis

This is the identifier for your version. It’s often linked to a build version, but can be any unique name.

Example: 1.0.0

is_activebooleanOptionnel

This boolean tells the system whether this version can be deployed or is deactivated.

Example: true

docker_repositorystringRequis

‘docker_repository’ is named incorrectly, this property references the Docker registry where this version’s container image is hosted (e.g., ‘registry.edgegap.com’ or ‘docker.io’).

Example: docker.io

docker_imagestringRequis

The Docker image for your version, usually including a namespace or project.

Example: edgegap/lyrastartergame

docker_tagstringRequis

The Docker tag for your version. It must be valid according to your Docker image.

Example: 25.05.30-16.45.19-04

private_usernamestringOptionnel

The username used to access your container registry. This is not your Edgegap account credential.

Example: my_username

private_tokenstringOptionnel

The token or password used to access your container registry. This is not your Edgegap account password.

Example: my_password

req_cpuinteger · min: 100Requis

The number of vCPU units required to run your server container (1024 units = 1 vCPU).

Example: 1536

req_memoryinteger · min: 100Requis

The amount of memory in MB required to run your server container (1024 MB = 1 GB). It can be at most twice the number of vCPU units requested.

Example: 3072

req_videointegerOptionnel

Units of GPU needed (1024 = 1 GPU)

max_durationintegerOptionnel

The maximum duration in minutes the app version can run before being automatically stopped. If omitted, the default is 1440 minutes (24 hours).

Example: 30

force_cachebooleanOptionnel

Enable faster deployments by caching your container across all Edgegap locations. Recommended for live games.

Example: true

caching_percentnumberOptionnel

Current caching percentage on scale 0-1, with 1 meaning 100% global cache coverage. Values above 0.8 are considered to be a good caching coverage level.

Example: 0.8

time_to_deployinteger · min: 15Optionnel

Time in seconds to wait for the app version to deploy before marking it as failed. Useful for enforcing strict deployment time limits.

Example: 15

verify_imagebooleanOptionnel

By enabling the verify_image option, your image information (docker_repository, docker_image, docker_tag) will be tested to ensure the image can be pulled successfully.

Default: falseExample: true

termination_grace_period_secondsinteger · min: 5 · max: 3600Optionnel

Termination grace period in seconds after sending the SIGTERM signal to the container. Allows graceful shutdown and post-processing before the container stops.

Example: 5

endpoint_storagestringOptionnel

The name of the endpoint storage to use to store the container logs at the end of the deployment. This will overwrite the default storage in the app version.

Example: my-storage

commandstring · nullableOptionnel

Entrypoint/command override for your container. This replaces the default command and should be used with caution.

Example: null | 'string'

argumentsstring · nullableOptionnel

Arguments to pass to the container’s command. This replace the default arguments and should be used with caution

Example: null | 'string'

dns_configstringOptionnel

The name of the DNS configuration to link with your deployment.

will_deploy_in_mainland_chinabooleanOptionnel

If true, the app version will only be deployed in Mainland China locations. Otherwise, it will never deploy in Mainland China locations.

Default: false

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

409

Conflict

application/json

424

Failed Dependency

application/json

500

Internal Server Error

application/json

post

/v1/app/{app_name}/version

POST /v1/app/{app_name}/version HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 797

{
  "name": "1.0.0",
  "is_active": true,
  "docker_repository": "docker.io",
  "docker_image": "edgegap/lyrastartergame",
  "docker_tag": "25.05.30-16.45.19-04",
  "private_username": "my_username",
  "private_token": "my_password",
  "req_cpu": 1536,
  "req_memory": 3072,
  "req_video": 0,
  "max_duration": 30,
  "force_cache": true,
  "caching_percent": 0.8,
  "time_to_deploy": 15,
  "session_config": {
    "kind": "Seat",
    "sockets": 10,
    "autodeploy": true,
    "empty_ttl": 60,
    "session_max_duration": 1
  },
  "ports": [
    {
      "port": 7777,
      "protocol": "UDP",
      "to_check": true,
      "tls_upgrade": false,
      "name": "game_port"
    }
  ],
  "envs": [
    {
      "key": "MAP_ID",
      "value": "forest1",
      "is_secret": true
    }
  ],
  "verify_image": true,
  "termination_grace_period_seconds": 5,
  "endpoint_storage": "my-storage",
  "command": "null | 'string'",
  "arguments": "null | 'string'",
  "dns_config": "text",
  "will_deploy_in_mainland_china": false
}

{
  "success": true,
  "version": {
    "name": "1.0.0",
    "is_active": true,
    "docker_repository": "docker.io",
    "docker_image": "edgegap/lyrastartergame",
    "docker_tag": "25.05.30-16.45.19-04",
    "private_username": "my_username",
    "private_token": "my_password",
    "req_cpu": 1536,
    "req_memory": 3072,
    "req_video": 0,
    "max_duration": 30,
    "force_cache": true,
    "caching_percent": 0.8,
    "kind": 0,
    "time_to_deploy": 15,
    "session_config": {
      "kind": "Seat",
      "sockets": 10,
      "autodeploy": true,
      "empty_ttl": 60,
      "session_max_duration": 1
    },
    "ports": [
      {
        "port": 7777,
        "protocol": "UDP",
        "to_check": true,
        "tls_upgrade": false,
        "name": "game_port"
      }
    ],
    "envs": [
      {
        "key": "MAP_ID",
        "value": "forest1",
        "is_secret": true
      }
    ],
    "verify_image": true,
    "termination_grace_period_seconds": 5,
    "endpoint_storage": "my-storage",
    "command": "null | 'string'",
    "arguments": "null | 'string'",
    "create_time": "2026-02-12T00:15:18.430Z",
    "last_updated": "2026-02-12T00:15:18.430Z",
    "dns_config": "text",
    "will_deploy_in_mainland_china": false
  }
}

Delete an Application Version

delete

Delete a specific version of an application.

Autorisations

authorizationstringRequis

Paramètres de chemin

app_namestringRequis

The name of the application

version_namestringRequis

The name of the application version

Réponses

200

Success

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

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

DELETE /v1/app/{app_name}/version/{version_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

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

Get an Application Version

get

Retrieve the specifications of an application version.

Autorisations

authorizationstringRequis

Paramètres de chemin

app_namestringRequis

The name of the application

version_namestringRequis

The name of the application version

Réponses

200

Success

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

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

GET /v1/app/{app_name}/version/{version_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "name": "1.0.0",
  "is_active": true,
  "docker_repository": "docker.io",
  "docker_image": "edgegap/lyrastartergame",
  "docker_tag": "25.05.30-16.45.19-04",
  "private_username": "my_username",
  "private_token": "my_password",
  "req_cpu": 1536,
  "req_memory": 3072,
  "req_video": 0,
  "max_duration": 30,
  "force_cache": true,
  "caching_percent": 0.8,
  "kind": 0,
  "time_to_deploy": 15,
  "session_config": {
    "kind": "Seat",
    "sockets": 10,
    "autodeploy": true,
    "empty_ttl": 60,
    "session_max_duration": 1
  },
  "ports": [
    {
      "port": 7777,
      "protocol": "UDP",
      "to_check": true,
      "tls_upgrade": false,
      "name": "game_port"
    }
  ],
  "envs": [
    {
      "key": "MAP_ID",
      "value": "forest1",
      "is_secret": true
    }
  ],
  "verify_image": true,
  "termination_grace_period_seconds": 5,
  "endpoint_storage": "my-storage",
  "command": "null | 'string'",
  "arguments": "null | 'string'",
  "create_time": "2026-02-12T00:15:18.430Z",
  "last_updated": "2026-02-12T00:15:18.430Z",
  "dns_config": "text",
  "will_deploy_in_mainland_china": false
}

Update an Application Version

patch

Update an application version with new specifications.

Autorisations

authorizationstringRequis

Paramètres de chemin

app_namestringRequis

The name of the application

version_namestringRequis

The name of the application version

Corps

namestring · min: 1 · max: 64Optionnel

This is the identifier for your version. It’s often linked to a build version, but can be any unique name.

Example: 1.0.0

is_activebooleanOptionnel

This boolean tells the system whether this version can be deployed or is deactivated.

Example: true

docker_repositorystringOptionnel

‘docker_repository’ is named incorrectly, this property references the Docker registry where this version’s container image is hosted (e.g., ‘registry.edgegap.com’ or ‘docker.io’).

Example: docker.io

docker_imagestringOptionnel

The Docker image for your version, usually including a namespace or project.

Example: edgegap/lyrastartergame

docker_tagstringOptionnel

The Docker tag for your version. It must be valid according to your Docker image.

Example: 25.05.30-16.45.19-04

private_usernamestringOptionnel

The username used to access your container registry. This is not your Edgegap account credential.

Example: my_username

private_tokenstringOptionnel

The token or password used to access your container registry. This is not your Edgegap account password.

Example: my_password

max_durationinteger · nullableOptionnel

The maximum duration in minutes the app version can run before being automatically stopped. If omitted, the default is 1440 minutes (24 hours).

Example: 30

force_cachebooleanOptionnel

Enable faster deployments by caching your container across all Edgegap locations. Recommended for live games.

Example: true

time_to_deployinteger · min: 15Optionnel

Time in seconds to wait for the app version to deploy before marking it as failed. Useful for enforcing strict deployment time limits.

Example: 15

termination_grace_period_secondsinteger · min: 5 · max: 3600Optionnel

Termination grace period in seconds after sending the SIGTERM signal to the container. Allows graceful shutdown and post-processing before the container stops.

Example: 5

verify_imagebooleanOptionnel

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

Default: falseExample: true

endpoint_storagestringOptionnel

The name of the endpoint storage to use to store the container logs at the end of the deployment. This will overwrite the default storage in the app version.

Example: my-storage

commandstring · nullableOptionnel

Entrypoint/command override for your container. This replaces the default command and should be used with caution.

Example: null | 'string'

argumentsstring · nullableOptionnel

Arguments to pass to the container’s command. This replace the default arguments and should be used with caution

Example: null | 'string'

dns_configstringOptionnel

The name of the DNS configuration to link with your deployment.

will_deploy_in_mainland_chinabooleanOptionnel

If true, the app version will only be deployed in Mainland China locations. Otherwise, it will never deploy in Mainland China locations.

Default: false

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

424

Failed Dependency

application/json

500

Internal Server Error

application/json

patch

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

PATCH /v1/app/{app_name}/version/{version_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 728

{
  "name": "1.0.0",
  "is_active": true,
  "docker_repository": "docker.io",
  "docker_image": "edgegap/lyrastartergame",
  "docker_tag": "25.05.30-16.45.19-04",
  "private_username": "my_username",
  "private_token": "my_password",
  "max_duration": 30,
  "force_cache": true,
  "time_to_deploy": 15,
  "session_config": {
    "kind": "Seat",
    "sockets": 10,
    "autodeploy": true,
    "empty_ttl": 60,
    "session_max_duration": 1
  },
  "ports": [
    {
      "port": 7777,
      "protocol": "UDP",
      "to_check": true,
      "tls_upgrade": false,
      "name": "game_port"
    }
  ],
  "envs": [
    {
      "key": "MAP_ID",
      "value": "forest1",
      "is_secret": true
    }
  ],
  "termination_grace_period_seconds": 5,
  "verify_image": true,
  "endpoint_storage": "my-storage",
  "command": "null | 'string'",
  "arguments": "null | 'string'",
  "dns_config": "text",
  "will_deploy_in_mainland_china": false
}

{
  "success": true,
  "version": {
    "name": "1.0.0",
    "is_active": true,
    "docker_repository": "docker.io",
    "docker_image": "edgegap/lyrastartergame",
    "docker_tag": "25.05.30-16.45.19-04",
    "private_username": "my_username",
    "private_token": "my_password",
    "req_cpu": 1536,
    "req_memory": 3072,
    "req_video": 0,
    "max_duration": 30,
    "force_cache": true,
    "caching_percent": 0.8,
    "kind": 0,
    "time_to_deploy": 15,
    "session_config": {
      "kind": "Seat",
      "sockets": 10,
      "autodeploy": true,
      "empty_ttl": 60,
      "session_max_duration": 1
    },
    "ports": [
      {
        "port": 7777,
        "protocol": "UDP",
        "to_check": true,
        "tls_upgrade": false,
        "name": "game_port"
      }
    ],
    "envs": [
      {
        "key": "MAP_ID",
        "value": "forest1",
        "is_secret": true
      }
    ],
    "verify_image": true,
    "termination_grace_period_seconds": 5,
    "endpoint_storage": "my-storage",
    "command": "null | 'string'",
    "arguments": "null | 'string'",
    "create_time": "2026-02-12T00:15:18.430Z",
    "last_updated": "2026-02-12T00:15:18.430Z",
    "dns_config": "text",
    "will_deploy_in_mainland_china": false
  }
}

List All Versions for an Application

get

List all versions of a specific application.

Autorisations

authorizationstringRequis

Paramètres de chemin

app_namestringRequis

The name of the application

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v1/app/{app_name}/versions

GET /v1/app/{app_name}/versions HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "versions": [
    {
      "name": "1.0.0",
      "is_active": true,
      "docker_repository": "docker.io",
      "docker_image": "edgegap/lyrastartergame",
      "docker_tag": "25.05.30-16.45.19-04",
      "private_username": "my_username",
      "private_token": "my_password",
      "req_cpu": 1536,
      "req_memory": 3072,
      "req_video": 0,
      "max_duration": 30,
      "force_cache": true,
      "caching_percent": 0.8,
      "kind": 0,
      "time_to_deploy": 15,
      "session_config": {
        "kind": "Seat",
        "sockets": 10,
        "autodeploy": true,
        "empty_ttl": 60,
        "session_max_duration": 1
      },
      "ports": [
        {
          "port": 7777,
          "protocol": "UDP",
          "to_check": true,
          "tls_upgrade": false,
          "name": "game_port"
        }
      ],
      "envs": [
        {
          "key": "MAP_ID",
          "value": "forest1",
          "is_secret": true
        }
      ],
      "verify_image": true,
      "termination_grace_period_seconds": 5,
      "endpoint_storage": "my-storage",
      "command": "null | 'string'",
      "arguments": "null | 'string'",
      "create_time": "2026-02-12T00:15:18.430Z",
      "last_updated": "2026-02-12T00:15:18.430Z",
      "dns_config": "text",
      "will_deploy_in_mainland_china": false
    }
  ],
  "total_count": 1
}

List All Applications

get

List all the applications that you own.

Autorisations

authorizationstringRequis

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/v1/apps

GET /v1/apps HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "applications": [
    {
      "name": "Example App",
      "is_active": true,
      "is_telemetry_agent_active": false,
      "image": "iVBORw0KGgoAAAANSUhEUg[...]AAABJRU5ErkJggg==",
      "create_time": "2026-02-12 00:01:09.004146",
      "last_updated": "2026-02-12 00:01:09.004146"
    }
  ]
}

💾 Registre de conteneurs

List All Tags for a Registry Image

get

List all tags of a specific registry image.

Autorisations

authorizationstringRequis

Paramètres de chemin

image_namestringRequis

The name of the image

Réponses

200

Success

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

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

GET /v1/container-registry/images/{image_name}/tags HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "tag": "tag1",
      "last_push_at": "2026-02-12T00:15:18.430Z",
      "artifact": {
        "artifact_deleted": true,
        "remaining_tags": [
          "tag1",
          "tag2"
        ],
        "image_hash": "sha256:1234567890abcdef",
        "size_mb": 1
      }
    }
  ]
}

Delete Tag For a Registry Image

delete

Delete a single tag from a artifact in the registry.

Autorisations

authorizationstringRequis

Paramètres de chemin

image_namestringRequis

The name of the image

tag_namestringRequis

The name of the tag

Réponses

200

Success

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

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

DELETE /v1/container-registry/images/{image_name}/tags/{tag_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

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

Create a New Pull Profile

post

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.

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

Corps

namestringRequis

Name of the pull profile

Example: pull_profile_name

sourcestringRequis

Source in the S3 bucket to fetch from

Example: /my-bucket/config.cfg

source_typestring · enumRequis

If the source is a File or a Directory

Example: FileValeurs possibles:

destinationstringRequis

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

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

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

POST /v1/storage/endpoint/{endpoint_name}/pull-profile HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs"
}

{
  "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"
}

Get a Pull Profile

get

Retrieve a pull profile and its specifications.

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

pull_profile_namestringRequis

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

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

GET /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "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"
}

Update a Pull Profile

patch

Update a pull profile with new specifications.

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

pull_profile_namestringRequis

Corps

namestringOptionnel

Name of the pull profile

Example: pull_profile_name

sourcestringOptionnel

Source in the S3 bucket to fetch from

Example: /my-bucket/config.cfg

source_typestring · enumOptionnel

If the source is a File or a Directory

Example: FileValeurs possibles:

destinationstringOptionnel

Example: /usr/share/configs

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch

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

PATCH /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs"
}

{
  "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"
}

Delete a Pull Profile

delete

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

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

pull_profile_namestringRequis

Réponses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

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

DELETE /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

Aucun contenu

List All Pull Profile of an Endpoint Storage

get

List all pull profiles of an endpoint storage.

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

Paramètres de requête

pageintegerOptionnel

Page number for pagination

limitintegerOptionnel

Limit of pull profiles for each page

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

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

GET /v1/storage/endpoint/{endpoint_name}/pull-profiles HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "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
  }
}

Link a Pull Profile to an Application Version

put

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

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

pull_profile_namestringRequis

app_namestringRequis

version_namestringRequis

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

put

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

PUT /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "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"
}

Unlink a Pull Profile From an Application Version

delete

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

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

pull_profile_namestringRequis

app_namestringRequis

version_namestringRequis

Réponses

204

Success

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

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

DELETE /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

Aucun contenu

🗒️ Stockage des journaux

Create a New Endpoint Storage

post

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

Autorisations

authorizationstringRequis

Corps

namestringRequis

Name of the Endpoint Storage

Example: my-s3-bucket

access_key_idstringRequis

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

endpointstringRequis

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

bucketstringRequis

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

Example: my-bucket

output_formatstring · enumOptionnel

The format how the logs will be exported to the bucket.

Default: TEXTExample: NDJSONValeurs possibles:

secret_access_keystringRequis

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

Example: my-secret-access

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/v1/storage/endpoint

POST /v1/storage/endpoint HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "name": "my-s3-bucket",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON",
  "secret_access_key": "my-secret-access"
}

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

Delete an Endpoint Storage

delete

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

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

Réponses

204

No Content

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/v1/storage/endpoint/{endpoint_name}

DELETE /v1/storage/endpoint/{endpoint_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

Aucun contenu

List All Endpoint Storage

get

List all endpoint storage.

Autorisations

authorizationstringRequis

Paramètres de requête

pageintegerOptionnel

Page number for pagination

limitintegerOptionnel

Limit of Fleet for each page

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/v1/storage/endpoints

GET /v1/storage/endpoints HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "endpoints": [
    {
      "name": "my-s3-endpoint",
      "access_key_id": "my-access-key-id",
      "endpoint": "https://us-east-1.your-s3-provider.com",
      "bucket": "my-bucket",
      "output_format": "NDJSON",
      "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
  }
}

Get an Endpoint Storage

get

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

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v1/storage/endpoint/{endpoint_name}

GET /v1/storage/endpoint/{endpoint_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

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

Update an Endpoint Storage

patch

Update an Endpoint Storage with new specifications.

Autorisations

authorizationstringRequis

Paramètres de chemin

endpoint_namestringRequis

Corps

namestringOptionnel

Name of the Endpoint Storage

Example: my-s3-endpoint

access_key_idstringOptionnel

Your access key ID to connect to your S3 Bucket.

Example: my-access-key-id

endpointstringOptionnel

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

bucketstringOptionnel

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

Example: my-bucket

output_formatstring · enumOptionnel

The format how the logs will be exported to the bucket.

Default: TEXTExample: NDJSONValeurs possibles:

secret_access_keystringOptionnel

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

Example: my-secret-access

Réponses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch

/v1/storage/endpoint/{endpoint_name}

PATCH /v1/storage/endpoint/{endpoint_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "name": "my-s3-endpoint",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON",
  "secret_access_key": "my-secret-access"
}

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

PrécédentServeurs dédiés SuivantIntégration

Mis à jour il y a 1 mois

Ce contenu vous a-t-il été utile ?

hashtag📦 Applications

hashtagCreate a New Application

hashtagUpdate an Application

hashtagGet an Application

hashtagDelete an Application

hashtagCreate a New Application Version

hashtagDelete an Application Version

hashtagGet an Application Version

hashtagUpdate an Application Version

hashtagList All Versions for an Application

hashtagList All Applications

hashtag💾 Registre de conteneurs

hashtagList All Tags for a Registry Image

hashtagDelete Tag For a Registry Image

hashtagCreate a New Pull Profile

hashtagGet a Pull Profile

hashtagUpdate a Pull Profile

hashtagDelete a Pull Profile

hashtagList All Pull Profile of an Endpoint Storage

hashtagLink a Pull Profile to an Application Version

hashtagUnlink a Pull Profile From an Application Version

hashtag🗒️ Stockage des journaux

hashtagCreate a New Endpoint Storage

hashtagDelete an Endpoint Storage

hashtagList All Endpoint Storage

hashtagGet an Endpoint Storage

hashtagUpdate an Endpoint Storage

📦 Applications

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

💾 Registre de conteneurs

List All Tags for a Registry Image

Delete Tag For a Registry Image

Create a New Pull Profile

Get a Pull Profile

Update a Pull Profile

Delete a Pull Profile

List All Pull Profile of an Endpoint Storage

Link a Pull Profile to an Application Version

Unlink a Pull Profile From an Application Version

🗒️ Stockage des journaux

Create a New Endpoint Storage

Delete an Endpoint Storage

List All Endpoint Storage

Get an Endpoint Storage

Update an Endpoint Storage