Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edgegap Deployments API

Deploy, inspect, and stop dedicated game servers at the edge.

Edgegap Deployments API is one of 8 APIs that Edgegap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deployments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 7 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.edgegap.com.

8 operations 7 paths 3 schemas 1 DELETE4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.edgegap.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Edgegap Deployments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (AuthToken). By default, every request must be authenticated.

  • AuthToken — API token generated in the Edgegap dashboard (User Settings / Tokens), sent as Authorization: token .

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Deployments 8

Deploy, inspect, and stop dedicated game servers at the edge.

POST
/v2/deployments
Create deployment
createDeployment body → 200
GET
/v1/deployments
List deployments
listDeployments → 200
GET
/v1/status/{deployment_id}
Get deployment status
getDeploymentStatus 1 param → 200
DELETE
/v1/stop/{deployment_id}
Stop deployment
stopDeployment 1 param → 200
POST
/v1/deployments/bulk-stop
Bulk stop deployments
bulkStopDeployments body → 200
GET
/v1/deployment/{deployment_id}/container-logs
Get container logs
getContainerLogs 1 param → 200
GET
/v1/deployments/{deployment_id}/tags
List deployment tags
listDeploymentTags 1 param → 200
POST
/v1/deployments/{deployment_id}/tags
Add deployment tag
addDeploymentTag 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Deployment (9 properties), DeploymentCreate (5 properties), DeploymentList (2 properties). Each schema is shown below with its type and property counts.

Deployment
object
9 properties
DeploymentList
object
2 properties
DeploymentCreate
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edgegap-deployments-api-openapi.yml Raw ↑

Other APIs Edgegap publishes across the network.

Edgegap App Versions API
Edgegap Applications API
Edgegap Fleets API
Edgegap Matchmaking API
Edgegap Metrics API
Edgegap Relays API
Edgegap Sessions API