Endpoints

An endpoint is the compute that serves a database. In Silos, the endpoint and the database are closely tied: creating a database provisions its endpoint, and starting or suspending compute maps to resuming or suspending the database.

If you're migrating from Neon, note that Silos folds the endpoint into the database resource — a database is its endpoint. The table below maps the common Neon endpoint operations to their Silos equivalents.

List endpoints

GET /v1/databases/{database_id}/endpoints

List the compute endpoints associated with a database.

curl https://api.silos.sh/v1/databases/db_abc123/endpoints \
  -H "Authorization: Bearer $SILOS_API_KEY"

{
  "endpoints": [
    {
      "id": "db_abc123",
      "database_id": "db_abc123",
      "region": "iad",
      "status": "active"
    }
  ]
}

Start an endpoint

Starting an endpoint resumes the database's compute. Use the database resume action:

POST /v1/databases/{id}/resume

curl -X POST https://api.silos.sh/v1/databases/db_abc123/resume \
  -H "Authorization: Bearer $SILOS_API_KEY"

{
  "database": {
    "id": "db_abc123",
    "status": "active"
  }
}

Suspend an endpoint

Suspending an endpoint stops the database's compute while retaining durable state:

POST /v1/databases/{id}/suspend

curl -X POST https://api.silos.sh/v1/databases/db_abc123/suspend \
  -H "Authorization: Bearer $SILOS_API_KEY"

{
  "database": {
    "id": "db_abc123",
    "status": "suspended"
  }
}