Dedicated Servers

PreviousAPI Reference NextIntegration

Last updated 2 days ago

Was this helpful?

Create a Deployment

Create a new deployment. Deployment is a server instance of your application version. Rate Limit: 40/second

post

/v1/deploy

Authorizations

Body

app_namestringrequired

The name of the App you want to deploy

Example: app_name

version_namestring

The name of the App Version you want to deploy, if not present, the last version created is picked

Example: version_name

is_public_appboolean

If the Application is public or private. If not specified, we will look for a private Application

ip_liststring[]

The List of IP of your user

geo_ip_listobject[]

The list of IP of your user with their location (latitude, longitude)

telemetry_profile_uuid_liststring[]

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

env_varsobject[]

A list of deployment variables

skip_telemetryboolean · default: true

If you want to skip the Telemetry and use a geolocations decision only

locationobject

If you want to specify a centroid for your deployment.

webhook_urlstring

A web URL. This url will be called with method POST. The deployment status will be send in JSON format

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

tagsstring[]

The list of tags for your deployment

container_log_storageobject

The container log storage options for the deployment

filtersobject[]

Filters to use while choosing the deployment location.

ap_sort_strategystring · enum

Algorithm used to select the edge location

Example: basic

Options: basic, weighted

commandstring | null

Allows to override the Container command for this deployment.

Example: null, "string"

argumentsstring | null

Allows to override the Container arguments for this deployment.

Example: null, "string"

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/deploy' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "app_name": "app_name",
    "version_name": "version_name",
    "is_public_app": true,
    "ip_list": [
      "1.2.3.4"
    ],
    "geo_ip_list": [
      {
        "ip": "1.1.1.1",
        "latitude": 1,
        "longitude": 1
      }
    ],
    "telemetry_profile_uuid_list": [
      "85cf70e6-f871-42c6-96f0-65ff5bd469b5"
    ],
    "env_vars": [
      {
        "key": "MY_KEY",
        "value": "my-value",
        "is_hidden": true
      }
    ],
    "skip_telemetry": true,
    "location": {
      "latitude": 1,
      "longitude": 1
    },
    "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\""
  }'

200

400

401

409

422

{
  "request_id": "93924761ccde",
  "request_dns": "supermario.93924761ccde.edgelab.io",
  "request_app": "supermario",
  "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"
  }
}

Success

Get a Deployment Status and Information

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

get

/v1/status/{request_id}

Authorizations

Path parameters

request_idanyrequired

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

93924761ccde

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/status/{request_id}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

500

{
  "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-03-09 12:02:11.891819",
  "removal_time": "2025-03-09 12:02:11.891819",
  "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
}

Success

Delete a Deployment

Delete an instance of deployment. It will stop the running container and all its games.

delete

/v1/stop/{request_id}

Authorizations

Path parameters

request_idanyrequired

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

93924761ccde

Query parameters

container_log_storageany

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/stop/{request_id}' \
  --header 'authorization: YOUR_API_KEY'

200

202

400

401

403

404

410

500

{
  "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-03-09 12:02:11.891819",
    "removal_time": "2025-03-09 12:02:11.891819",
    "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
  }
}

Success

Delete a Deployment from inside the container

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.

delete

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

Path parameters

request_idanyrequired

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_idanyrequired

Access Point Number provided by our system

Query parameters

container_log_storageany

Header parameters

authorizationanyrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/self/stop/{request_id}/{access_point_id}'

200

202

400

401

403

404

500

{
  "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-03-09 12:02:11.891819",
    "removal_time": "2025-03-09 12:02:11.891819",
    "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
  }
}

Success

Delete Deployments in Bulk

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

post

/v1/deployments/bulk-stop

Authorizations

Body

filtersobject[]required

Filters used to match with deployments

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/deployments/bulk-stop' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": [
      {
        "field": "request_id",
        "values": [
          "c0653765de3b"
        ],
        "filter_type": "any"
      }
    ]
  }'

202

400

401

500

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

Accepted

List All Deployments

List all deployments. Rate Limit: 10/second

get

/v1/deployments

Authorizations

Query parameters

queryany

Query to filter the deployments.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/deployments' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

500

