1. Registry
  2. Packages
  3. Neon Provider
  4. API Docs
  5. getBranchEndpoints
Viewing docs for neon 0.18.0
published on Saturday, Sep 12, 2026 by kislerdm
Viewing docs for neon 0.18.0
published on Saturday, Sep 12, 2026 by kislerdm

    Fetch Branch Endpoints

    Using getBranchEndpoints

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBranchEndpoints(args: GetBranchEndpointsArgs, opts?: InvokeOptions): Promise<GetBranchEndpointsResult>
    function getBranchEndpointsOutput(args: GetBranchEndpointsOutputArgs, opts?: InvokeOutputOptions): Output<GetBranchEndpointsResult>
    def get_branch_endpoints(branch_id: Optional[str] = None,
                             endpoints: Optional[Sequence[GetBranchEndpointsEndpoint]] = None,
                             id: Optional[str] = None,
                             project_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetBranchEndpointsResult
    def get_branch_endpoints_output(branch_id: pulumi.Input[Optional[str]] = None,
                             endpoints: pulumi.Input[Optional[Sequence[pulumi.Input[GetBranchEndpointsEndpointArgs]]]] = None,
                             id: pulumi.Input[Optional[str]] = None,
                             project_id: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOutputOptions] = None) -> Output[GetBranchEndpointsResult]
    func GetBranchEndpoints(ctx *Context, args *GetBranchEndpointsArgs, opts ...InvokeOption) (*GetBranchEndpointsResult, error)
    func GetBranchEndpointsOutput(ctx *Context, args *GetBranchEndpointsOutputArgs, opts ...InvokeOption) GetBranchEndpointsResultOutput

    > Note: This function is named GetBranchEndpoints in the Go SDK.

    public static class GetBranchEndpoints 
    {
        public static Task<GetBranchEndpointsResult> InvokeAsync(GetBranchEndpointsArgs args, InvokeOptions? opts = null)
        public static Output<GetBranchEndpointsResult> Invoke(GetBranchEndpointsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetBranchEndpointsResult> Invoke(GetBranchEndpointsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetBranchEndpointsResult> getBranchEndpoints(GetBranchEndpointsArgs args, InvokeOptions options)
    public static Output<GetBranchEndpointsResult> getBranchEndpoints(GetBranchEndpointsArgs args, InvokeOptions options)
    public static Output<GetBranchEndpointsResult> getBranchEndpoints(GetBranchEndpointsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: neon:index/getBranchEndpoints:getBranchEndpoints
      arguments:
        # arguments dictionary
    data "neon_get_branch_endpoints" "name" {
        # arguments
    }

    The following arguments are supported:

    BranchId string
    Branch ID.
    ProjectId string
    Project ID.
    Endpoints List<GetBranchEndpointsEndpoint>
    Id string
    The ID of this resource.
    BranchId string
    Branch ID.
    ProjectId string
    Project ID.
    Endpoints []GetBranchEndpointsEndpoint
    Id string
    The ID of this resource.
    branch_id string
    Branch ID.
    project_id string
    Project ID.
    endpoints list(object)
    id string
    The ID of this resource.
    branchId String
    Branch ID.
    projectId String
    Project ID.
    endpoints List<GetBranchEndpointsEndpoint>
    id String
    The ID of this resource.
    branchId string
    Branch ID.
    projectId string
    Project ID.
    endpoints GetBranchEndpointsEndpoint[]
    id string
    The ID of this resource.
    branch_id str
    Branch ID.
    project_id str
    Project ID.
    endpoints Sequence[GetBranchEndpointsEndpoint]
    id str
    The ID of this resource.
    branchId String
    Branch ID.
    projectId String
    Project ID.
    endpoints List<Property Map>
    id String
    The ID of this resource.

    getBranchEndpoints Result

    The following output properties are available:

    BranchId string
    Branch ID.
    Id string
    The ID of this resource.
    ProjectId string
    Project ID.
    Endpoints List<GetBranchEndpointsEndpoint>
    BranchId string
    Branch ID.
    Id string
    The ID of this resource.
    ProjectId string
    Project ID.
    Endpoints []GetBranchEndpointsEndpoint
    branch_id string
    Branch ID.
    id string
    The ID of this resource.
    project_id string
    Project ID.
    endpoints list(object)
    branchId String
    Branch ID.
    id String
    The ID of this resource.
    projectId String
    Project ID.
    endpoints List<GetBranchEndpointsEndpoint>
    branchId string
    Branch ID.
    id string
    The ID of this resource.
    projectId string
    Project ID.
    endpoints GetBranchEndpointsEndpoint[]
    branch_id str
    Branch ID.
    id str
    The ID of this resource.
    project_id str
    Project ID.
    endpoints Sequence[GetBranchEndpointsEndpoint]
    branchId String
    Branch ID.
    id String
    The ID of this resource.
    projectId String
    Project ID.
    endpoints List<Property Map>

    Supporting Types

    GetBranchEndpointsEndpoint

    AutoscalingLimitMaxCu double
    Maximal value of the compute autoscaling limit.
    AutoscalingLimitMinCu double
    Minimal value of the compute autoscaling limit.
    Host string
    Endpoint URI.
    HostPooling string
    Endpoint URI for connection pooling.
    Id string
    Endpoint ID.
    Name string
    Compute name.
    ProxyHost string
    RegionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    SuspendTimeoutSeconds double
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended.
    Type string
    Access type.
    AutoscalingLimitMaxCu float64
    Maximal value of the compute autoscaling limit.
    AutoscalingLimitMinCu float64
    Minimal value of the compute autoscaling limit.
    Host string
    Endpoint URI.
    HostPooling string
    Endpoint URI for connection pooling.
    Id string
    Endpoint ID.
    Name string
    Compute name.
    ProxyHost string
    RegionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    SuspendTimeoutSeconds float64
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended.
    Type string
    Access type.
    autoscaling_limit_max_cu number
    Maximal value of the compute autoscaling limit.
    autoscaling_limit_min_cu number
    Minimal value of the compute autoscaling limit.
    host string
    Endpoint URI.
    host_pooling string
    Endpoint URI for connection pooling.
    id string
    Endpoint ID.
    name string
    Compute name.
    proxy_host string
    region_id string
    Deployment region: https://neon.tech/docs/introduction/regions
    suspend_timeout_seconds number
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended.
    type string
    Access type.
    autoscalingLimitMaxCu Double
    Maximal value of the compute autoscaling limit.
    autoscalingLimitMinCu Double
    Minimal value of the compute autoscaling limit.
    host String
    Endpoint URI.
    hostPooling String
    Endpoint URI for connection pooling.
    id String
    Endpoint ID.
    name String
    Compute name.
    proxyHost String
    regionId String
    Deployment region: https://neon.tech/docs/introduction/regions
    suspendTimeoutSeconds Double
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended.
    type String
    Access type.
    autoscalingLimitMaxCu number
    Maximal value of the compute autoscaling limit.
    autoscalingLimitMinCu number
    Minimal value of the compute autoscaling limit.
    host string
    Endpoint URI.
    hostPooling string
    Endpoint URI for connection pooling.
    id string
    Endpoint ID.
    name string
    Compute name.
    proxyHost string
    regionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    suspendTimeoutSeconds number
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended.
    type string
    Access type.
    autoscaling_limit_max_cu float
    Maximal value of the compute autoscaling limit.
    autoscaling_limit_min_cu float
    Minimal value of the compute autoscaling limit.
    host str
    Endpoint URI.
    host_pooling str
    Endpoint URI for connection pooling.
    id str
    Endpoint ID.
    name str
    Compute name.
    proxy_host str
    region_id str
    Deployment region: https://neon.tech/docs/introduction/regions
    suspend_timeout_seconds float
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended.
    type str
    Access type.
    autoscalingLimitMaxCu Number
    Maximal value of the compute autoscaling limit.
    autoscalingLimitMinCu Number
    Minimal value of the compute autoscaling limit.
    host String
    Endpoint URI.
    hostPooling String
    Endpoint URI for connection pooling.
    id String
    Endpoint ID.
    name String
    Compute name.
    proxyHost String
    regionId String
    Deployment region: https://neon.tech/docs/introduction/regions
    suspendTimeoutSeconds Number
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended.
    type String
    Access type.

    Package Details

    Repository
    neon kislerdm/terraform-provider-neon
    License
    Notes
    This Pulumi package is based on the neon Terraform Provider.
    Viewing docs for neon 0.18.0
    published on Saturday, Sep 12, 2026 by kislerdm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial