Deployments

Create a Deployment request.

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

post/v1/deploy

Request

Base URL: https://api.edgegap.com
URL: https://api.edgegap.com/v1/deploy
Auth: API key in header authorization

Request body

app_namestring required

The application you want to deploy a version of.

version_namestring

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

is_public_appboolean

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

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)

skip_telemetryboolean

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

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.

tagsstring[]

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

ap_sort_strategy'basic' | 'weighted'

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

commandstring nullable

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.

argumentsstring nullable

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 request

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

Response

Success

request_idstring required

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

request_dnsstring required

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

request_appstring required

The application that has been deployed.

request_versionstring required

The version of the application that has been deployed.

request_user_countinteger required

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

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_strategy'basic' | 'weighted'

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

Example response

{
  "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": {
    "endpoint_storage": "my-endpoint"
  },
  "location": {
    "latitude": 45.5,
    "longitude": -73.56
  },
  "ap_sort_strategy": "basic"
}

Changes

No recorded changes to this operation across all 1 revision of this API.