Deployments

Get a Deployment Status and Information

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

get/v1/status/{request_id}

Request

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

Path parameters

request_idstring required

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

93924761ccde

Response

Success

request_idstring required

The Unique ID of the Deployment's request

fqdnstring required

The FQDN that allow to connect to your Deployment

app_namestring required

The name of the deployed App

app_versionstring required

The version of the deployed App

current_statusstring required

The current status of the Deployment

runningboolean required

True if the current Deployment is ready to be connected and running

whitelisting_activeboolean required

True if the current Deployment is ACL protected

start_timestring required

Timestamp of the Deployment when it is up and running

removal_timestring

Timestamp of the end of the Deployment

elapsed_timeinteger required

Time since the Deployment is up and running in seconds

last_statusstring

The last status of the Deployment

errorboolean required

True if there is an error with the Deployment

error_detailstring

The error details of the Deployment

portsobject

public_ipstring required

The public IP

tagsstring[]

List of tags associated with the deployment

socketsinteger

The Capacity of the Deployment

sockets_usageinteger

The Capacity Usage of the Deployment

commandstring

The command to use in the container, null mean it will take the default of the container

argumentsstring

The arguments to use in the container, null mean it will take the default of the container

max_durationinteger required

The deployment's maximum duration is the time, in minutes, that the deployment will remain active before automatically closing.

Example response

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