Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. GenerativeAi
  6. getEndpoint
Viewing docs for Oracle Cloud Infrastructure v2.33.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-oci

oci.GenerativeAi.getEndpoint

oci logo
Viewing docs for Oracle Cloud Infrastructure v2.33.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Endpoint resource in Oracle Cloud Infrastructure Generative AI service.

    Gets information about an endpoint.

    Example Usage

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

const testEndpoint = oci.GenerativeAi.getEndpoint({
    endpointId: testEndpointOciGenerativeAiEndpoint.id,
});

    import pulumi
import pulumi_oci as oci

test_endpoint = oci.GenerativeAi.get_endpoint(endpoint_id=test_endpoint_oci_generative_ai_endpoint["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/generativeai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := generativeai.GetEndpoint(ctx, &generativeai.GetEndpointArgs{
			EndpointId: testEndpointOciGenerativeAiEndpoint.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testEndpoint = Oci.GenerativeAi.GetEndpoint.Invoke(new()
    {
        EndpointId = testEndpointOciGenerativeAiEndpoint.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetEndpointArgs;
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 testEndpoint = GenerativeAiFunctions.getEndpoint(GetEndpointArgs.builder()
            .endpointId(testEndpointOciGenerativeAiEndpoint.id())
            .build());

    }
}

    variables:
  testEndpoint:
    fn::invoke:
      function: oci:GenerativeAi:getEndpoint
      arguments:
        endpointId: ${testEndpointOciGenerativeAiEndpoint.id}

    Using getEndpoint

    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 getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>
    def get_endpoint(endpoint_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(endpoint_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]
    func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

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

    public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:GenerativeAi/getEndpoint:getEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EndpointId string
    The OCID of the endpoint.
    EndpointId string
    The OCID of the endpoint.
    endpointId String
    The OCID of the endpoint.
    endpointId string
    The OCID of the endpoint.
    endpoint_id str
    The OCID of the endpoint.
    endpointId String
    The OCID of the endpoint.

    getEndpoint Result

    The following output properties are available:

    CompartmentId string
    ContentModerationConfigs List<GetEndpointContentModerationConfig>
    DedicatedAiClusterId string
    DefinedTags Dictionary<string, string>
    Description string
    An optional description of the endpoint.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    EndpointId string
    FreeformTags Dictionary<string, string>
    Id string
    LifecycleDetails string
    ModelId string
    The OCID of the model that's used to create this endpoint.
    State string
    The current state of the endpoint.
    SystemTags Dictionary<string, string>
    TimeCreated string
    TimeUpdated string
    The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
    CompartmentId string
    ContentModerationConfigs []GetEndpointContentModerationConfig
    DedicatedAiClusterId string
    DefinedTags map[string]string
    Description string
    An optional description of the endpoint.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    EndpointId string
    FreeformTags map[string]string
    Id string
    LifecycleDetails string
    ModelId string
    The OCID of the model that's used to create this endpoint.
    State string
    The current state of the endpoint.
    SystemTags map[string]string
    TimeCreated string
    TimeUpdated string
    The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
    compartmentId String
    contentModerationConfigs List<GetEndpointContentModerationConfig>
    dedicatedAiClusterId String
    definedTags Map<String,String>
    description String
    An optional description of the endpoint.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    endpointId String
    freeformTags Map<String,String>
    id String
    lifecycleDetails String
    modelId String
    The OCID of the model that's used to create this endpoint.
    state String
    The current state of the endpoint.
    systemTags Map<String,String>
    timeCreated String
    timeUpdated String
    The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
    compartmentId string
    contentModerationConfigs GetEndpointContentModerationConfig[]
    dedicatedAiClusterId string
    definedTags {[key: string]: string}
    description string
    An optional description of the endpoint.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    endpointId string
    freeformTags {[key: string]: string}
    id string
    lifecycleDetails string
    modelId string
    The OCID of the model that's used to create this endpoint.
    state string
    The current state of the endpoint.
    systemTags {[key: string]: string}
    timeCreated string
    timeUpdated string
    The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
    compartment_id str
    content_moderation_configs Sequence[GetEndpointContentModerationConfig]
    dedicated_ai_cluster_id str
    defined_tags Mapping[str, str]
    description str
    An optional description of the endpoint.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable.
    endpoint_id str
    freeform_tags Mapping[str, str]
    id str
    lifecycle_details str
    model_id str
    The OCID of the model that's used to create this endpoint.
    state str
    The current state of the endpoint.
    system_tags Mapping[str, str]
    time_created str
    time_updated str
    The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
    compartmentId String
    contentModerationConfigs List<Property Map>
    dedicatedAiClusterId String
    definedTags Map<String>
    description String
    An optional description of the endpoint.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    endpointId String
    freeformTags Map<String>
    id String
    lifecycleDetails String
    modelId String
    The OCID of the model that's used to create this endpoint.
    state String
    The current state of the endpoint.
    systemTags Map<String>
    timeCreated String
    timeUpdated String
    The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

    Supporting Types

    GetEndpointContentModerationConfig

    isEnabled Boolean
    isEnabled boolean
    isEnabled Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Viewing docs for Oracle Cloud Infrastructure v2.33.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-oci

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial