Sign in
Endpoint

Suspend compute endpoint

Changed on

Suspends the specified compute endpoint. An endpoint_id has an ep- prefix. For information about compute endpoints, see Manage computes.

post/projects/{project_id}/endpoints/{endpoint_id}/suspend

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/endpoints/{endpoint_id}/suspend
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Response

Suspended 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"
  },
  "operations": [
    {
      "id": "d8ac46eb-a757-42b1-9907-f78322ee394e",
      "project_id": "spring-example-302709",
      "branch_id": "br-wispy-meadow-118737",
      "endpoint_id": "ep-silent-smoke-806639",
      "action": "start_compute",
      "status": "finished",
      "failures_count": 0,
      "created_at": "2022-11-15T20:02:00Z",
      "updated_at": "2022-11-15T20:02:02Z",
      "total_duration_ms": 200
    }
  ]
}

Changes

  • 97bbba80d23bRevision changes
    • ●

      added the new epc_sync enum value to the ////// response property for the response status

  • af816419f5e7Revision changes
    • ●

      added the new tenant_attach_safekeepers enum value to the ////// response property for the response status

    • ●

      added the new tenant_detach_safekeepers enum value to the ////// response property for the response status