Deployments

Stop a deployment

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.

delete/v1/stop/{request_id}

Request

Base URL: https://api.edgegap.com
URL: https://api.edgegap.com/v1/stop/{request_id}
Auth: API key in header authorization

Path parameters

request_idstring required

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

93924761ccde

Query parameters

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.

Response

Success

messagestring required

A message depending of the request termination

Example response

{
  "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-10-19 16:00:08.730124",
    "removal_time": "2026-10-19 16:00:08.730124",
    "last_status": "Status.SEEKING",
    "error": true,
    "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"
      }
    ],
    "location": {
      "city": "Montreal",
      "country": "Canada",
      "continent": "North America",
      "administrative_division": "Quebec",
      "timezone": "Eastern Time",
      "latitude": 45.508888,
      "longitude": -73.561668
    },
    "tags": [
      "production"
    ]
  }
}

Changes

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