{
  "data": [
    {
      "request_id": "2d35052ec4e9",
      "fqdn": "abc123.test.edgegap.com",
      "start_time": "2025-03-09 12:02:11.891819",
      "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": [
    ""
  ]
}

Success

List All Locations

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.

get

/v1/locations

Authorizations

Query parameters

appany

The App Name you want to filter with capacity

versionany

The Version Name you want to filter with capacity

typeany

The type of the location

tagsany

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/locations' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

500

{
  "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": [
    ""
  ]
}

Success

Get Deployment Container Logs

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. <a target='_blank' href='https://docs.edgegap.com/docs/deployment/endpoint-storage'>Endpoint Storage Documentation</a>

get

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

Authorizations

Path parameters

request_idanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/deployment/{request_id}/container-logs' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

500

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

Success

Get a Deployment Metrics

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.

get

/v1/metrics/deployment/{request_id}

Authorizations

Path parameters

request_idanyrequired

Query parameters

start_timeany

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_timeany

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

stepsany

Steps between each metrics.

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

rawany

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/metrics/deployment/{request_id}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

422

500

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

Success

Update a Fleet

Update a fleet with new specifications.

patch

/v1/fleet/{fleet_name}

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

Body

namestring

Name of the Fleet

Example: fleet_name

enabledboolean

If the Fleet is enabled

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "fleet_name",
    "enabled": true
  }'

200

400

401

404

500

{
  "name": "fleet_name",
  "enabled": true,
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

Get a Fleet

Retrieve a fleet with its details.

get

/v1/fleet/{fleet_name}

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "name": "fleet_name",
  "enabled": false,
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

List All Fleets

List all the fleets you own.

get

/v1/fleets

Authorizations

Query parameters

pageany

Page number for pagination

limitany

Limit of Fleet for each page

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/fleets' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

500

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

Success

Delete a Fleet

Delete a fleet, its policies and links between the application versions.

delete

/v1/fleet/{fleet_name}

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "message": "text"
}

Success

Create a Fleet Policy

Create a fleet policy. Policies are conditions that the fleet must respect.

post

/v1/fleet/{fleet_name}/policies

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

Body

namestringrequired

Name of the Policy

Example: policy_name

enabledbooleanrequired

If the Policy is enabled. Defaults to true.

Example: true

typestring · enumrequired

Type of the Policy. See our documentation for more information on the type and it's data.

Example: Location

Options: Location, Tag, Coordinates

minimuminteger · min: 1required

Minimum deployments at all time

Example: 1

maximuminteger · min: 1required

Maximum deployments for the provided type.

Example: 1

thresholdnumber · min: 0.1 · max: 1 · default: 0.9required

Based 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.

dataobjectrequired

JSON object for your filters. See our documentation for more information.

Example: {"filters":[{"field":"city","values":["Montreal"],"filter_type":"any"}]}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}/policies' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "policy_name",
    "enabled": true,
    "type": "Location",
    "minimum": 1,
    "maximum": 1,
    "threshold": 0.9,
    "data": {
      "filters": [
        {
          "field": "city",
          "values": [
            "Montreal"
          ],
          "filter_type": "any"
        }
      ]
    }
  }'

200

400

401

404

500

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

Success

Create a Fleet

Create a fleet. A fleet is a top-level object; you must create child resources to work properly.

post

/v1/fleet

Authorizations

Body

namestringrequired

Name of the Fleet

Example: fleet_name

enabledboolean · default: false

If the Fleet is enabled. Defaults to false.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/fleet' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "fleet_name",
    "enabled": false
  }'

200

400

401

500

{
  "name": "fleet_name",
  "enabled": false,
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000"
}

Success

List All Policies of a Fleet

List all the policies of a fleet.

get

/v1/fleet/{fleet_name}/policies

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

Query parameters

pageany

Page number for pagination

limitany

Limit of Fleet for each page

Header parameters

X-Fieldsany

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}/policies' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

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

Success

Link an Application Version to a Fleet

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.

put

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

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

app_nameanyrequired

The name of the application to link

version_nameanyrequired

The name of the application version to link

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}/app/{app_name}/version/{version_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

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

Success

Unlink an Application Version From a Fleet

Unlink an application version from a fleet. It will not delete the application version or the fleet

delete

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

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

app_nameanyrequired

The name of the application to link

version_nameanyrequired

The name of the application version to link

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}/app/{app_name}/version/{version_name}' \
  --header 'authorization: YOUR_API_KEY'

