Dedicated Servers
Last updated
Was this helpful?
Last updated
Was this helpful?
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.
Unique Identifier to keep track of your request across all Edgegap ecosystem. It's included in the response of the app deploy, example:
93924761ccde
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.
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": "2025-06-20 12:00:43.066217",
"removal_time": "2025-06-20 12:00:43.066217",
"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 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.
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 Number provided by our system
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.
Auto Generated token. This token is injected in your deployment and can be found via the environment variable named ARBITRIUM_DELETE_TOKEN
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": "2025-06-20 12:00:43.066217",
"removal_time": "2025-06-20 12:00:43.066217",
"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
}
}[Rate Limit: 10/second] List all deployments.
Query to filter the 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": "2025-06-20 12:00:43.066217",
"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 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.
The App Name you want to filter with capacity
The Version Name you want to filter with capacity
The type of the location
Gets locations with tags. Set to: "true" to have the tags
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": [
""
]
}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
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 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.
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 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
Steps between each metrics.
Example: 30s, 1m, 5m 10m, 1h
If set to true, will return the raw data. Default to false.
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"
]
}
}
}Retrieve a fleet with its details.
The name of the fleet
GET /v1/fleet/{fleet_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*
{
"name": "fleet_name",
"enabled": false,
"create_time": "2022-01-01 00:00:00.000000",
"last_updated": "2022-01-01 00:00:00.000000"
}List all the fleets you own.
Page number for pagination
Limit of Fleet for each page
GET /v1/fleets HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*
{
"fleets": [
{
"name": "fleet_name",
"enabled": false,
"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
}
}Delete a fleet, its policies and links between the application versions.
The name of the fleet
DELETE /v1/fleet/{fleet_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*
{
"message": "text"
}List all the policies of a fleet.
The name of the fleet
Page number for pagination
Limit of Fleet for each page
An optional fields mask
GET /v1/fleet/{fleet_name}/policies HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*
{
"policies": [
{
"name": "policy_name",
"enabled": true,
"type": "Location",
"minimum": 1,
"maximum": 1,
"threshold": 0.9,
"data": {
"filters": [
{
"field": "city",
"values": [
"Montreal"
],
"filter_type": "any"
}
]
},
"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 an application version to a fleet. By linking this version, the fleet will automatically create deployments of this version according to the fleet policies.
The name of the fleet
The name of the application to link
The name of the application version to link
PUT /v1/fleet/{fleet_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",
"fleet": "fleet_name",
"create_time": "2022-01-01 00:00:00.000000",
"last_updated": "2022-01-01 00:00:00.000000"
}Unlink an application version from a fleet. It will not delete the application version or the fleet
The name of the fleet
The name of the application to link
The name of the application version to link
DELETE /v1/fleet/{fleet_name}/app/{app_name}/version/{version_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*
No content
Delete a policy. It will not delete the fleet.
The name of the fleet
The name of the policy to delete
DELETE /v1/fleet/{fleet_name}/policies/{policy_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*
{
"message": "text"
}Retrieve a specific policy of a fleet.
The name of the fleet
The name of the policy
GET /v1/fleet/{fleet_name}/policies/{policy_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*
{
"name": "policy_name",
"enabled": true,
"type": "Location",
"minimum": 1,
"maximum": 1,
"threshold": 0.9,
"data": {
"filters": [
{
"field": "city",
"values": [
"Montreal"
],
"filter_type": "any"
}
]
},
"create_time": "2022-01-01 00:00:00.000000",
"last_updated": "2022-01-01 00:00:00.000000"
}List tags for a deployment.
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 /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"
}Delete a tag for a deployment. The tag will however not be removed from the environment of a running container.
DELETE /v1/deployments/{request_id}/tags/{tag_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*
No content
[Rate Limit: 20/second] Retrieve the information for a deployment.
Unique Identifier to keep track of your request across all Arbitrium ecosystem. It's included in the response of the app deploy, example:
93924761ccde
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": "2025-06-20 12:00:43.066217",
"removal_time": "2025-06-20 12:00:43.066217",
"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
}[Rate Limit: 40/second] Create a new deployment. A deployment is a containerized instance of an application version running on the Edgegap platform.
The application you want to deploy a version of.
kart-racingThe application version you want to deploy a container, if not present, the last version created is automatically chosen.
production-v1.0(DEPRECATED) - No longer used and you don't need to set it.
falseThis 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.
(DEPRECATED)
["85cf70e6-f871-42c6-96f0-65ff5bd469b5"]If true, the deployment will skip the telemetry measurement. This result in a faster time to deploy.
trueA 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.
https://www.webhook.com/List of tags associated with the deployment. These tags will be shown in the dashboard.
(DEPRECATED) - No longer used and you don't need to set it.
basicPossible values: 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.
null | 'string'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.
null | 'string'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"
}Make a bulk delete of deployments using filters. All the deployments matching the given filters will be permanently deleted.
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"
}
]
}Update a fleet with new specifications.
The name of the fleet
Name of the Fleet
fleet_nameIf the Fleet is enabled
PATCH /v1/fleet/{fleet_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"name": "fleet_name",
"enabled": true
}{
"name": "fleet_name",
"enabled": true,
"create_time": "2022-01-01 00:00:00.000000",
"last_updated": "2022-01-01 00:00:00.000000"
}Create a fleet policy. Policies are conditions that the fleet must respect.
The name of the fleet
Name of the Policy
policy_nameIf the Policy is enabled. Defaults to true.
trueType of the Policy. See our documentation for more information on the type and it's data.
LocationPossible values: Minimum deployments at all time
1Maximum deployments for the provided type.
1Based on the number of sockets connected, how filled should a session deployment be before initiating a scale-up deployment. Float between 0.1 and 1.
0.9JSON object for your filters. See our documentation for more information.
{"filters":[{"field":"city","values":["Montreal"],"filter_type":"any"}]}POST /v1/fleet/{fleet_name}/policies HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 175
{
"name": "policy_name",
"enabled": true,
"type": "Location",
"minimum": 1,
"maximum": 1,
"threshold": 0.9,
"data": {
"filters": [
{
"field": "city",
"values": [
"Montreal"
],
"filter_type": "any"
}
]
}
}{
"name": "policy_name",
"enabled": true,
"type": "Location",
"minimum": 1,
"maximum": 1,
"threshold": 0.9,
"data": {
"filters": [
{
"field": "city",
"values": [
"Montreal"
],
"filter_type": "any"
}
]
},
"create_time": "2022-01-01 00:00:00.000000",
"last_updated": "2022-01-01 00:00:00.000000"
}Create a fleet. A fleet is a top-level object; you must create child resources to work properly.
Name of the Fleet
fleet_nameIf the Fleet is enabled. Defaults to false.
falsePOST /v1/fleet HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"name": "fleet_name",
"enabled": false
}{
"name": "fleet_name",
"enabled": false,
"create_time": "2022-01-01 00:00:00.000000",
"last_updated": "2022-01-01 00:00:00.000000"
}Update a policy with new specifications.
The name of the fleet
The name of the policy
Name of the Policy
policy_nameIf the Policy is enabled. Defaults to true.
trueType of the Policy. See our documentation for more information on the type and it's data.
LocationPossible values: Minimum deployments at all time
1Maximum deployments for the provided type.
1Based on the number of sockets connected, how filled should a session deployment be before initiating a scale-up deployment. Float between 0.1 and 1.
0.9JSON object for your filters. See our documentation for more information.
{"filters":[{"field":"city","values":["Montreal"],"filter_type":"any"}]}UTC time of policy creation
2022-01-01 00:00:00.000000UTC time of policy last update
2022-01-01 00:00:00.000000PATCH /v1/fleet/{fleet_name}/policies/{policy_name} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 262
{
"name": "policy_name",
"enabled": true,
"type": "Location",
"minimum": 1,
"maximum": 1,
"threshold": 0.9,
"data": {
"filters": [
{
"field": "city",
"values": [
"Montreal"
],
"filter_type": "any"
}
]
},
"create_time": "2022-01-01 00:00:00.000000",
"last_updated": "2022-01-01 00:00:00.000000"
}{
"name": "policy_name",
"enabled": true,
"type": "Location",
"minimum": 1,
"maximum": 1,
"threshold": 0.9,
"data": {
"filters": [
{
"field": "city",
"values": [
"Montreal"
],
"filter_type": "any"
}
]
},
"create_time": "2022-01-01 00:00:00.000000",
"last_updated": "2022-01-01 00:00:00.000000"
}Create a tag for a deployment. The tag will however not be injected into a running container.
The name of the tag
v1.0.0POST /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"
}Update a tag for a deployment.
The name of the tag
v1.0.0PATCH /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"
}