Edge Network Deploy API

openapi: 3.2.0
info:
  title: Edge Network Agent Deploy API
  version: 1.1.0
  description: 'REST API built for AI agents: provision and manage CDN, compute VMs, S3-compatible object storage, DNS, Shield bot protection, and Assist AI site answers on the Edge Network decentralised cloud. Every response includes a tell_user field with a human-readable summary. Every mutating operation supports X-Dry-Run: true (preview without changes) and Idempotency-Key (safe retries). Agents without credentials can sign themselves up autonomously via /agent/signup (Ed25519 keypair + proof-of-work — no card, no human) and immediately deploy free-tier resources. Also available as an MCP server: https://edge.network/mcp (streamable HTTP) or npx @edge-network/mcp (stdio).


    Versioning: the current major version is 1, signalled by the X-API-Version response header on every response. Additive changes (new endpoints, new optional fields) ship without a version bump and never break existing integrations. Breaking changes ship under a new URL prefix (e.g. /agent/v2/) with at least 6 months of overlap; during the migration window the old surface returns Deprecation and Sunset headers (RFC 8594). Full policy: https://edge.network/docs/api/versioning.


    Rate limits: responses carry IETF RateLimit-Limit / RateLimit-Remaining / RateLimit-Reset headers (plus RateLimit-Policy); 429 responses include Retry-After.'
  contact:
    name: Edge Network support
    email: support@edge.network
    url: https://edge.network/support
  termsOfService: https://edge.network/terms
servers:
- url: https://edge.network
  description: Production
security:
- agentCode: []
tags:
- name: Deploy
  description: 'High-level orchestration: files or repo in, live URL out.'
paths:
  /agent/deploy/static-site:
    post:
      operationId: deployStaticSite
      summary: Deploy a static website
      description: 'One call from files to live URL: creates a storage bucket, uploads files (base64 upload or git clone), configures CDN, domain, SSL, and DNS. Free tier eligible.'
      tags:
      - Deploy
      responses:
        '201':
          description: Deployed. The response includes the live URL.
          headers:
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TellUserEnvelope'
        '400':
          description: Validation error — the response body explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid agent access code. The body includes self-signup pointers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: X-Dry-Run
        in: header
        required: false
        description: Set to "true" to preview the operation (validation, cost, plan) without making changes.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: Idempotency-Key
        in: header
        required: false
        description: Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                project:
                  type: string
                  description: Project name (created if it does not exist).
                source:
                  type: object
                  description: Where the files come from.
                  properties:
                    type:
                      type: string
                      enum:
                      - upload
                      - git
                      description: '"upload" for base64 files, "git" to clone a repository.'
                    files:
                      type: array
                      items:
                        $ref: '#/components/schemas/UploadFile'
                      description: Required for type "upload".
                    repo:
                      type: string
                      description: Required for type "git". GitHub/GitLab URL or "user/repo" shorthand.
                    branch:
                      type: string
                      default: main
                      description: Git branch or tag.
                    path:
                      type: string
                      description: Subdirectory to deploy (e.g. "dist"). Repository root if omitted.
                    token:
                      type: string
                      description: Personal access token for private repositories.
                  required:
                  - type
                domain:
                  type: string
                  description: Custom domain to serve from. SSL auto-provisioned.
                options:
                  type: object
                  properties:
                    spa_mode:
                      type: boolean
                      description: Single-page-app fallback routing.
                    image_optimization:
                      type: boolean
              required:
              - project
              - source
      security:
      - agentCode: []
  /agent/deploy/app:
    post:
      operationId: deployApp
      summary: Deploy an application on a VM
      description: Creates a VM, runs a setup script (library script id or inline bash), and optionally fronts it with CDN and DNS. Pass ssh_key or ssh_key_ids to enable SSH access.
      tags:
      - Deploy
      responses:
        '201':
          description: VM provisioning started. Poll getVm until status is "running".
          headers:
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TellUserEnvelope'
        '400':
          description: Validation error — the response body explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid agent access code. The body includes self-signup pointers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: X-Dry-Run
        in: header
        required: false
        description: Set to "true" to preview the operation (validation, cost, plan) without making changes.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: Idempotency-Key
        in: header
        required: false
        description: Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                project:
                  type: string
                  description: Project name.
                compute:
                  type: object
                  properties:
                    os:
                      type: string
                      default: ubuntu-24.04
                    size:
                      type: string
                      enum:
                      - nano
                      - small
                      - medium
                      - large
                      - xlarge
                      description: nano 1vCPU/1GB · small 1/2 · medium 2/4 · large 4/8 · xlarge 8/16.
                    region:
                      type: string
                      default: london
                    script:
                      type: string
                      description: Startup script id from GET /agent/compute/scripts (preferred over setup_script).
                    script_params:
                      type: object
                      additionalProperties: true
                      description: Parameters for the chosen script.
                    setup_script:
                      type: string
                      description: Inline bash to run on first boot.
                    ssh_key:
                      type: string
                      description: SSH public key string; auto-saved and attached.
                    ssh_key_ids:
                      type: array
                      items:
                        type: string
                      description: Existing SSH key ids to attach.
                  required:
                  - size
                security_group_ids:
                  type: array
                  items:
                    type: string
                networking:
                  type: object
                  properties:
                    firewall_rules:
                      type: array
                      items:
                        type: object
                        properties:
                          port:
                            type: number
                          protocol:
                            type: string
                            default: tcp
                            enum:
                            - tcp
                            - udp
                          source:
                            type: string
                            default: 0.0.0.0/0
                        required:
                        - port
                domain:
                  type: string
                cdn:
                  type: object
                  properties:
                    enabled:
                      type: boolean
              required:
              - project
              - compute
      security:
      - agentCode: []
  /agent/deploy/{projectId}:
    patch:
      operationId: updateDeployment
      summary: Re-deploy a project
      description: Upload changed files to an existing deployment and optionally purge the CDN cache. Set changed_only to skip files whose MD5 matches.
      tags:
      - Deploy
      responses:
        '200':
          description: Success.
          headers:
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TellUserEnvelope'
        '400':
          description: Validation error — the response body explains what to fix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid agent access code. The body includes self-signup pointers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.
          headers:
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            X-API-Version:
              $ref: '#/components/headers/XApiVersion'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: projectId
        in: path
        required: true
        description: Project id returned by the original deploy.
        schema:
          type: string
      - name: X-Dry-Run
        in: header
        required: false
        description: Set to "true" to preview the operation (validation, cost, plan) without making changes.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: Idempotency-Key
        in: header
        required: false
        description: Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                source:
                  type: object
                  properties:
                    files:
                      type: array
                      items:
                        $ref: '#/components/schemas/UploadFile'
                    changed_only:
                      type: boolean
                      description: Skip unchanged files (MD5 comparison).
                purge_cdn:
                  type: boolean
                  description: Purge the CDN cache after upload.
      security:
      - agentCode: []