204

400

401

404

500

No body

Success

Delete a Policy

Delete a policy. It will not delete the fleet.

delete

/v1/fleet/{fleet_name}/policies/{policy_name}

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

policy_nameanyrequired

The name of the policy to delete

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}/policies/{policy_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "message": "text"
}

Get a Policy

Retrieve a specific policy of a fleet.

get

/v1/fleet/{fleet_name}/policies/{policy_name}

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

policy_nameanyrequired

The name of the policy

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}/policies/{policy_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

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

Success

Update a Policy

Update a policy with new specifications.

patch

/v1/fleet/{fleet_name}/policies/{policy_name}

Authorizations

Path parameters

fleet_nameanyrequired

The name of the fleet

policy_nameanyrequired

The name of the policy

Body

namestring

Name of the Policy

Example: policy_name

enabledboolean

If the Policy is enabled. Defaults to true.

Example: true

typestring · enum

Type of the Policy. See our documentation for more information on the type and it's data.

Example: Location

Options: Location, Tag, Coordinates

minimuminteger

Minimum deployments at all time

Example: 1

maximuminteger · min: 1

Maximum deployments for the provided type.

Example: 1

thresholdnumber · min: 0.1 · max: 1

Based 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.

Example: 0.9

dataobject

JSON object for your filters. See our documentation for more information.

Example: {"filters":[{"field":"city","values":["Montreal"],"filter_type":"any"}]}

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.edgegap.com//v1/fleet/{fleet_name}/policies/{policy_name}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

400

401

404

500

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

Success

List tags for a Deployment

List tags for a deployment.

get

/v1/deployments/{request_id}/tags

Authorizations

Path parameters

request_idanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/deployments/{request_id}/tags' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

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

Success

Get tag for a Deployment

Get tag for a deployment.

get

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

Authorizations

Path parameters

request_idanyrequired

tag_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/deployments/{request_id}/tags/{tag_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

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

Success

Create Tag for a Deployment

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

post

/v1/deployments/{request_id}/tags

Authorizations

Path parameters

request_idanyrequired

Body

namestring · max: 20required

The name of the tag

Example: v1.0.0

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/deployments/{request_id}/tags' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "v1.0.0"
  }'

200

400

401

404

409

500

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

Success

Delete Tag for a Deployment

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}

Authorizations

Path parameters

request_idanyrequired

tag_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/deployments/{request_id}/tags/{tag_name}' \
  --header 'authorization: YOUR_API_KEY'

204

400

401

404

500

No body

No Content

Update Tag for a Deployment

Update a tag for a deployment.

patch

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

Authorizations

Path parameters

request_idanyrequired

tag_nameanyrequired

Body

namestring · max: 20required

The name of the tag

Example: v1.0.0

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.edgegap.com//v1/deployments/{request_id}/tags/{tag_name}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "v1.0.0"
  }'

200

400

401

404

409

500

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

Success

Dedicated Servers

Dedicated Servers

⚡ Deployments

🚢 Smart Fleets

🔖 Tags

⚡ Deployments

🚢 Smart Fleets

🔖 Tags

Create a Deployment

Get a Deployment Status and Information

Delete 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

Update a Fleet

Get a Fleet

List All Fleets

Delete a Fleet

Create a Fleet Policy

Create a Fleet

List All Policies of a Fleet

Link an Application Version to a Fleet

Unlink an Application Version From a Fleet

Delete a Policy

Get a Policy

Update a Policy

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

⚡ Deployments

🚢 Smart Fleets

🔖 Tags

⚡ Deployments

🚢 Smart Fleets

🔖 Tags

Create a Deployment

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Get a Deployment Status and Information

Delete a Deployment

Delete a Deployment from inside the container

Delete Deployments in Bulk

Show child attributes

List All Deployments

List All Locations

Get Deployment Container Logs

Get a Deployment Metrics

Update a Fleet

Get a Fleet

List All Fleets

Delete a Fleet

Create a Fleet Policy

Create a Fleet

List All Policies of a Fleet

Link an Application Version to a Fleet

Unlink an Application Version From a Fleet

Delete a Policy

Get a Policy

Update a Policy

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