专用服务器

⚡ 部署

[v2] Deploy

post

[Rate Limit: 40/seconds] Initiate a new deployment. A deployment is a containerized server instance of an application version running on the Edgegap platform.

授权

Authorizationstring必填

请求体

applicationstring必填

Name of the application that will be deployed

Example: my-app

versionstring必填

Name of the version within the application that will be deployed

Example: 25.05.30-16.45.19-04

require_cached_locationsboolean · 可为 null可选

Deploy faster by limiting placement to locations with cached image.

Default: false

tagsstring[]可选

List of tags to associate with the deployment

Example: my-custom-tag

响应

202

Deployment Request Accepted

application/json

400

Client Side Request Error

application/json

401

Unauthorized - Missing Token

application/json

422

Couldn't Allocate Server

application/json

500

Internal Server Error

application/json

post

/deployments

POST /v2/deployments HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 542

{
  "application": "my-app",
  "version": "25.05.30-16.45.19-04",
  "require_cached_locations": false,
  "users": [
    {
      "user_type": "ip_address",
      "user_data": {
        "ip_address": "75.28.35.192"
      }
    },
    {
      "user_type": "geo_coordinates",
      "user_data": {
        "latitude": 45.508888,
        "longitude": -73.561668
      }
    }
  ],
  "environment_variables": [
    {
      "key": "MY_ENVIRONMENT_VARIABLE",
      "value": "my-value",
      "is_hidden": false
    }
  ],
  "tags": [
    "my-custom-tag"
  ],
  "webhook_on_ready": {
    "url": "https://my-webhook.com"
  },
  "webhook_on_error": {
    "url": "https://my-webhook.com"
  },
  "webhook_on_terminated": {
    "url": "https://my-webhook.com"
  }
}

{
  "request_id": "a69f8e3e0555"
}

Get a Deployment Status and Information

get

[Rate Limit: 20/second] Retrieve the information for a deployment.

授权

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

路径参数

request_idstring必填

Unique Identifier to keep track of your request across all Arbitrium ecosystem. It's included in the response of the app deploy, example:

93924761ccde

响应

200

Success

application/json

request_idstring必填

The Unique ID of the Deployment's request

Example: c0653765de3b

fqdnstring必填

The FQDN that allow to connect to your Deployment

Example: abc123.test.edgegap.com

app_namestring必填

The name of the deployed App

Example: test

app_versionstring必填

The version of the deployed App

Example: v1

current_statusstring必填

The current status of the Deployment

Example: Status.DEPLOYING

runningboolean必填

True if the current Deployment is ready to be connected and running

Example: true

whitelisting_activeboolean必填

True if the current Deployment is ACL protected

Example: true

start_timestring必填

Timestamp of the Deployment when it is up and running

Example: 2026-03-03 16:02:09.360719

removal_timestring可选

Timestamp of the end of the Deployment

Example: 2026-03-03 16:02:09.360719

elapsed_timeinteger必填

Time since the Deployment is up and running in seconds

last_statusstring可选

The last status of the Deployment

Example: Status.SEEKING

errorboolean必填

True if there is an error with the Deployment

Example: true

error_detailstring可选

The error details of the Deployment

public_ipstring必填

The public IP

Example: 100.10.0.85

tagsstring[]可选

List of tags associated with the deployment

socketsinteger可选

The Capacity of the Deployment

Example: 5

sockets_usageinteger可选

The Capacity Usage of the Deployment

Example: 2

commandstring可选

The command to use in the container, null mean it will take the default of the container

argumentsstring可选

The arguments to use in the container, null mean it will take the default of the container

max_durationinteger必填

The deployment's maximum duration is the time, in minutes, that the deployment will remain active before automatically closing.

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/v1/status/{request_id}

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

