canonical: https://jentic.com/apis/simplivpn.net/simplivpn

# Simplivpn SimpliVPNAPI

simplivpn.net/main version 1.0. The API exposes 7 endpoints secured with apiKey authentication.

## For AI agents

Programmatically getservers, getserversummaries. Covers 7 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- GetServers
- Register
- Login
- EnableUser
- DisableUser
- UsernameAvailable

## Use cases

### Developer Tools Operations

Use the SimpliVPNAPI to perform developer tools operations programmatically. The API provides 7 endpoints covering core functionality including getservers, getserversummaries, register.

Example prompt: Call GET /servers to getservers

### Automated Disable User Management

Automate disable user operations by combining multiple SimpliVPNAPI endpoints. Agents can getserversummaries and then register in a single workflow.

Example prompt: Call GET /server-summaries to getserversummaries, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SimpliVPNAPI endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'getservers', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/servers` | GetServers |
| GET | `/server-summaries` | GetServerSummaries |
| POST | `/register` | Register |
| POST | `/login` | Login |
| POST | `/enable-user` | EnableUser |
| POST | `/disable-user` | DisableUser |
| POST | `/username-available` | UsernameAvailable |

## Key resources

- **Disable User** — Operations for disable user
- **Enable User** — Operations for enable user
- **Login** — Operations for login
- **Register** — Operations for register
- **Server Summaries** — Operations for server summaries

## 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:** 58 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 56 / 100
  - AI-Readiness & Agent Experience: 42 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 45 / 100
- **View full report:** https://jentic.com/apis/simplivpn.net/simplivpn/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 SimpliVPN by hand means learning that its key rides in the Authorization header and carrying it across the server, registration, and user enable and disable calls yourself. Through Jentic you install once, import SimpliVPN from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** SimpliVPN carries its targets in the request body rather than as a resource id in the URL path, so scope the agent by operations: limit it to the operations it needs, such as listing servers or checking username availability, and leave out account changes like disabling a user unless you add them.
- **Credential handling:** Your SimpliVPN 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 'list VPN servers' or 'check if a username is available', and Jentic returns the matching SimpliVPN operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the SimpliVPNAPI use?

The SimpliVPNAPI uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I getservers with the SimpliVPNAPI?

Yes. Use the GET /servers endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SimpliVPNAPI?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I getservers through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'getservers'. Jentic returns the matching SimpliVPNAPI operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SimpliVPNAPI have?

The SimpliVPNAPI exposes 7 endpoints covering disable user, enable user, login operations.

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

Yes. Because Jentic One is self-hosted and governed by your own rules, you decide which SimpliVPN operations your agent may call and which credentials it may use. Since SimpliVPN passes its targets in the request body rather than as a resource ID in the URL, you scope the agent at the operation level: allow read-only calls like GET /servers and POST /username-available while withholding account changes such as POST /disable-user or POST /enable-user. Only the operations you approve are exposed to the agent, and your API key is injected at execution time without entering the agent's context.