Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Cloudfoundry Provider
  4. API Docs
  5. getRoute
Viewing docs for cloudfoundry 1.18.0
published on Monday, Nov 2, 2026 by cloudfoundry
Schema (JSON)
cloudfoundry/terraform-provider-cloudfoundry

cloudfoundry.getRoute

cloudfoundry
Viewing docs for cloudfoundry 1.18.0
published on Monday, Nov 2, 2026 by cloudfoundry
Schema (JSON)
cloudfoundry/terraform-provider-cloudfoundry

    Gets information on a Cloud Foundry route.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudfoundry from "@pulumi/cloudfoundry";

const route = cloudfoundry.getRoute({
    domain: "a25ca0c1-353a-40f9-bcf4-d2a0adf4112b",
});

    import pulumi
import pulumi_cloudfoundry as cloudfoundry

route = cloudfoundry.get_route(domain="a25ca0c1-353a-40f9-bcf4-d2a0adf4112b")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/cloudfoundry/cloudfoundry"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfoundry.LookupRoute(ctx, &cloudfoundry.LookupRouteArgs{
			Domain: "a25ca0c1-353a-40f9-bcf4-d2a0adf4112b",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudfoundry = Pulumi.Cloudfoundry;

return await Deployment.RunAsync(() => 
{
    var route = Cloudfoundry.GetRoute.Invoke(new()
    {
        Domain = "a25ca0c1-353a-40f9-bcf4-d2a0adf4112b",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudfoundry.CloudfoundryFunctions;
import com.pulumi.cloudfoundry.inputs.GetRouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var route = CloudfoundryFunctions.getRoute(GetRouteArgs.builder()
            .domain("a25ca0c1-353a-40f9-bcf4-d2a0adf4112b")
            .build());

    }
}

    variables:
  route:
    fn::invoke:
      function: cloudfoundry:getRoute
      arguments:
        domain: a25ca0c1-353a-40f9-bcf4-d2a0adf4112b

    Example coming soon!

    Using getRoute

    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 getRoute(args: GetRouteArgs, opts?: InvokeOptions): Promise<GetRouteResult>
function getRouteOutput(args: GetRouteOutputArgs, opts?: InvokeOutputOptions): Output<GetRouteResult>
    def get_route(domain: Optional[str] = None,
              host: Optional[str] = None,
              org: Optional[str] = None,
              path: Optional[str] = None,
              port: Optional[float] = None,
              space: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRouteResult
def get_route_output(domain: pulumi.Input[Optional[str]] = None,
              host: pulumi.Input[Optional[str]] = None,
              org: pulumi.Input[Optional[str]] = None,
              path: pulumi.Input[Optional[str]] = None,
              port: pulumi.Input[Optional[float]] = None,
              space: pulumi.Input[Optional[str]] = None,
              opts: Optional[InvokeOutputOptions] = None) -> Output[GetRouteResult]
    func LookupRoute(ctx *Context, args *LookupRouteArgs, opts ...InvokeOption) (*LookupRouteResult, error)
func LookupRouteOutput(ctx *Context, args *LookupRouteOutputArgs, opts ...InvokeOption) LookupRouteResultOutput

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

    public static class GetRoute 
{
    public static Task<GetRouteResult> InvokeAsync(GetRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteResult> Invoke(GetRouteInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteResult> Invoke(GetRouteInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)
public static Output<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)
public static Output<GetRouteResult> getRoute(GetRouteArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: cloudfoundry:index/getRoute:getRoute
  arguments:
    # arguments dictionary
    data "cloudfoundry_get_route" "name" {
    # arguments
}

    The following arguments are supported:

    Domain string
    The domain guid associated to the route.
    Host string
    The hostname associated to the route to lookup.
    Org string
    The org guid associated to the route to lookup.
    Path string
    The path associated to the route to lookup.
    Port double
    The port associated to the route to lookup.
    Space string
    The space guid associated to the route.
    Domain string
    The domain guid associated to the route.
    Host string
    The hostname associated to the route to lookup.
    Org string
    The org guid associated to the route to lookup.
    Path string
    The path associated to the route to lookup.
    Port float64
    The port associated to the route to lookup.
    Space string
    The space guid associated to the route.
    domain string
    The domain guid associated to the route.
    host string
    The hostname associated to the route to lookup.
    org string
    The org guid associated to the route to lookup.
    path string
    The path associated to the route to lookup.
    port number
    The port associated to the route to lookup.
    space string
    The space guid associated to the route.
    domain String
    The domain guid associated to the route.
    host String
    The hostname associated to the route to lookup.
    org String
    The org guid associated to the route to lookup.
    path String
    The path associated to the route to lookup.
    port Double
    The port associated to the route to lookup.
    space String
    The space guid associated to the route.
    domain string
    The domain guid associated to the route.
    host string
    The hostname associated to the route to lookup.
    org string
    The org guid associated to the route to lookup.
    path string
    The path associated to the route to lookup.
    port number
    The port associated to the route to lookup.
    space string
    The space guid associated to the route.
    domain str
    The domain guid associated to the route.
    host str
    The hostname associated to the route to lookup.
    org str
    The org guid associated to the route to lookup.
    path str
    The path associated to the route to lookup.
    port float
    The port associated to the route to lookup.
    space str
    The space guid associated to the route.
    domain String
    The domain guid associated to the route.
    host String
    The hostname associated to the route to lookup.
    org String
    The org guid associated to the route to lookup.
    path String
    The path associated to the route to lookup.
    port Number
    The port associated to the route to lookup.
    space String
    The space guid associated to the route.

    getRoute Result

    The following output properties are available:

    Domain string
    The domain guid associated to the route.
    Id string
    The provider-assigned unique ID for this managed resource.
    Routes List<GetRouteRoute>
    The list of routes.
    Host string
    The hostname associated to the route to lookup.
    Org string
    The org guid associated to the route to lookup.
    Path string
    The path associated to the route to lookup.
    Port double
    The port associated to the route to lookup.
    Space string
    The space guid associated to the route.
    Domain string
    The domain guid associated to the route.
    Id string
    The provider-assigned unique ID for this managed resource.
    Routes []GetRouteRoute
    The list of routes.
    Host string
    The hostname associated to the route to lookup.
    Org string
    The org guid associated to the route to lookup.
    Path string
    The path associated to the route to lookup.
    Port float64
    The port associated to the route to lookup.
    Space string
    The space guid associated to the route.
    domain string
    The domain guid associated to the route.
    id string
    The provider-assigned unique ID for this managed resource.
    routes list(object)
    The list of routes.
    host string
    The hostname associated to the route to lookup.
    org string
    The org guid associated to the route to lookup.
    path string
    The path associated to the route to lookup.
    port number
    The port associated to the route to lookup.
    space string
    The space guid associated to the route.
    domain String
    The domain guid associated to the route.
    id String
    The provider-assigned unique ID for this managed resource.
    routes List<GetRouteRoute>
    The list of routes.
    host String
    The hostname associated to the route to lookup.
    org String
    The org guid associated to the route to lookup.
    path String
    The path associated to the route to lookup.
    port Double
    The port associated to the route to lookup.
    space String
    The space guid associated to the route.
    domain string
    The domain guid associated to the route.
    id string
    The provider-assigned unique ID for this managed resource.
    routes GetRouteRoute[]
    The list of routes.
    host string
    The hostname associated to the route to lookup.
    org string
    The org guid associated to the route to lookup.
    path string
    The path associated to the route to lookup.
    port number
    The port associated to the route to lookup.
    space string
    The space guid associated to the route.
    domain str
    The domain guid associated to the route.
    id str
    The provider-assigned unique ID for this managed resource.
    routes Sequence[GetRouteRoute]
    The list of routes.
    host str
    The hostname associated to the route to lookup.
    org str
    The org guid associated to the route to lookup.
    path str
    The path associated to the route to lookup.
    port float
    The port associated to the route to lookup.
    space str
    The space guid associated to the route.
    domain String
    The domain guid associated to the route.
    id String
    The provider-assigned unique ID for this managed resource.
    routes List<Property Map>
    The list of routes.
    host String
    The hostname associated to the route to lookup.
    org String
    The org guid associated to the route to lookup.
    path String
    The path associated to the route to lookup.
    port Number
    The port associated to the route to lookup.
    space String
    The space guid associated to the route.

    Supporting Types

    GetRouteRoute

    Annotations Dictionary<string, string>
    The annotations associated with Cloud Foundry resources.
    CreatedAt string
    The date and time when the resource was created in RFC3339 format.
    Destinations List<GetRouteRouteDestination>
    A destination represents the relationship between a route and a resource that can serve traffic.
    Domain string
    The domain guid associated to the route.
    Host string
    The hostname associated to the route to lookup.
    Id string
    The GUID of the object.
    Labels Dictionary<string, string>
    The labels associated with Cloud Foundry resources.
    Path string
    The path associated to the route to lookup.
    Port double
    The port associated to the route to lookup.
    Protocol string
    The protocol supported by the route, based on the route's domain configuration.
    Space string
    The space guid associated to the route.
    UpdatedAt string
    The date and time when the resource was updated in RFC3339 format.
    Url string
    The URL for the route.
    Annotations map[string]string
    The annotations associated with Cloud Foundry resources.
    CreatedAt string
    The date and time when the resource was created in RFC3339 format.
    Destinations []GetRouteRouteDestination
    A destination represents the relationship between a route and a resource that can serve traffic.
    Domain string
    The domain guid associated to the route.
    Host string
    The hostname associated to the route to lookup.
    Id string
    The GUID of the object.
    Labels map[string]string
    The labels associated with Cloud Foundry resources.
    Path string
    The path associated to the route to lookup.
    Port float64
    The port associated to the route to lookup.
    Protocol string
    The protocol supported by the route, based on the route's domain configuration.
    Space string
    The space guid associated to the route.
    UpdatedAt string
    The date and time when the resource was updated in RFC3339 format.
    Url string
    The URL for the route.
    annotations map(string)
    The annotations associated with Cloud Foundry resources.
    created_at string
    The date and time when the resource was created in RFC3339 format.
    destinations list(object)
    A destination represents the relationship between a route and a resource that can serve traffic.
    domain string
    The domain guid associated to the route.
    host string
    The hostname associated to the route to lookup.
    id string
    The GUID of the object.
    labels map(string)
    The labels associated with Cloud Foundry resources.
    path string
    The path associated to the route to lookup.
    port number
    The port associated to the route to lookup.
    protocol string
    The protocol supported by the route, based on the route's domain configuration.
    space string
    The space guid associated to the route.
    updated_at string
    The date and time when the resource was updated in RFC3339 format.
    url string
    The URL for the route.
    annotations Map<String,String>
    The annotations associated with Cloud Foundry resources.
    createdAt String
    The date and time when the resource was created in RFC3339 format.
    destinations List<GetRouteRouteDestination>
    A destination represents the relationship between a route and a resource that can serve traffic.
    domain String
    The domain guid associated to the route.
    host String
    The hostname associated to the route to lookup.
    id String
    The GUID of the object.
    labels Map<String,String>
    The labels associated with Cloud Foundry resources.
    path String
    The path associated to the route to lookup.
    port Double
    The port associated to the route to lookup.
    protocol String
    The protocol supported by the route, based on the route's domain configuration.
    space String
    The space guid associated to the route.
    updatedAt String
    The date and time when the resource was updated in RFC3339 format.
    url String
    The URL for the route.
    annotations {[key: string]: string}
    The annotations associated with Cloud Foundry resources.
    createdAt string
    The date and time when the resource was created in RFC3339 format.
    destinations GetRouteRouteDestination[]
    A destination represents the relationship between a route and a resource that can serve traffic.
    domain string
    The domain guid associated to the route.
    host string
    The hostname associated to the route to lookup.
    id string
    The GUID of the object.
    labels {[key: string]: string}
    The labels associated with Cloud Foundry resources.
    path string
    The path associated to the route to lookup.
    port number
    The port associated to the route to lookup.
    protocol string
    The protocol supported by the route, based on the route's domain configuration.
    space string
    The space guid associated to the route.
    updatedAt string
    The date and time when the resource was updated in RFC3339 format.
    url string
    The URL for the route.
    annotations Mapping[str, str]
    The annotations associated with Cloud Foundry resources.
    created_at str
    The date and time when the resource was created in RFC3339 format.
    destinations Sequence[GetRouteRouteDestination]
    A destination represents the relationship between a route and a resource that can serve traffic.
    domain str
    The domain guid associated to the route.
    host str
    The hostname associated to the route to lookup.
    id str
    The GUID of the object.
    labels Mapping[str, str]
    The labels associated with Cloud Foundry resources.
    path str
    The path associated to the route to lookup.
    port float
    The port associated to the route to lookup.
    protocol str
    The protocol supported by the route, based on the route's domain configuration.
    space str
    The space guid associated to the route.
    updated_at str
    The date and time when the resource was updated in RFC3339 format.
    url str
    The URL for the route.
    annotations Map<String>
    The annotations associated with Cloud Foundry resources.
    createdAt String
    The date and time when the resource was created in RFC3339 format.
    destinations List<Property Map>
    A destination represents the relationship between a route and a resource that can serve traffic.
    domain String
    The domain guid associated to the route.
    host String
    The hostname associated to the route to lookup.
    id String
    The GUID of the object.
    labels Map<String>
    The labels associated with Cloud Foundry resources.
    path String
    The path associated to the route to lookup.
    port Number
    The port associated to the route to lookup.
    protocol String
    The protocol supported by the route, based on the route's domain configuration.
    space String
    The space guid associated to the route.
    updatedAt String
    The date and time when the resource was updated in RFC3339 format.
    url String
    The URL for the route.

    GetRouteRouteDestination

    AppId string
    The GUID of the app to route traffic to.
    AppProcessType string
    Type of the process belonging to the app to route traffic to.
    Id string
    The GUID of the object.
    Port double
    Port on the destination process to route traffic to.
    Protocol string
    Protocol to use for this destination.
    Weight double
    Percentage of traffic which will be routed to this destination.
    AppId string
    The GUID of the app to route traffic to.
    AppProcessType string
    Type of the process belonging to the app to route traffic to.
    Id string
    The GUID of the object.
    Port float64
    Port on the destination process to route traffic to.
    Protocol string
    Protocol to use for this destination.
    Weight float64
    Percentage of traffic which will be routed to this destination.
    app_id string
    The GUID of the app to route traffic to.
    app_process_type string
    Type of the process belonging to the app to route traffic to.
    id string
    The GUID of the object.
    port number
    Port on the destination process to route traffic to.
    protocol string
    Protocol to use for this destination.
    weight number
    Percentage of traffic which will be routed to this destination.
    appId String
    The GUID of the app to route traffic to.
    appProcessType String
    Type of the process belonging to the app to route traffic to.
    id String
    The GUID of the object.
    port Double
    Port on the destination process to route traffic to.
    protocol String
    Protocol to use for this destination.
    weight Double
    Percentage of traffic which will be routed to this destination.
    appId string
    The GUID of the app to route traffic to.
    appProcessType string
    Type of the process belonging to the app to route traffic to.
    id string
    The GUID of the object.
    port number
    Port on the destination process to route traffic to.
    protocol string
    Protocol to use for this destination.
    weight number
    Percentage of traffic which will be routed to this destination.
    app_id str
    The GUID of the app to route traffic to.
    app_process_type str
    Type of the process belonging to the app to route traffic to.
    id str
    The GUID of the object.
    port float
    Port on the destination process to route traffic to.
    protocol str
    Protocol to use for this destination.
    weight float
    Percentage of traffic which will be routed to this destination.
    appId String
    The GUID of the app to route traffic to.
    appProcessType String
    Type of the process belonging to the app to route traffic to.
    id String
    The GUID of the object.
    port Number
    Port on the destination process to route traffic to.
    protocol String
    Protocol to use for this destination.
    weight Number
    Percentage of traffic which will be routed to this destination.

    Package Details

    Repository
    cloudfoundry cloudfoundry/terraform-provider-cloudfoundry
    License
    Notes
    This Pulumi package is based on the cloudfoundry Terraform Provider.
    cloudfoundry
    Viewing docs for cloudfoundry 1.18.0
    published on Monday, Nov 2, 2026 by cloudfoundry
    Schema (JSON)
    cloudfoundry/terraform-provider-cloudfoundry

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial