Serveurs dédiés
⚡ Déploiements
[Rate Limit: 40 req/s] Create a new deployment - containerized instance of an application version.
*/*application/jsonName of the application that will be deployed
my-game-serverName of the version within the application that will be deployed
25.05.30-16.45.19-04Deploy faster by limiting placement to locations with cached image.
falseList of tags to associate with the deployment
my-custom-tagDeployment Request Accepted
ID of your deployment, also referred to as request ID.
a69f8e3e0555Client Side Request Error
Unauthorized - Missing Token
Couldn't Allocate Server
Internal Server Error
POST /v2/deployments HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 134
{
"application": "my-game-server",
"version": "production",
"users": [
{
"user_type": "ip_address",
"user_data": {
"ip_address": "75.28.35.192"
}
}
]
}{
"request_id": "a69f8e3e0555"
}[Rate Limit: 20 req/s] Get the specified deployment status and information.
61b1be8f54d9*/*application/jsonSuccess
ID of your deployment, also referred to as request ID.
c0653765de3bFQDN (URL) to connect to the deployment.
c0653765de3b.pr.edgegap.netPublic IP address of the host.
192.53.120.48Application which has been deployed.
testApp version which has been deployed.
v1Indicates whether deployment is Ready, in Error, or otherwise.
Status.SEEKINGTrue if deployment is Ready for connections.
trueExample: trueTimestamp of deployment becoming Ready.
2026-04-22 12:00:46.444265Seconds since deployment becoming Ready.
Maximum allowed uptime minutes of deployments before automatically stopped.
1440Timestamp of deployment stopped.
2026-04-22 12:00:46.444265Previous status of deployment.
Status.SEEKINGIndicates an error with the deployment.
falseExample: trueDetails of the error.
Pull image timeout exceededList of tags to mark your deployments for easy filtering.
productionOverrides container command for the deployment, use with caution.
echo "hi" && sleep infinityOverrides container arguments for the deployment, use with caution.
Bad Request
Unauthorized
Internal Server Error
GET /v1/status/{deployment_id} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
Accept: */*
{
"request_id": "c0653765de3b",
"fqdn": "c0653765de3b.pr.edgegap.net",
"public_ip": "192.53.120.48",
"app_name": "test",
"app_version": "v1",
"current_status": "Status.SEEKING",
"running": true,
"start_time": "2026-04-22 12:00:46.444265",
"elapsed_time": 1,
"max_duration": 1440,
"removal_time": "2026-04-22 12:00:46.444265",
"last_status": "Status.SEEKING",
"error": true,
"error_detail": "Pull image timeout exceeded",
"ports": {
"gameport": {
"name": "gameport",
"link": "https://c66980ae5bf1.pr.edgegap.net:30345",
"internal": 7777,
"external": 30345,
"protocol": "UDP",
"tls_upgrade": false
}
},
"location": {
"city": "Montreal",
"country": "Canada",
"continent": "North America",
"administrative_division": "Quebec",
"timezone": "Eastern Time",
"latitude": 45.508888,
"longitude": -73.561668
},
"tags": [
"production"
],
"command": "echo \"hi\" && sleep infinity",
"arguments": "text"
}[Rate Limit: 10 req/s] List all deployments, optionally filtered and sorted.
Query to filter the deployments. See filtering guide. For client integrations, consider Server Browser instead.
{"filters":[{"field":"status","operator":"eq","value":"ready"}]}220*/*application/jsonSuccess
Additional information related to your query.
[""]100Bad Request
Unauthorized
Internal Server Error
GET /v1/deployments HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
Accept: */*
{
"data": [
{
"request_id": "2d35052ec4e9",
"fqdn": "abc123.test.edgegap.com",
"ready": true,
"start_time": "2026-04-22 12:00:46.444265",
"public_ip": "100.10.0.85",
"ports": {
"gameport": {
"name": "gameport",
"link": "https://c66980ae5bf1.pr.edgegap.net:30345",
"internal": 7777,
"external": 30345,
"protocol": "UDP",
"tls_upgrade": false
}
},
"tags": [
"production"
]
}
],
"message": [
""
],
"total_count": 100,
"pagination": {
"number": 1,
"next_page_number": 2,
"previous_page_number": 1,
"paginator": {
"num_pages": 10
},
"has_next": true,
"has_previous": false
}
}Request to stop a deployment from your custom backend, 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.
61b1be8f54d9Enable or disable previously configured log storage. Alternatively, provide endpoint storage ID to override or set storage to upload logs.
true*/*application/jsonSuccess
Additional information regarding deployment termination.
1a9e4ff02cce - Delete request will be processed soonAccepted
Bad Request
Unauthorized
Forbidden
Not Found
Instance Already terminated
Internal Server Error
DELETE /v1/stop/{deployment_id} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
Accept: */*
{
"message": "1a9e4ff02cce - Delete request will be processed soon",
"deployment_summary": {
"request_id": "c0653765de3b",
"fqdn": "c0653765de3b.pr.edgegap.net",
"public_ip": "192.53.120.48",
"app_name": "test",
"app_version": "v1",
"current_status": "Status.SEEKING",
"running": true,
"start_time": "2026-04-22 12:00:46.444265",
"elapsed_time": 1,
"max_duration": 1440,
"removal_time": "2026-04-22 12:00:46.444265",
"last_status": "Status.SEEKING",
"error": true,
"error_detail": "Pull image timeout exceeded",
"ports": {
"gameport": {
"name": "gameport",
"link": "https://c66980ae5bf1.pr.edgegap.net:30345",
"internal": 7777,
"external": 30345,
"protocol": "UDP",
"tls_upgrade": false
}
},
"location": {
"city": "Montreal",
"country": "Canada",
"continent": "North America",
"administrative_division": "Quebec",
"timezone": "Eastern Time",
"latitude": 45.508888,
"longitude": -73.561668
},
"tags": [
"production"
],
"command": "echo \"hi\" && sleep infinity",
"arguments": "text"
}
}Delete multiple deployments using custom filtering. Caution is advised.
*/*application/jsonAccepted
Bad Request
Unauthorized
Internal Server Error
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"
}
]
}Delete a deployment from the inside of a container, available as injected variable ARBITRIUM_DELETE_URL.
61b1be8f54d9660Enable or disable previously configured log storage. Alternatively, provide endpoint storage ID to override or set storage to upload logs.
trueAuto Generated token. This token is injected in your deployment and can be found via the environment variable named ARBITRIUM_DELETE_TOKEN
*/*application/jsonSuccess
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
DELETE /v1/self/stop/{deployment_id}/{stop_key} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
authorization: text
Content-Type: text
Accept: */*
Aucun contenu
Retrieve the logs of your container, if Endpoint Storage was configured before stopping the deployment.
ID of your deployment, also referred to as request ID.
61b1be8f54d9Requested output format. text returns plain-text lines, ndjson returns newline-delimited JSON carrying timestamped lines.
textExample: ndjsonValeurs possibles: */*application/jsonSuccess
Plaintext deployment success logs.
Logs of the containerPlaintext deployment crash logs.
Logs of the container when it crashedEncoding used for logs.
utf-8Link to retrieve logs from your configured Endpoint Storage.
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /v1/deployment/{deployment_id}/container-logs HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
Accept: */*
{
"logs": "Logs of the container",
"crash_logs": "Logs of the container when it crashed",
"crash_data": {
"exit_code": 0,
"message": "OOM killed",
"restart_count": 0
},
"encoding": "utf-8",
"logs_link": "text"
}Get metrics for the specified deployment in a given time range.
61b1be8f54d9Start of reporting time range, defaults to deployment start time.
2021-07-10 00:00:00.00End of reporting time range, default to deployment stopped time. Must be greater than start time.
2021-07-10 00:00:00.00Size of reporting time step between metric values, aggregated using average (mean).
30sOptionally enable raw output.
falseExample: false*/*application/jsonSuccess
Bad Request
Unauthorized
Not Found
Unprocessable
Internal Server Error
GET /v1/metrics/deployment/{deployment_id} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
Accept: */*
{
"total": {
"receive_total": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
},
"transmit_total": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
},
"disk_read_total": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
},
"disk_write_total": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
}
},
"cpu": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
},
"cpu_throttle_rate": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
},
"cpu_throttle_total": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
},
"mem": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
},
"network": {
"receive": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
},
"transmit": {
"labels": [
"00:00:00"
],
"datasets": [
1
],
"timestamps": [
"2021-07-14 14:17:37.711"
]
}
}
}🗺️ Flottes privées
[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.
*/*application/jsonPreferred and prioritized Private Host IDs to try before overflowing to cloud.
alpha-north-america-95fab093Name of the application that will be deployed
my-game-serverName of the version within the application that will be deployed
25.05.30-16.45.19-04Deploy faster by limiting placement to locations with cached image.
falseList of tags to associate with the deployment
my-custom-tagID of your deployment, also referred to as request ID.
a69f8e3e0555Invalid Application or Application Version. No deployment has been created
Unauthorized. No deployment has been created.
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
Internal Server Error
POST /v2/private-fleets/deployments HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 651
{
"private_host_ids": [
"alpha-north-america-95fab093"
],
"application": "my-game-server",
"version": "25.05.30-16.45.19-04",
"resources": {
"cpu_units": 1536,
"memory_mib": 3072
},
"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"
}[Rate Limit: 10/seconds] List all hosts in a private fleet.
Name of your private fleet.
test-fleet*/*application/json100GET /v2/private-fleets/{fleet-name}/hosts HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
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": 1,
"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
}
}
],
"total_count": 100,
"pagination": {
"number": 1,
"next_page_number": 2,
"previous_page_number": 1,
"paginator": {
"num_pages": 10
},
"has_next": true,
"has_previous": false
}
}🔖 Étiquettes
Create a tag for the specified deployment. Does not modify injected variables in a running deployment.
f68e011bfb01*/*application/jsonName of the tag.
developmentSuccess
Name of the tag.
developmentDate of creation.
2026-04-22 20:30:52.283949Date of last update.
2026-04-22 20:30:52.283949Bad Request
Unauthorized
Not Found
Conflict
Internal Server Error
POST /v1/deployments/{deployment_id}/tags HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"name": "development"
}{
"name": "development",
"create_time": "2026-04-22 20:30:52.283949",
"last_updated": "2026-04-22 20:30:52.283949"
}Get tag from the specified deployment.
f68e011bfb01player-id-1234*/*application/jsonSuccess
Name of the tag.
developmentDate of creation.
2026-04-22 20:30:52.283949Date of last update.
2026-04-22 20:30:52.283949Bad Request
Unauthorized
Not Found
Internal Server Error
GET /v1/deployments/{deployment_id}/tags/{tag_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
Accept: */*
{
"name": "development",
"create_time": "2026-04-22 20:30:52.283949",
"last_updated": "2026-04-22 20:30:52.283949"
}List tags from the specified deployment.
f68e011bfb01220*/*application/jsonSuccess
100Bad Request
Unauthorized
Not Found
Internal Server Error
GET /v1/deployments/{deployment_id}/tags HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
Accept: */*
{
"tags": [
{
"name": "development",
"create_time": "2026-04-22 20:30:52.283949",
"last_updated": "2026-04-22 20:30:52.283949"
}
],
"total_count": 100,
"pagination": {
"number": 1,
"next_page_number": 2,
"previous_page_number": 1,
"paginator": {
"num_pages": 10
},
"has_next": true,
"has_previous": false
}
}Update a tag for the specified deployment. Does not modify injected variables.
f68e011bfb01player-id-1234*/*application/jsonName of the tag.
developmentSuccess
Name of the tag.
developmentDate of creation.
2026-04-22 20:30:52.283949Date of last update.
2026-04-22 20:30:52.283949Bad Request
Unauthorized
Not Found
Conflict
Internal Server Error
PATCH /v1/deployments/{deployment_id}/tags/{tag_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"name": "development"
}{
"name": "development",
"create_time": "2026-04-22 20:30:52.283949",
"last_updated": "2026-04-22 20:30:52.283949"
}Delete a tag for a deployment. Does not modify injected variables.
f68e011bfb01player-id-1234*/*application/jsonNo Content
Aucun contenu
Bad Request
Unauthorized
Not Found
Internal Server Error
DELETE /v1/deployments/{deployment_id}/tags/{tag_name} HTTP/1.1
Host: api.edgegap.com
Authorization: YOUR_API_KEY
Content-Type: text
Accept: */*
Aucun contenu
Mis à jour
Ce contenu vous a-t-il été utile ?