1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. getApiaccesscontrolApiMetadata
Viewing docs for Oracle Cloud Infrastructure v4.5.0
published on Thursday, Apr 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.oci.getApiaccesscontrolApiMetadata

logo
Viewing docs for Oracle Cloud Infrastructure v4.5.0
published on Thursday, Apr 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Api Metadata resource in Oracle Cloud Infrastructure Apiaccesscontrol service.

    Gets information about a ApiMetadata.

    Example Usage

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

const testApiMetadata = oci.oci.getApiaccesscontrolApiMetadata({
    apiMetadataId: testApiMetadataOciApiaccesscontrolApiMetadata.id,
});

    import pulumi
import pulumi_oci as oci

test_api_metadata = oci.oci.get_apiaccesscontrol_api_metadata(api_metadata_id=test_api_metadata_oci_apiaccesscontrol_api_metadata["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oci.GetApiaccesscontrolApiMetadata(ctx, &oci.GetApiaccesscontrolApiMetadataArgs{
			ApiMetadataId: testApiMetadataOciApiaccesscontrolApiMetadata.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 testApiMetadata = Oci.Oci.GetApiaccesscontrolApiMetadata.Invoke(new()
    {
        ApiMetadataId = testApiMetadataOciApiaccesscontrolApiMetadata.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.OciFunctions;
import com.pulumi.oci.oci.inputs.GetApiaccesscontrolApiMetadataArgs;
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 testApiMetadata = OciFunctions.getApiaccesscontrolApiMetadata(GetApiaccesscontrolApiMetadataArgs.builder()
            .apiMetadataId(testApiMetadataOciApiaccesscontrolApiMetadata.id())
            .build());

    }
}

    variables:
  testApiMetadata:
    fn::invoke:
      function: oci:oci:getApiaccesscontrolApiMetadata
      arguments:
        apiMetadataId: ${testApiMetadataOciApiaccesscontrolApiMetadata.id}

    Using getApiaccesscontrolApiMetadata

    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 getApiaccesscontrolApiMetadata(args: GetApiaccesscontrolApiMetadataArgs, opts?: InvokeOptions): Promise<GetApiaccesscontrolApiMetadataResult>
function getApiaccesscontrolApiMetadataOutput(args: GetApiaccesscontrolApiMetadataOutputArgs, opts?: InvokeOptions): Output<GetApiaccesscontrolApiMetadataResult>
    def get_apiaccesscontrol_api_metadata(api_metadata_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetApiaccesscontrolApiMetadataResult
def get_apiaccesscontrol_api_metadata_output(api_metadata_id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetApiaccesscontrolApiMetadataResult]
    func GetApiaccesscontrolApiMetadata(ctx *Context, args *GetApiaccesscontrolApiMetadataArgs, opts ...InvokeOption) (*GetApiaccesscontrolApiMetadataResult, error)
func GetApiaccesscontrolApiMetadataOutput(ctx *Context, args *GetApiaccesscontrolApiMetadataOutputArgs, opts ...InvokeOption) GetApiaccesscontrolApiMetadataResultOutput

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

    public static class GetApiaccesscontrolApiMetadata 
{
    public static Task<GetApiaccesscontrolApiMetadataResult> InvokeAsync(GetApiaccesscontrolApiMetadataArgs args, InvokeOptions? opts = null)
    public static Output<GetApiaccesscontrolApiMetadataResult> Invoke(GetApiaccesscontrolApiMetadataInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiaccesscontrolApiMetadataResult> getApiaccesscontrolApiMetadata(GetApiaccesscontrolApiMetadataArgs args, InvokeOptions options)
public static Output<GetApiaccesscontrolApiMetadataResult> getApiaccesscontrolApiMetadata(GetApiaccesscontrolApiMetadataArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:oci/getApiaccesscontrolApiMetadata:getApiaccesscontrolApiMetadata
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiMetadataId string
    The OCID of the PrivilegedApiControl.
    ApiMetadataId string
    The OCID of the PrivilegedApiControl.
    apiMetadataId String
    The OCID of the PrivilegedApiControl.
    apiMetadataId string
    The OCID of the PrivilegedApiControl.
    api_metadata_id str
    The OCID of the PrivilegedApiControl.
    apiMetadataId String
    The OCID of the PrivilegedApiControl.

    getApiaccesscontrolApiMetadata Result

    The following output properties are available:

    ApiMetadataId string
    ApiName string
    The name of the api to execute the api request.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    The operation Name of the api. The name must be unique.
    EntityType string
    ResourceType to which the apiMetadata belongs to.
    Fields List<string>
    List of the fields that is use while calling post or put for the data.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    Path string
    rest path of the api.
    ServiceName string
    The service Name to which the api belongs to.
    State string
    The current state of the ApiMetadata.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeDeleted string
    The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    ApiMetadataId string
    ApiName string
    The name of the api to execute the api request.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    The operation Name of the api. The name must be unique.
    EntityType string
    ResourceType to which the apiMetadata belongs to.
    Fields []string
    List of the fields that is use while calling post or put for the data.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    Path string
    rest path of the api.
    ServiceName string
    The service Name to which the api belongs to.
    State string
    The current state of the ApiMetadata.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeDeleted string
    The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    apiMetadataId String
    apiName String
    The name of the api to execute the api request.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    The operation Name of the api. The name must be unique.
    entityType String
    ResourceType to which the apiMetadata belongs to.
    fields List<String>
    List of the fields that is use while calling post or put for the data.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    path String
    rest path of the api.
    serviceName String
    The service Name to which the api belongs to.
    state String
    The current state of the ApiMetadata.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeDeleted String
    The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    apiMetadataId string
    apiName string
    The name of the api to execute the api request.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    The operation Name of the api. The name must be unique.
    entityType string
    ResourceType to which the apiMetadata belongs to.
    fields string[]
    List of the fields that is use while calling post or put for the data.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    path string
    rest path of the api.
    serviceName string
    The service Name to which the api belongs to.
    state string
    The current state of the ApiMetadata.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeDeleted string
    The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    api_metadata_id str
    api_name str
    The name of the api to execute the api request.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    The operation Name of the api. The name must be unique.
    entity_type str
    ResourceType to which the apiMetadata belongs to.
    fields Sequence[str]
    List of the fields that is use while calling post or put for the data.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    path str
    rest path of the api.
    service_name str
    The service Name to which the api belongs to.
    state str
    The current state of the ApiMetadata.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_deleted str
    The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    apiMetadataId String
    apiName String
    The name of the api to execute the api request.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    The operation Name of the api. The name must be unique.
    entityType String
    ResourceType to which the apiMetadata belongs to.
    fields List<String>
    List of the fields that is use while calling post or put for the data.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    path String
    rest path of the api.
    serviceName String
    The service Name to which the api belongs to.
    state String
    The current state of the ApiMetadata.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeDeleted String
    The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    logo
    Viewing docs for Oracle Cloud Infrastructure v4.5.0
    published on Thursday, Apr 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.