v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB

Endpoint

Retrieve compute endpoint details

Retrieves information about the specified compute endpoint. A compute endpoint is a Neon compute instance. An endpoint_id has an ep- prefix. For information about compute endpoints, see Manage computes.

get/projects/{project_id}/endpoints/{endpoint_id}

Response

Returned information about the specified endpoint

Example response

{
  "endpoint": {
    "host": "ep-silent-smoke-806639.us-east-2.aws.neon.tech",
    "id": "ep-silent-smoke-806639",
    "name": "My cool compute",
    "project_id": "spring-example-302709",
    "branch_id": "br-wispy-meadow-118737",
    "autoscaling_limit_min_cu": 1,
    "autoscaling_limit_max_cu": 1,
    "region_id": "aws-us-east-2",
    "type": "read_write",
    "current_state": "init",
    "pending_state": "active",
    "settings": {
      "pg_settings": {}
    },
    "pooler_enabled": false,
    "pooler_mode": "transaction",
    "disabled": false,
    "passwordless_access": true,
    "creation_source": "console",
    "created_at": "2022-12-03T15:37:07Z",
    "updated_at": "2022-12-03T15:37:07Z",
    "proxy_host": "us-east-2.aws.neon.tech",
    "suspend_timeout_seconds": 0,
    "provisioner": "k8s-neonvm"
  }
}