Getting started with the Developer API

The Developer API lets you do programmatically what you do in the console: create and manage Simple FTP Services, users, firewall rules, and query logs. It is a per-region REST API authenticated with an API key.

1. Create an API key

1. Log in to the console and open Account → API.
2. Select the region you want to work in - keys are per region, and a key only works against its own region's endpoint.
3. Create a new key. The key value is shown once, at creation - copy it into your secrets store; you will not see it again.

2. Make your first request

The API lives at https://developer-<region>.docevent.io, and every request carries the key in the x-api-key header. Verify your key with the /hello endpoint:

export KEY=your-api-key
curl -H "x-api-key: $KEY" https://developer-us-east-1.docevent.io/hello

A working key returns a greeting with your resolved account context:

{
  "message": "Welcome to the DocEvent Developer API",
  "sub": "your-sub-id",
  "email": "john@example.com",
  "username": "myusername"
}

3. Explore the API reference

The full API is published as an OpenAPI 3.1 specification with an interactive Swagger UI - the links live on the same Account → API page:

• Interactive reference - browse every endpoint, schema and authentication requirement, and try requests from the browser
• openapi.yaml / openapi.json - download the raw spec

To work in Postman: import the downloaded openapi.json (Import → select the file), then set the x-api-key header on the collection and point it at your region's base URL.

What you can automate

The API covers the Simple FTP Service lifecycle - listing, creating and deleting services, managing each service's users and their aliases, replacing firewall rules, and querying a service's logs. For a worked example, see Create a Simple FTP Service via the API.

Notes

• A key acts as your account - it can only see and manage your own services, but everything your account can do to them, the key can too. Treat it like a password.
• API keys are managed by the account owner; organisation members acting in an organisation manage keys from their own (non-acting) session.