1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApiGateway
  5. getApiValidation
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.ApiGateway.getApiValidation

Start a Neo task
Explain and create an oci.ApiGateway.getApiValidation resource
oci logo
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

    This data source provides details about a specific Api Validation resource in Oracle Cloud Infrastructure API Gateway service.

    Gets the API validation results.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testApiValidation = oci.ApiGateway.getApiValidation({
        apiId: testApi.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_api_validation = oci.ApiGateway.get_api_validation(api_id=test_api["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/apigateway"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigateway.GetApiValidation(ctx, &apigateway.GetApiValidationArgs{
    			ApiId: testApi.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 testApiValidation = Oci.ApiGateway.GetApiValidation.Invoke(new()
        {
            ApiId = testApi.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
    import com.pulumi.oci.ApiGateway.inputs.GetApiValidationArgs;
    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 testApiValidation = ApiGatewayFunctions.getApiValidation(GetApiValidationArgs.builder()
                .apiId(testApi.id())
                .build());
    
        }
    }
    
    variables:
      testApiValidation:
        fn::invoke:
          function: oci:ApiGateway:getApiValidation
          arguments:
            apiId: ${testApi.id}
    

    Using getApiValidation

    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 getApiValidation(args: GetApiValidationArgs, opts?: InvokeOptions): Promise<GetApiValidationResult>
    function getApiValidationOutput(args: GetApiValidationOutputArgs, opts?: InvokeOptions): Output<GetApiValidationResult>
    def get_api_validation(api_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetApiValidationResult
    def get_api_validation_output(api_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetApiValidationResult]
    func LookupApiValidation(ctx *Context, args *LookupApiValidationArgs, opts ...InvokeOption) (*LookupApiValidationResult, error)
    func LookupApiValidationOutput(ctx *Context, args *LookupApiValidationOutputArgs, opts ...InvokeOption) LookupApiValidationResultOutput

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

    public static class GetApiValidation 
    {
        public static Task<GetApiValidationResult> InvokeAsync(GetApiValidationArgs args, InvokeOptions? opts = null)
        public static Output<GetApiValidationResult> Invoke(GetApiValidationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiValidationResult> getApiValidation(GetApiValidationArgs args, InvokeOptions options)
    public static Output<GetApiValidationResult> getApiValidation(GetApiValidationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:ApiGateway/getApiValidation:getApiValidation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApiId string
    The ocid of the API.
    ApiId string
    The ocid of the API.
    apiId String
    The ocid of the API.
    apiId string
    The ocid of the API.
    api_id str
    The ocid of the API.
    apiId String
    The ocid of the API.

    getApiValidation Result

    The following output properties are available:

    ApiId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Validations List<GetApiValidationValidation>
    API validation results.
    ApiId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Validations []GetApiValidationValidation
    API validation results.
    apiId String
    id String
    The provider-assigned unique ID for this managed resource.
    validations List<GetApiValidationValidation>
    API validation results.
    apiId string
    id string
    The provider-assigned unique ID for this managed resource.
    validations GetApiValidationValidation[]
    API validation results.
    api_id str
    id str
    The provider-assigned unique ID for this managed resource.
    validations Sequence[GetApiValidationValidation]
    API validation results.
    apiId String
    id String
    The provider-assigned unique ID for this managed resource.
    validations List<Property Map>
    API validation results.

    Supporting Types

    GetApiValidationValidation

    Details List<GetApiValidationValidationDetail>
    Details of validation.
    Name string
    Name of the validation.
    Result string
    Result of the validation.
    Details []GetApiValidationValidationDetail
    Details of validation.
    Name string
    Name of the validation.
    Result string
    Result of the validation.
    details List<GetApiValidationValidationDetail>
    Details of validation.
    name String
    Name of the validation.
    result String
    Result of the validation.
    details GetApiValidationValidationDetail[]
    Details of validation.
    name string
    Name of the validation.
    result string
    Result of the validation.
    details Sequence[GetApiValidationValidationDetail]
    Details of validation.
    name str
    Name of the validation.
    result str
    Result of the validation.
    details List<Property Map>
    Details of validation.
    name String
    Name of the validation.
    result String
    Result of the validation.

    GetApiValidationValidationDetail

    Msg string
    Description of the warning/error.
    Severity string
    Severity of the issue.
    Srcs List<GetApiValidationValidationDetailSrc>
    Position of the issue in the specification file (line, column).
    Msg string
    Description of the warning/error.
    Severity string
    Severity of the issue.
    Srcs []GetApiValidationValidationDetailSrc
    Position of the issue in the specification file (line, column).
    msg String
    Description of the warning/error.
    severity String
    Severity of the issue.
    srcs List<GetApiValidationValidationDetailSrc>
    Position of the issue in the specification file (line, column).
    msg string
    Description of the warning/error.
    severity string
    Severity of the issue.
    srcs GetApiValidationValidationDetailSrc[]
    Position of the issue in the specification file (line, column).
    msg str
    Description of the warning/error.
    severity str
    Severity of the issue.
    srcs Sequence[GetApiValidationValidationDetailSrc]
    Position of the issue in the specification file (line, column).
    msg String
    Description of the warning/error.
    severity String
    Severity of the issue.
    srcs List<Property Map>
    Position of the issue in the specification file (line, column).

    GetApiValidationValidationDetailSrc

    Items List<object>
    Items []interface{}
    items List<Object>
    items any[]
    items Sequence[Any]
    items List<Any>

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate