Endpoint Management API

This reference covers the APIs for managing database endpoints in Eve.

Overview

Endpoints are managed connections to databases, model providers, HTTP services, SaaS APIs, and infrastructure APIs. Each endpoint has an organization-scoped identity, kind-specific configuration, credentials, and governance state.

Endpoint governance applies across endpoint kinds: control-plane RBAC protects configuration, data-plane RBAC protects runtime use, backend credentials stay server-side, and optional templates, interlays, masking, backend profiles, mirror mode, VPN routes, and audit evidence can be layered on top.

Create Endpoint

Create a new endpoint connection.

Request

http

POST /api/v1/endpoints
Content-Type: application/json
Authorization: Bearer <token>

Body Parameters

Field	Type	Required	Description
`endpoint`	string	Yes	Unique endpoint identifier
`kind`	string	Yes	Database type (postgres, mysql, mongo, redis, cassandra, clickhouse, pinecone, http)
`config`	object	Yes	Database-specific configuration
`description`	string	No	Endpoint description
`backend_profile`	string	No	`production` or `development` backend lane
`backend_pool_limits`	object	No	Optional production/development pool capacity caps

PostgreSQL Example

bash

curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "endpoint": "my_postgres",
    "kind": "postgres",
    "config": {
      "write_conn": {
        "url": "postgresql://user:password@host:5432/database"
      }
    },
    "description": "Production PostgreSQL database"
  }'

MySQL Example

bash

curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "endpoint": "my_mysql",
    "kind": "mysql",
    "config": {
      "write_conn": {
        "url": "mysql://user:password@host:3306/database"
      }
    }
  }'

MongoDB Example

bash

curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "endpoint": "my_mongo",
    "kind": "mongo",
    "config": {
      "db_name": "mydb",
      "write_conn": {
        "url": "mongodb://user:password@host:27017"
      }
    }
  }'

Redis Example

Redis supports both URL format and host/port configuration:

bash

# Using host/port (recommended)
curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "endpoint": "my_redis",
    "kind": "redis",
    "config": {
      "write_conn": {
        "host": "redis-host",
        "port": 6379,
        "tls": false
      }
    },
    "description": "Redis cache endpoint"
  }'

bash

# Using URL format
curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "endpoint": "my_redis",
    "kind": "redis",
    "config": {
      "write_conn": {
        "host": "host", "port": 6379
      }
    }
  }'

Response

json

{
  "status": "success",
  "data": {
    "id": "my_postgres",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "kind": "Postgres",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

List Endpoints

Get all endpoints in your organization.

Request

http

GET /api/v1/endpoints
Authorization: Bearer <token>

Example

bash

curl http://{host}:8000/api/v1/endpoints \
  -H "Authorization: Bearer $TOKEN"

Response

json

{
  "status": "success",
  "data": {
    "endpoints": [
      {
        "id": "my_postgres",
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "kind": "Postgres",
        "created_at": "2024-01-15T10:30:00Z"
      },
      {
        "id": "my_redis",
        "uuid": "550e8400-e29b-41d4-a716-446655440001",
        "kind": "Redis",
        "created_at": "2024-01-15T11:00:00Z"
      }
    ]
  }
}

Get Endpoint

Get details of a specific endpoint.

Request

http

GET /api/v1/endpoints/{id}
Authorization: Bearer <token>

Example

bash

curl http://{host}:8000/api/v1/endpoints/my_postgres \
  -H "Authorization: Bearer $TOKEN"

Response

json

{
  "status": "success",
  "data": {
    "id": "my_postgres",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "kind": "Postgres",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Backend Profiles

Endpoint create, update, get, and list responses can include backend_profile. When omitted, Eden uses production. Setting it to development routes every invocation of that endpoint through the endpoint's dedicated development profile route and fails closed if that route is not configured.

json

{
  "backend_profile": "development",
  "backend_pool_limits": {
    "total_max_connections": 80,
    "production_max_connections": 64,
    "development_max_connections": 32
  }
}

Use backend profiles to separate live application traffic from developer, agent, JIT, request-analysis, or masking-heavy traffic.

Endpoint Node Placement

Endpoint node placement records which Eden nodes can serve an endpoint. VPN routes require the selected route node to be registered for the interlay endpoint and in an available or degraded status.

http

GET /api/v1/endpoints/{endpoint}/nodes
Authorization: Bearer <token>

http

PUT /api/v1/endpoints/{endpoint}/nodes/{eden_node_uuid}
Authorization: Bearer <token>
Content-Type: application/json

json

{
  "pool_role": "active",
  "connection_status": "available",
  "priority": 0,
  "weight": 100,
  "metadata": {
    "region": "us-east-1"
  }
}

Update Endpoint

Update an endpoint's configuration.

Request

http

PATCH /api/v1/endpoints/{endpoint}
Content-Type: application/json
Authorization: Bearer <token>

Example

bash

curl http://{host}:8000/api/v1/endpoints/my_postgres \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -X PATCH \
  -d '{
    "config": {
      "write_conn": {
        "url": "postgresql://user:newpassword@host:5432/database"
      }
    }
  }'

Response

json

{
  "status": "success",
  "data": {
    "id": "my_postgres",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "kind": "Postgres",
    "updated_at": "2024-01-16T10:30:00Z"
  }
}

Delete Endpoint

Remove an endpoint.

Request

http

DELETE /api/v1/endpoints/{id}
Authorization: Bearer <token>

Example

bash

curl http://{host}:8000/api/v1/endpoints/my_postgres \
  -H "Authorization: Bearer $TOKEN" \
  -X DELETE

Response

json

{
  "status": "success",
  "data": {
    "message": "Endpoint deleted successfully"
  }
}

Test Connection

Verify connectivity to an endpoint.

Request

http

POST /api/v1/endpoints/{id}/test
Authorization: Bearer <token>

Example

bash

curl http://{host}:8000/api/v1/endpoints/my_postgres/test \
  -H "Authorization: Bearer $TOKEN" \
  -X POST

Response

json

{
  "status": "success",
  "data": {
    "connected": true,
    "latency_ms": 15
  }
}

Configuration Options

Connection URL Format

Each database type uses a specific URL format:

Database	URL Format
PostgreSQL	`postgresql://user:pass@host:5432/database`
MySQL	`mysql://user:pass@host:3306/database`
MongoDB	`mongodb://user:pass@host:27017/database`
Redis	`redis://host:6379` or `redis://:pass@host:6379`
Cassandra	`cassandra://user:pass@host:9042/keyspace`
ClickHouse	`clickhouse://user:pass@host:8123/database`

Read Replicas

Configure read replicas for load distribution:

bash

curl http://{host}:8000/api/v1/endpoints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "endpoint": "my_postgres",
    "kind": "postgres",
    "config": {
      "write_conn": {
        "url": "postgresql://user:pass@primary:5432/db"
      },
      "read_conn": {
        "url": "postgresql://user:pass@replica:5432/db"
      }
    }
  }'

Access Control

Operation	Required Access
Connect endpoint	Admin
List endpoints	Read
Get endpoint	Read
Update endpoint	Admin
Delete endpoint	Admin
Test connection	Read

Error Responses

Invalid Configuration

json

{
  "error": "Invalid configuration",
  "message": "Connection URL is required"
}

Connection Failed

json

{
  "error": "Connection failed",
  "message": "Unable to connect to database: connection refused"
}

Endpoint Not Found

json

{
  "error": "Not found",
  "message": "Endpoint 'my_postgres' does not exist"
}

Duplicate ID

json

{
  "error": "Conflict",
  "message": "Endpoint with id 'my_postgres' already exists"
}

Best Practices

Connection Security

Use SSL/TLS connections when available
Store credentials securely
Use dedicated database users with minimal permissions

Naming Conventions

Use descriptive, lowercase IDs
Include environment or purpose in name (e.g., prod_users_db, staging_cache)

Connection Management

Test connections after creation
Monitor endpoint health
Update credentials before they expire

Query Execution - Execute queries on endpoints
Transactions - Atomic operations
Endpoint Governance - Shared endpoint governance model
Endpoint Types - Endpoint-category and connection guides

Last updated: July 10, 2026

Endpoint Management API

Overview

Create Endpoint

Request

Body Parameters

PostgreSQL Example

MySQL Example

MongoDB Example

Redis Example

Response

List Endpoints

Request

Example

Response

Get Endpoint

Request

Example

Response

Backend Profiles

Endpoint Node Placement

Update Endpoint

Request

Example

Response

Delete Endpoint

Request

Example

Response

Test Connection

Request

Example

Response

Configuration Options

Connection URL Format

Read Replicas

Access Control

Error Responses

Invalid Configuration

Connection Failed

Endpoint Not Found

Duplicate ID

Best Practices

Connection Security

Naming Conventions

Connection Management

Related