canonical: https://jentic.com/apis/edgegap.com/edgegap

# Edgegap v2 API

The Edgegap v2 API lets AI agents deploy containerized applications onto Edgegap's global edge network. An agent submits a deployment and Edgegap places the container at a low-latency location close to the end users, which suits multiplayer game servers and other latency-sensitive workloads. Agents can also target a private fleet of their own hosts and list the machines registered in that fleet before deploying. Every request carries an API key.

## For AI agents

Deploy containerized applications to the Edgegap edge network or a private fleet, and list fleet hosts. Authenticates with an API key.

## Scope

Does not build container images or manage billing. Use for edge and private-fleet deployment only.

## Capabilities

- Deploy a containerized application to the Edgegap edge network
- Deploy an application to a private fleet of your own hosts
- List the hosts registered in a private fleet

## Use cases

### Agent-Driven Edge Deployment via Jentic

AI agents deploy to Edgegap through Jentic without holding the API key in context. An agent searches by intent, receives the deployment schema, and launches a containerized workload at the edge end to end. Jentic injects the key at execution time, so the agent never sees the secret while it places servers close to end users.

Example prompt: Search Jentic for 'deploy an Edgegap application', load the POST /deployments schema, and launch the deployment with Jentic-managed credentials

### Latency-Optimized Game Server Deployment

An agent responds to a spike in players by deploying a fresh game server instance to the edge, where Edgegap places it near the players to cut round-trip latency. The agent can repeat this per region or match, scaling capacity where demand appears instead of running fixed central servers.

Example prompt: Call POST /deployments to place a game server container at the edge location closest to the players

### Private Fleet Deployment

An agent that manages its own hardware lists the hosts registered in a private fleet, confirms which are available, and then deploys the application onto that fleet. This keeps workloads on infrastructure the operator controls while still using Edgegap's deployment pipeline.

Example prompt: Call GET `/private-fleets/{fleet-name}/hosts` to check host availability, then POST `/private-fleets/deployments` to deploy

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/deployments` | Deploy a containerized application to the edge network |
| POST | `/private-fleets/deployments` | Deploy an application to a private fleet |
| GET | `/private-fleets/{fleet-name}/hosts` | List the hosts registered in a private fleet |

## Key resources

- **Deployments** — Deploy containerized applications to the Edgegap edge network
- **Private Fleets** — Deploy to your own hosts and list the machines registered in a fleet

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 69 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 81 / 100
  - AI-Readiness & Agent Experience: 52 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 67 / 100
- **View full report:** https://jentic.com/apis/edgegap.com/edgegap/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Edgegap v2 API by hand means setting the Authorization API key header and shaping the deployment request for the edge network or a private fleet yourself. Through Jentic you install once, import the Edgegap v2 API from the API Directory, store the key, and your agent calls it.
- **Permission scoping:** You choose which Edgegap operations your agent may call, so a rule can let it list fleet hosts and deploy while keeping other operations out. Scoping is by operation, so a deployment call runs only when you grant it.
- **Credential handling:** Your Edgegap API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'deploy to the edge' or 'list fleet hosts', and Jentic returns the matching Edgegap operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **DigitalOcean** — Alternative cloud platform for deploying and hosting workloads
- **Render** — Alternative platform for deploying containers and services
- **Linode** — Alternative cloud hosting for compute instances

## FAQ

### What authentication does the Edgegap v2 API use?

The Edgegap v2 API authenticates requests with an API key passed in the Authorization header, per its OpenAPI spec. Through Jentic, the key is stored encrypted by your own Jentic One instance and injected at call time, so it never enters the agent's prompt or logs.

### Can I deploy to a private fleet with the Edgegap v2 API?

Yes. Deploy to your own hosts with POST `/private-fleets/deployments`, and list the hosts in a fleet with GET `/private-fleets/{fleet-name}/hosts` before you deploy.

### What are the rate limits for the Edgegap v2 API?

The OpenAPI spec does not specify rate limits; check the Edgegap documentation for current limits. Through Jentic, requests run from your own instance, so you control the pacing of the agent's calls.

### How do I deploy an application with the Edgegap v2 API through Jentic?

Search Jentic for 'deploy an Edgegap application', load the returned POST /deployments operation with its input schema, and your agent launches the deployment with credentials injected at call time. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Is there an Edgegap MCP server?

You don't need an MCP server to give your agent the Edgegap v2 API. Jentic connects it directly from the API Directory: import it, store your key, and your agent calls it, discovering operations on demand instead of loading a separate server's tool definitions into its context.

### Can I limit what my agent is allowed to do with the Edgegap v2 API?

Yes. You choose which Edgegap operations your agent may call, so you can let it list fleet hosts without launching a deployment, or restrict it to fleet deployments only. Scoping is by operation, so the agent invokes only the endpoints you approve.