版本控制

📦 应用程序

Create a New Application

post

Create an application that will regroup application versions.

授权

authorizationstring必填

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

请求体

namestring · 最小值: 1 · 最大值: 64必填

The 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==

响应

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:00:06.960460",
  "last_updated": "2026-02-12 00:00:06.960460"
}

Update an Application

patch

Update an application with new information.

授权

authorizationstring必填

路径参数

app_namestring必填

请求体

namestring · 最小值: 3 · 最大值: 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==

响应

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:00:06.960460",
  "last_updated": "2026-02-12 00:00:06.960460"
}

Get an Application

get

Retrieve an application and its information.

授权

authorizationstring必填

路径参数

app_namestring必填

响应

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:00:06.960460",
  "last_updated": "2026-02-12 00:00:06.960460"
}

Delete an Application

delete

Delete an application and all its current versions.

授权

authorizationstring必填

路径参数

app_namestring必填

响应

200

Success

无内容

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: */*

无内容

Create a New Application Version

post

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

授权

authorizationstring必填

路径参数

app_namestring必填

The name of the application associated

请求体

namestring · 最小值: 1 · 最大值: 64必填

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_activeboolean可选

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

Example: true

docker_repositorystring必填

‘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_imagestring必填

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

Example: edgegap/lyrastartergame

docker_tagstring必填

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

Example: 25.05.30-16.45.19-04

private_usernamestring可选

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

Example: my_username

private_tokenstring可选

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

Example: my_password

req_cpuinteger · 最小值: 100必填

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

Example: 1536

req_memoryinteger · 最小值: 100必填

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_videointeger可选

Units of GPU needed (1024 = 1 GPU)

max_durationinteger可选

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_cacheboolean可选

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

Example: true

caching_percentnumber可选

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 · 最小值: 15可选

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_imageboolean可选

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 · 最小值: 5 · 最大值: 3600可选

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_storagestring可选

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 · 可为 null可选

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

Example: null | 'string'

argumentsstring · 可为 null可选

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

Example: null | 'string'

dns_configstring可选

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

will_deploy_in_mainland_chinaboolean可选

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

Default: false

响应

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:38:46.143Z",
    "last_updated": "2026-02-12T00:38:46.143Z",
    "dns_config": "text",
    "will_deploy_in_mainland_china": false
  }
}

Delete an Application Version

delete

Delete a specific version of an application.

授权

authorizationstring必填

路径参数

app_namestring必填

The name of the application

version_namestring必填

The name of the application version

响应

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.

授权

authorizationstring必填

路径参数

app_namestring必填

The name of the application

version_namestring必填

The name of the application version

响应

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:38:46.143Z",
  "last_updated": "2026-02-12T00:38:46.143Z",
  "dns_config": "text",
  "will_deploy_in_mainland_china": false
}

Update an Application Version

patch

Update an application version with new specifications.

授权

authorizationstring必填

路径参数

app_namestring必填

The name of the application

version_namestring必填

The name of the application version

请求体

namestring · 最小值: 1 · 最大值: 64可选

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_activeboolean可选

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

Example: true

docker_repositorystring可选

‘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_imagestring可选

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

Example: edgegap/lyrastartergame

docker_tagstring可选

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

Example: 25.05.30-16.45.19-04

private_usernamestring可选

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

Example: my_username

private_tokenstring可选

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

Example: my_password

max_durationinteger · 可为 null可选

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_cacheboolean可选

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

Example: true

time_to_deployinteger · 最小值: 15可选

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 · 最小值: 5 · 最大值: 3600可选

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_imageboolean可选

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

Default: falseExample: true

endpoint_storagestring可选

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 · 可为 null可选

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

Example: null | 'string'

argumentsstring · 可为 null可选

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

Example: null | 'string'

dns_configstring可选

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

will_deploy_in_mainland_chinaboolean可选

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

Default: false

响应

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:38:46.143Z",
    "last_updated": "2026-02-12T00:38:46.143Z",
    "dns_config": "text",
    "will_deploy_in_mainland_china": false
  }
}

List All Versions for an Application

get

List all versions of a specific application.

授权

authorizationstring必填

路径参数

app_namestring必填

The name of the application

响应

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:38:46.143Z",
      "last_updated": "2026-02-12T00:38:46.143Z",
      "dns_config": "text",
      "will_deploy_in_mainland_china": false
    }
  ],
  "total_count": 1
}

List All Applications

get

List all the applications that you own.

授权

authorizationstring必填

响应

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:00:06.960460",
      "last_updated": "2026-02-12 00:00:06.960460"
    }
  ]
}

💾 容器镜像仓库

List All Tags for a Registry Image

get

List all tags of a specific registry image.

授权

authorizationstring必填

路径参数

image_namestring必填

The name of the image

响应

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:38:46.143Z",
      "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.

授权

authorizationstring必填

路径参数

image_namestring必填

The name of the image

tag_namestring必填

The name of the tag

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

请求体

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可能的值:

destinationstring必填

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

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

pull_profile_namestring必填

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

pull_profile_namestring必填

请求体

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可能的值:

destinationstring可选

Example: /usr/share/configs

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

pull_profile_namestring必填

响应

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: */*

无内容

List All Pull Profile of an Endpoint Storage

get

List all pull profiles of an endpoint storage.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

查询参数

pageinteger可选

Page number for pagination

limitinteger可选

Limit of pull profiles for each page

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

pull_profile_namestring必填

app_namestring必填

version_namestring必填

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

pull_profile_namestring必填

app_namestring必填

version_namestring必填

响应

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: */*

无内容

🗒️ 日志存储

Create a New Endpoint Storage

post

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

授权

authorizationstring必填

请求体

namestring必填

Name of the Endpoint Storage

Example: my-s3-bucket

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

output_formatstring · enum可选

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

Default: TEXTExample: NDJSON可能的值:

secret_access_keystring必填

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

Example: my-secret-access

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

响应

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: */*

无内容

List All Endpoint Storage

get

List all endpoint storage.

授权

authorizationstring必填

查询参数

pageinteger可选

Page number for pagination

limitinteger可选

Limit of Fleet for each page

头参数

X-Fieldsstring · mask可选

An optional fields mask

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

响应

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.

授权

authorizationstring必填

路径参数

endpoint_namestring必填

请求体

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

output_formatstring · enum可选

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

Default: TEXTExample: NDJSON可能的值:

secret_access_keystring可选

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

Example: my-secret-access

响应

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

最后更新于1个月前

这有帮助吗？

hashtag📦 应用程序

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💾 容器镜像仓库

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🗒️ 日志存储

hashtagCreate a New Endpoint Storage

hashtagDelete an Endpoint Storage

hashtagList All Endpoint Storage

hashtagGet an Endpoint Storage

hashtagUpdate an Endpoint 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 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

🗒️ 日志存储

Create a New Endpoint Storage

Delete an Endpoint Storage

List All Endpoint Storage

Get an Endpoint Storage

Update an Endpoint Storage