Documentation

esc
    API reference · Using the API / Overview

    API reference

    Manage instances, networks, storage, databases and keys from code, whether that is scripts, CI pipelines, Terraform or AI agents, with an API key.

    The public API does everything the console does for your infrastructure: create and manage instances, VPC networks, firewalls, public IPs, volumes, snapshots, managed databases, SSH keys and webhooks, and read what they cost.

    HTTP
    https://api.pantechdynamics.com/public/v1

    Your first three calls

    You need an API key. Keep it in an environment variable, never in code.

    Terminal
    $ export PANTECH_API_KEY=PAN_…
    1. Check the key, and what it may do:

      Terminal
      $ curl https://api.pantechdynamics.com/public/v1/me \    -H "Authorization: Bearer $PANTECH_API_KEY"
    2. See what you can create. Plans are instance sizes; images are operating systems:

      Terminal
      $ curl https://api.pantechdynamics.com/public/v1/plans \    -H "Authorization: Bearer $PANTECH_API_KEY"$ curl https://api.pantechdynamics.com/public/v1/images \    -H "Authorization: Bearer $PANTECH_API_KEY"
    3. List your instances:

      Terminal
      $ curl https://api.pantechdynamics.com/public/v1/instances \    -H "Authorization: Bearer $PANTECH_API_KEY"

    From there, Examples builds a server end to end.

    How the API works

    These rules hold for every endpoint, so learn them once.

    • Authentication. Send your key on every request: Authorization: Bearer PAN_…. A read key can call every GET; a write key can also create, change and delete. See Authentication.
    • Changes are asynchronous. A write returns 202 Accepted with an operation_id. Poll the operation until its status is succeeded or failed. A new instance or database returns an order instead: an instance order or a database order.
    • Every write needs an Idempotency-Key. Send a fresh UUID per change, and the same one when you retry it. A retry never does the work twice.
    • Lists are paged. They return { "data": [...], "next_cursor": "…" }. Pass next_cursor back as cursor until it is null.
    • Errors say what went wrong. Every error is a JSON problem document with a stable code, like INSUFFICIENT_CREDIT. Branch on code. See Errors.
    • Rate limits are per key. Every response says how many requests you have left in RateLimit-Remaining.
    • Money is in minor units. amount_minor: 1059200 in NGN is ₦10,592.00. In USD it is cents.

    Requests and responses covers each of these in full.

    What you can manage

    Also: SSH keys, webhooks that tell you when something changes, the catalogue of plans, images and prices, operations, usage, billing and your key.

    For AI agents and tools

    The API is described by an OpenAPI 3.1 contract, and these docs are published as plain text, so an agent or a code generator can read them directly:

    Using the API from an AI agent explains how to give an agent safe access.

    What the API does not do

    Billing, payments, team members, invites, organization settings and API keys themselves are managed in the console only. A key cannot reach them, so a leaked key cannot change who has access or how you pay.

    Was this page helpful?

    Updated