{
  "request_id": "c0653765de3b",
  "fqdn": "abc123.test.edgegap.com",
  "app_name": "test",
  "app_version": "v1",
  "current_status": "Status.DEPLOYING",
  "running": true,
  "whitelisting_active": true,
  "start_time": "2026-03-03 16:02:09.360719",
  "removal_time": "2026-03-03 16:02:09.360719",
  "elapsed_time": 1,
  "last_status": "Status.SEEKING",
  "error": true,
  "error_detail": "",
  "ports": {
    "7777": {
      "external": 31669,
      "internal": 7777,
      "protocol": "UDP",
      "name": "7777",
      "tls_upgrade": false,
      "link": "example.com:31669",
      "proxy": 65002
    },
    "web": {
      "external": 31587,
      "internal": 8080,
      "protocol": "http",
      "name": "web",
      "tls_upgrade": true,
      "link": "https://example.com:31587",
      "proxy": 65001
    }
  },
  "public_ip": "100.10.0.85",
  "sessions": [
    {
      "session_id": "abc123",
      "status": "Status.READY",
      "ready": true,
      "linked": true,
      "kind": "DEFAULT | SEATS | MATCH",
      "user_count": "10"
    }
  ],
  "location": {
    "city": "Montreal",
    "country": "Canada",
    "continent": "North America",
    "administrative_division": "Quebec",
    "timezone": "Eastern Time",
    "latitude": 45.508888,
    "longitude": -73.561668
  },
  "tags": [
    "production"
  ],
  "sockets": "5",
  "sockets_usage": "2",
  "command": "",
  "arguments": "",
  "max_duration": 1
}

Stop a deployment

delete

Request to stop a Deployment, triggering a graceful shutdown (SIGTERM). Returns 200 or 202 if deployment status is not READY and not ERROR, and stops deployment once either of these statuses is reached - see Deployment Lifecycle.

授权

authorizationstring必填

路径参数

request_idstring必填

Unique Identifier to keep track of your request across all Edgegap ecosystem. It's included in the response of the app deploy, example:

93924761ccde

查询参数

container_log_storagestring可选

If you want to enable the container log storage for the deployment. You can put 'true' if you already have endpoint storage associated with your deployment's app version. You can put 'false' if it is enabled by default and you want to disable it for this specific request. Or you can put the name of your endpoint storage and if it is valid we will store the container logs.

响应

200

Success

application/json

messagestring必填

A message depending of the request termination

Example: Instance 93924761ccde will be deleted

202

Accepted

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

410

Instance Already terminated

application/json

500

Internal Server Error

application/json

delete

/v1/stop/{request_id}

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

{
  "message": "Instance 93924761ccde will be deleted",
  "deployment_summary": {
    "request_id": "c0653765de3b",
    "fqdn": "abc123.test.edgegap.com",
    "app_name": "test",
    "app_version": "v1",
    "current_status": "Status.DEPLOYING",
    "running": true,
    "whitelisting_active": true,
    "start_time": "2026-03-03 16:02:09.360719",
    "removal_time": "2026-03-03 16:02:09.360719",
    "elapsed_time": 1,
    "last_status": "Status.SEEKING",
    "error": true,
    "error_detail": "",
    "ports": {
      "7777": {
        "external": 31669,
        "internal": 7777,
        "protocol": "UDP",
        "name": "7777",
        "tls_upgrade": false,
        "link": "example.com:31669",
        "proxy": 65002
      },
      "web": {
        "external": 31587,
        "internal": 8080,
        "protocol": "http",
        "name": "web",
        "tls_upgrade": true,
        "link": "https://example.com:31587",
        "proxy": 65001
      }
    },
    "public_ip": "100.10.0.85",
    "sessions": [
      {
        "session_id": "abc123",
        "status": "Status.READY",
        "ready": true,
        "linked": true,
        "kind": "DEFAULT | SEATS | MATCH",
        "user_count": "10"
      }
    ],
    "location": {
      "city": "Montreal",
      "country": "Canada",
      "continent": "North America",
      "administrative_division": "Quebec",
      "timezone": "Eastern Time",
      "latitude": 45.508888,
      "longitude": -73.561668
    },
    "tags": [
      "production"
    ],
    "sockets": "5",
    "sockets_usage": "2",
    "command": "",
    "arguments": "",
    "max_duration": 1
  }
}

Delete a Deployment from inside the container

delete

Delete a deployment from the inside of a container. You should use this URL inside your deployment. The URL is injected in your deployment and can be found via the environment variable ARBITRIUM_DELETE_URL.

路径参数

request_idstring必填

Unique Identifier to keep track of your request across all Arbitrium ecosystem. It's included in the response of the app deploy, example:

