Skip to contents

Returns a tibble with metadata about the specified PostgreSQL compute endpoint in the specified project of a Neon Database server from its GET /projects/{project_id}/endpoints/{endpoint_id} API endpoint.

Usage

endpoint(
  endpoint_id = funky::config_val("endpoint_id"),
  project_id = funky::config_val("project_id"),
  origin = funky::config_val("origin"),
  api_key = funky::config_val("api_key"),
  max_tries = 3L
)

Arguments

endpoint_id

character(1)
Neon compute endpoint identifier.

project_id

character(1)
Neon project identifier.

origin

character(1)
Neon server origin.

api_key

character(1)
API key with sufficient access to the Neon project_id.

max_tries

Maximum number of request attempts in case of an HTTP error. An integerish scalar. Retries are performed using exponential backoff and jitter, see httr2::req_retry() for details.

Value

A tibble

See also

Other functions to manage Neon's compute endpoints: endpoints(), restart_endpoint(), start_endpoint(), suspend_endpoint(), wake_endpoint()