components:
  headers:
    XApiVersion:
      description: Current API major version. Breaking changes ship under a new URL prefix with Deprecation/Sunset headers on the old surface. See https://edge.network/docs/api/versioning.
      schema:
        type: string
        example: '1'
    RateLimitPolicy:
      description: 'Quota policy: "<limit>;w=<window-seconds>", e.g. "600;w=60".'
      schema:
        type: string
        example: 600;w=60
    RateLimitLimit:
      description: Request quota for the current window (IETF draft-ietf-httpapi-ratelimit-headers).
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Seconds until the quota resets.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying (sent with 429 responses).
      schema:
        type: integer
  schemas:
    UploadFile:
      type: object
      properties:
        path:
          type: string
          description: File path/key, e.g. "index.html" or "assets/style.css".
        content:
          type: string
          description: Base64-encoded file content.
        content_type:
          type: string
          description: MIME type. Auto-detected from the extension if omitted.
      required:
      - path
      - content
    TellUserEnvelope:
      type: object
      description: Standard success envelope. Endpoint-specific fields ride alongside tell_user.
      properties:
        tell_user:
          type: string
          description: Human-readable summary of what happened, for the agent to relay to its operator.
      additionalProperties: true
      required:
      - tell_user
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code, e.g. VALIDATION_ERROR.
            message:
              type: string
              description: What went wrong.
            suggestions:
              type: array
              items:
                type: string
              description: Concrete next steps for the agent.
            tell_user:
              type: string
              description: Plain-English summary to relay to the operator.
          required:
          - code
          - message
      required:
      - error
  securitySchemes:
    agentCode:
      type: http
      scheme: bearer
      bearerFormat: ea_live_...
      description: Agent access code. Get one from the Edge console (Account → Agent Access) or autonomously via GET /agent/signup. Public endpoints (discovery, prompt, signup) need no credentials.
externalDocs:
  description: Agent API documentation
  url: https://edge.network/docs/agent