93924761ccde

access_point_idinteger必填

Access Point Number provided by our system

查询参数

container_log_storagestring可选

头参数

authorizationstring必填

Auto Generated token. This token is injected in your deployment and can be found via the environment variable named ARBITRIUM_DELETE_TOKEN

响应

200

Success

application/json

messagestring必填

A message depending of the request termination

Example: Instance 93924761ccde will be deleted

202

Accepted

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/v1/self/stop/{request_id}/{access_point_id}

DELETE /v1/self/stop/{request_id}/{access_point_id} HTTP/1.1
Host: api.edgegap.com
authorization: text
Accept: */*

{
  "message": "Instance 93924761ccde will be deleted",
  "deployment_summary": {
    "request_id": "c0653765de3b",
    "fqdn": "abc123.test.edgegap.com",
    "app_name": "test",
    "app_version": "v1",
    "current_status": "Status.DEPLOYING",
    "running": true,
    "whitelisting_active": true,
    "start_time": "2026-03-03 16:02:09.360719",
    "removal_time": "2026-03-03 16:02:09.360719",
    "elapsed_time": 1,
    "last_status": "Status.SEEKING",
    "error": true,
    "error_detail": "",
    "ports": {
      "7777": {
        "external": 31669,
        "internal": 7777,
        "protocol": "UDP",
        "name": "7777",
        "tls_upgrade": false,
        "link": "example.com:31669",
        "proxy": 65002
      },
      "web": {
        "external": 31587,
        "internal": 8080,
        "protocol": "http",
        "name": "web",
        "tls_upgrade": true,
        "link": "https://example.com:31587",
        "proxy": 65001
      }
    },
    "public_ip": "100.10.0.85",
    "sessions": [
      {
        "session_id": "abc123",
        "status": "Status.READY",
        "ready": true,
        "linked": true,
        "kind": "DEFAULT | SEATS | MATCH",
        "user_count": "10"
      }
    ],
    "location": {
      "city": "Montreal",
      "country": "Canada",
      "continent": "North America",
      "administrative_division": "Quebec",
      "timezone": "Eastern Time",
      "latitude": 45.508888,
      "longitude": -73.561668
    },
    "tags": [
      "production"
    ],
    "sockets": "5",
    "sockets_usage": "2",
    "command": "",
    "arguments": "",
    "max_duration": 1
  }
}

Delete Deployments in Bulk

post

Make a bulk delete of deployments using filters. All the deployments matching the given filters will be permanently deleted.

授权

authorizationstring必填

请求体

响应

202

Accepted

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/v1/deployments/bulk-stop

POST /v1/deployments/bulk-stop HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "filters": [
    {
      "field": "request_id",
      "values": [
        "c0653765de3b"
      ],
      "filter_type": "any"
    }
  ]
}

{
  "processable": [
    {
      "request_id": "c0653765de3b"
    }
  ]
}

List All Deployments

get

[Rate Limit: 10/second] List all deployments.

授权

authorizationstring必填

查询参数

querystring可选

Query to filter the deployments.

响应

200

Success

application/json

total_countinteger可选

Total Objects in the Database

messagestring[]可选

Extra Messages for the query

Example: [""]

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/v1/deployments

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

{
  "data": [
    {
      "request_id": "2d35052ec4e9",
      "fqdn": "abc123.test.edgegap.com",
      "start_time": "2026-03-03 16:02:09.360719",
      "ready": true,
      "public_ip": "100.10.0.85",
      "ports": {
        "7777": {
          "external": 31669,
          "internal": 7777,
          "protocol": "UDP",
          "name": "7777",
          "tls_upgrade": false,
          "link": "example.com:31669",
          "proxy": 65002
        },
        "web": {
          "external": 31587,
          "internal": 8080,
          "protocol": "http",
          "name": "web",
          "tls_upgrade": true,
          "link": "https://example.com:31587",
          "proxy": 65001
        }
      },
      "tags": [
        "production"
      ],
      "sockets": "5",
      "sockets_usage": "2",
      "is_joinable_by_session": true
    }
  ],
  "total_count": 1,
  "pagination": {
    "number": 1,
    "next_page_number": 1,
    "previous_page_number": 1,
    "paginator": {
      "num_pages": 1
    },
    "has_next": true,
    "has_previous": true
  },
  "message": [
    ""
  ]
}

List All Locations

get

List all the locations available to deploy on. You can specify an application and a version to filter out the locations that don’t have enough resources to deploy this application version.

授权

authorizationstring必填

查询参数

appstring可选

The App Name you want to filter with capacity

versionstring可选

The Version Name you want to filter with capacity

typestring可选

The type of the location

tagsstring可选

Gets locations with tags. Set to: "true" to have the tags

响应

200

Success

application/json

messagesstring[]可选

Extra Messages for the query

Example: [""]

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/v1/locations

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

{
  "locations": [
    {
      "city": "Montreal",
      "continent": "North America",
      "country": "Canada",
      "timezone": "Eastern Time",
      "administrative_division": "Quebec",
      "latitude": "45.3324097",
      "longitude": "-73.2693626",
      "type": "standard",
      "tags": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ],
  "messages": [
    ""
  ]
}

Get Deployment Container Logs

get

Retrieve the logs of your container. Logs are not available when your deployment is terminated. You can set up an endpoint storage to save your logs. Endpoint Storage Documentation

授权

authorizationstring必填

路径参数

request_idstring必填

响应

200

Success

application/json

logsstring可选

Auto Generated Field for logs

Example: Logs of the container

encodingstring可选

Auto Generated Field for encoding

Example: utf-8

crash_logsstring可选

Auto Generated Field for crash_logs

Example: Logs of the container when it crashed

logs_linkstring可选

Auto Generated Field for logs_link

Example: Link to the logs

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v1/deployment/{request_id}/container-logs

GET /v1/deployment/{request_id}/container-logs HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "logs": "Logs of the container",
  "encoding": "utf-8",
  "crash_logs": "Logs of the container when it crashed",
  "crash_data": {
    "exit_code": 1,
    "message": "Container crashed",
    "restart_count": 1
  },
  "logs_link": "Link to the logs"
}

Get a Deployment Metrics

get

Get the metrics for a specific deployment based on the start_time, end_time and steps. raw parameter can be set to true to get the raw data.

授权

authorizationstring必填

路径参数

request_idstring必填

查询参数

start_timestring可选

Starting time for the query. Default to deployment start time. Should match %Y-%m-%d %H:%M:%S.%f

	Example: 2021-07-10 00:00:00.00

end_timestring可选

End time for the metrics. Default to now.Must be greater than start_time. Should match %Y-%m-%d %H:%M:%S.%f

	Example: 2021-07-19 00:00:00.00

stepsstring可选

Steps between each metrics.

	Example: 30s, 1m, 5m 10m, 1h

rawstring可选

If set to true, will return the raw data. Default to false.

响应

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

422

Unprocessable

application/json

500

Internal Server Error

application/json

get

/v1/metrics/deployment/{request_id}

GET /v1/metrics/deployment/{request_id} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "total": {
    "receive_total": {
      "labels": [
        "00:00:00"
      ],
      "datasets": [
        "2458"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    },
    "transmit_total": {
      "labels": [
        "00:00:00"
      ],
      "datasets": [
        "2458"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    },
    "disk_read_total": {
      "labels": [
        "00:00:00"
      ],
      "datasets": [
        "2458"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    },
    "disk_write_total": {
      "labels": [
        "00:00:00"
      ],
      "datasets": [
        "2458"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    }
  },
  "cpu": {
    "labels": [
      "00:00:00"
    ],
    "datasets": [
      "2458"
    ],
    "timestamps": [
      "2021-07-14 14:17:37.711"
    ]
  },
  "mem": {
    "labels": [
      "00:00:00"
    ],
    "datasets": [
      "2458"
    ],
    "timestamps": [
      "2021-07-14 14:17:37.711"
    ]
  },
  "network": {
    "receive": {
      "labels": [
        "00:00:00"
      ],
      "datasets": [
        "2458"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    },
    "transmit": {
      "labels": [
        "00:00:00"
      ],
      "datasets": [
        "2458"
      ],
      "timestamps": [
        "2021-07-14 14:17:37.711"
      ]
    }
  }
}

传统版 [v1]

传统 v1/deploy API 端点是 过时，已被 v2 API 取代 - 参见专用服务器.

Create a Deployment request.

post

[Rate Limit: 40/second] Create a new deployment. A deployment is a containerized instance of an application version running on the Edgegap platform.

授权

authorizationstring必填

请求体

app_namestring必填

The application you want to deploy a version of.

Example: kart-racing

version_namestring可选

The application version you want to deploy a container, if not present, the last version created is automatically chosen.

Example: production-v1.0

is_public_appboolean可选

(DEPRECATED) - No longer used and you don't need to set it.

Default: false

ip_liststring[]可选

This parameter is not optional, but mutually exclusive with the geo_ip_list parameter. One of them is required. List of IP representing your users. These will be used to determine the best location for your deployment.

telemetry_profile_uuid_liststring[]可选

(DEPRECATED)

Example: ["85cf70e6-f871-42c6-96f0-65ff5bd469b5"]

skip_telemetryboolean可选

If true, the deployment will skip the telemetry measurement. This result in a faster time to deploy.

Default: true

webhook_urlstring可选

A URL to send a POST request when the deployment is ready. The request will contain the deployment status. The content of the request is the same as the v1/status/{request_id} endpoint.

Example: https://www.webhook.com/

tagsstring[]可选

List of tags associated with the deployment. These tags will be shown in the dashboard.

ap_sort_strategystring · enum可选

(DEPRECATED) - No longer used and you don't need to set it.

Example: basic可能的值:

commandstring · 可为 null可选

Allows to override the container command for this deployment. This is an advanced feature and should be used with caution.If set to null, the default command of the container will be used.

Example: null | 'string'

argumentsstring · 可为 null可选

Allows to override the container arguments for this deployment. This is an advanced feature and should be used with caution.If set to null, the default arguments of the container will be used.

Example: null | 'string'

响应

200

Success

application/json

request_idstring必填

The identifier of the deployment request. This is used to track the deployment.

Example: 61b1be8f54d9

request_dnsstring必填

This is the FQDN that allow to connect to your Deployment. It will not resolve until the deployment is ready.

Example: 61b1be8f54d9.pr.edgegap.net

request_appstring必填

The application that has been deployed.

Example: kart-racing

request_versionstring必填

The version of the application that has been deployed.

Example: v1.0

request_user_countinteger必填

This is the number of IP you have provided in the deployment request.

Example: 4

tagsstring[]可选

List of tags that have been injected in the deployment request. This field will only be present if tags were provided in the request.

ap_sort_strategystring · enum可选

(DEPRECATED) - Will only be present if the request was made with the ap_sort_strategy field.

Example: basic可能的值:

400

Bad Request

application/json

401

Unauthorized

application/json

409

Conflict

application/json

422

Unprocessable

application/json

post

/v1/deploy

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

{
  "app_name": "kart-racing",
  "version_name": "production-v1.0",
  "is_public_app": false,
  "ip_list": [
    "1.2.3.4"
  ],
  "geo_ip_list": [
    {
      "ip": "1.2.3.4",
      "latitude": 1,
      "longitude": 1
    }
  ],
  "telemetry_profile_uuid_list": [
    "85cf70e6-f871-42c6-96f0-65ff5bd469b5"
  ],
  "env_vars": [
    {
      "key": "MAP",
      "value": "Forest-2",
      "is_hidden": false
    }
  ],
  "skip_telemetry": true,
  "location": {
    "latitude": 45.5,
    "longitude": -73.56
  },
  "webhook_url": "https://www.webhook.com/",
  "tags": [
    "production"
  ],
  "container_log_storage": {
    "enabled": true,
    "endpoint_storage": "my-endpoint"
  },
  "filters": [
    {
      "field": "city",
      "values": [
        "Montreal"
      ],
      "filter_type": "any"
    }
  ],
  "ap_sort_strategy": "basic",
  "command": "null | 'string'",
  "arguments": "null | 'string'"
}

{
  "request_id": "61b1be8f54d9",
  "request_dns": "61b1be8f54d9.pr.edgegap.net",
  "request_app": "kart-racing",
  "filters": [
    {
      "field": "city",
      "values": [
        "Montreal"
      ],
      "filter_type": "any"
    }
  ],
  "request_version": "v1.0",
  "request_user_count": 4,
  "tags": [
    "production"
  ],
  "container_log_storage": {
    "enabled": true,
    "endpoint_storage": "my-endpoint"
  },
  "location": {
    "latitude": 45.5,
    "longitude": -73.56
  },
  "ap_sort_strategy": "basic"
}

🗺️ 私有舰队

Deploy to Fleet

post

[Rate Limit: 40/seconds] Initiate a new private fleet deployment. A deployment is a containerized server instance of an application version running on the Edgegap platform.

授权

Authorizationstring必填

请求体

applicationstring必填

Name of the application that will be deployed

Example: my-app

versionstring必填

Name of the version within the application that will be deployed

Example: 25.05.30-16.45.19-04

require_cached_locationsboolean · 可为 null可选

Deploy faster by limiting placement to locations with cached image.

Default: false

private_host_idsstring[] · 最小值: 1必填

Preferred and prioritized Private Host IDs to try before overflowing to cloud.

Example: alpha-north-america-95fab093

tagsstring[]可选

List of tags to associate with the deployment

Example: my-custom-tag

响应

202成功

application/json

400

Invalid Application or Application Version. No deployment has been created

application/json

401

Unauthorized. No deployment has been created.

application/json

422

Could not allocate an Edge Server for the deployment. A deployment has been created. Deployment is in error state. You can delete it manually or it will be deleted automatically by our system after some some times

application/json

500

Internal Server Error

application/json

post

/private-fleets/deployments

POST /v2/private-fleets/deployments HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 594

{
  "application": "my-app",
  "version": "25.05.30-16.45.19-04",
  "require_cached_locations": false,
  "private_host_ids": [
    "alpha-north-america-95fab093"
  ],
  "users": [
    {
      "user_type": "ip_address",
      "user_data": {
        "ip_address": "75.28.35.192"
      }
    },
    {
      "user_type": "geo_coordinates",
      "user_data": {
        "latitude": 45.508888,
        "longitude": -73.561668
      }
    }
  ],
  "environment_variables": [
    {
      "key": "MY_ENVIRONMENT_VARIABLE",
      "value": "my-value",
      "is_hidden": false
    }
  ],
  "tags": [
    "my-custom-tag"
  ],
  "webhook_on_ready": {
    "url": "https://my-webhook.com"
  },
  "webhook_on_error": {
    "url": "https://my-webhook.com"
  },
  "webhook_on_terminated": {
    "url": "https://my-webhook.com"
  }
}

{
  "request_id": "a69f8e3e0555"
}

List Private Fleet Hosts

get

[Rate Limit: 10/seconds] List all hosts in a private fleet.

授权

Authorizationstring必填

路径参数

fleet-namestring必填

Name of your private fleet.

Example: test-fleet

响应

200成功

application/json

400错误

application/json

401错误

application/json

500错误

application/json

get

/private-fleets/{fleet-name}/hosts

GET /v2/private-fleets/{fleet-name}/hosts HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "host_id": "alpha-north-america-95fab093",
      "status": "ACTIVE",
      "ip_address": "192.53.120.48",
      "latitude": 43.6173,
      "longitude": -79.3186,
      "city": "Toronto",
      "country": "Canada",
      "continent": "North America",
      "allocated_cpu_units": 1152,
      "allocated_memory_mb": 2176,
      "allocatable_cpu_units": 12928,
      "allocatable_memory_mb": 25178,
      "beacon": {
        "tcp_port": 30974,
        "udp_port": 31843,
        "ip_address": "192.53.120.48"
      },
      "created_at": "2025-11-26T16:32:30.825138Z",
      "updated_at": "2025-11-26T16:32:30.825144Z",
      "centroid": {
        "label": "Alpha",
        "latitude": 43.98884323260136,
        "longitude": -78.67419552556069,
        "radius_km": 700,
        "desired_host_count": 1
      },
      "delete_schedule": {
        "uuid": "10287c9b-a6e2-4909-84c8-59daf74895b5",
        "scheduled_at": "2025-11-30T23:59:00Z"
      },
      "fleet_host_specifications": {
        "cpu_units": 16384,
        "memory_mb": 32768,
        "base_clock_speed_mhz": 2000
      }
    }
  ]
}

🔖 标签

List tags for a Deployment

get

List tags for a deployment.

授权

authorizationstring必填

路径参数

request_idstring必填

响应

200

Success

application/json

countinteger可选

paginationobject可选

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v1/deployments/{request_id}/tags

GET /v1/deployments/{request_id}/tags HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "tags": [
    {
      "name": "v1.0.0",
      "create_time": "2022-01-01 00:00:00.000000",
      "last_updated": "2022-01-01 00:00:00.000000"
    }
  ],
  "count": 1,
  "pagination": {}
}

Get tag for a Deployment

get

Get tag for a deployment.

授权

authorizationstring必填

路径参数

request_idstring必填

tag_namestring必填

响应

200

Success

application/json

namestring必填

The name of the tag

Example: v1.0.0

create_timestring可选

UTC time of policy creation

Example: 2022-01-01 00:00:00.000000

last_updatedstring可选

UTC time of policy last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v1/deployments/{request_id}/tags/{tag_name}

GET /v1/deployments/{request_id}/tags/{tag_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "name": "v1.0.0",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Create Tag for a Deployment

post

Create a tag for a deployment. The tag will however not be injected into a running container.

授权

authorizationstring必填

路径参数

request_idstring必填

请求体

namestring · 最大值: 20必填

The name of the tag

Example: v1.0.0

响应

200

Success

application/json

namestring必填

The name of the tag

Example: v1.0.0

create_timestring可选

UTC time of policy creation

Example: 2022-01-01 00:00:00.000000

last_updatedstring可选

UTC time of policy last update

Example: 2022-01-01 00:00:00.000000

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post

/v1/deployments/{request_id}/tags

POST /v1/deployments/{request_id}/tags HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "name": "v1.0.0"
}

{
  "name": "v1.0.0",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Delete Tag for a Deployment

delete

Delete a tag for a deployment. The tag will however not be removed from the environment of a running container.

授权

authorizationstring必填

路径参数

request_idstring必填

tag_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/deployments/{request_id}/tags/{tag_name}

DELETE /v1/deployments/{request_id}/tags/{tag_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

无内容

Update Tag for a Deployment

patch

Update a tag for a deployment.

授权

authorizationstring必填

路径参数

request_idstring必填

tag_namestring必填

请求体

namestring · 最大值: 20必填

The name of the tag

Example: v1.0.0

响应

200

Success

application/json

namestring必填

The name of the tag

Example: v1.0.0

create_timestring可选

UTC time of policy creation

Example: 2022-01-01 00:00:00.000000

last_updatedstring可选

UTC time of policy last update

Example: 2022-01-01 00:00:00.000000

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/deployments/{request_id}/tags/{tag_name}

PATCH /v1/deployments/{request_id}/tags/{tag_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "name": "v1.0.0"
}

{
  "name": "v1.0.0",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

最后更新于10天前

这有帮助吗？

hashtag⚡ 部署

hashtag[v2] Deploy

hashtagGet a Deployment Status and Information

hashtagStop a deployment

hashtagDelete a Deployment from inside the container

hashtagDelete Deployments in Bulk

hashtagList All Deployments

hashtagList All Locations

hashtagGet Deployment Container Logs

hashtagGet a Deployment Metrics

hashtag传统版 [v1]

hashtagCreate a Deployment request.

hashtag🗺️ 私有舰队

hashtagDeploy to Fleet

hashtagList Private Fleet Hosts

hashtag 🔖 标签

hashtagList tags for a Deployment

hashtagGet tag for a Deployment

hashtagCreate Tag for a Deployment

hashtagDelete Tag for a Deployment

hashtagUpdate Tag for a Deployment

⚡ 部署

[v2] Deploy

Get a Deployment Status and Information

Stop a deployment

Delete a Deployment from inside the container

Delete Deployments in Bulk

List All Deployments

List All Locations

Get Deployment Container Logs

Get a Deployment Metrics

传统版 [v1]

Create a Deployment request.

🗺️ 私有舰队

Deploy to Fleet

List Private Fleet Hosts

🔖 标签

List tags for a Deployment

Get tag for a Deployment

Create Tag for a Deployment

Delete Tag for a Deployment

Update Tag for a Deployment