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 Sessions API

Add and remove players or groups on a running deployment.

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

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

This API exposes 4 operations across 3 paths, and defines 2 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.

4 operations 3 paths 2 schemas 1 DELETE2 GET1 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 Sessions 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 4

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

Sessions 4

Add and remove players or groups on a running deployment.

POST
/v1/session
Create session
createSession body → 200
GET
/v1/session/{session_id}
Get session
getSession 1 param → 200
DELETE
/v1/session/{session_id}
Delete session
deleteSession 1 param → 200
GET
/v1/session/{session_id}/users
List session users
listSessionUsers 1 param → 200

Schemas 2

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

SessionCreate
object
5 properties 2 required
Session
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edgegap-sessions-api-openapi.yml Raw ↑

Other APIs Edgegap publishes across the network.

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