Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getApiShieldOperation
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.getApiShieldOperation

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    variables:
  exampleApiShieldOperation:
    fn::invoke:
      function: cloudflare:getApiShieldOperation
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        operationId: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
        features:
          - thresholds

    Using getApiShieldOperation

    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 getApiShieldOperation(args: GetApiShieldOperationArgs, opts?: InvokeOptions): Promise<GetApiShieldOperationResult>
function getApiShieldOperationOutput(args: GetApiShieldOperationOutputArgs, opts?: InvokeOptions): Output<GetApiShieldOperationResult>
    def get_api_shield_operation(feature: Optional[Sequence[str]] = None,
                             filter: Optional[GetApiShieldOperationFilter] = None,
                             operation_id: Optional[str] = None,
                             zone_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetApiShieldOperationResult
def get_api_shield_operation_output(feature: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                             filter: Optional[pulumi.Input[GetApiShieldOperationFilterArgs]] = None,
                             operation_id: Optional[pulumi.Input[str]] = None,
                             zone_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetApiShieldOperationResult]
    func LookupApiShieldOperation(ctx *Context, args *LookupApiShieldOperationArgs, opts ...InvokeOption) (*LookupApiShieldOperationResult, error)
func LookupApiShieldOperationOutput(ctx *Context, args *LookupApiShieldOperationOutputArgs, opts ...InvokeOption) LookupApiShieldOperationResultOutput

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

    public static class GetApiShieldOperation 
{
    public static Task<GetApiShieldOperationResult> InvokeAsync(GetApiShieldOperationArgs args, InvokeOptions? opts = null)
    public static Output<GetApiShieldOperationResult> Invoke(GetApiShieldOperationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiShieldOperationResult> getApiShieldOperation(GetApiShieldOperationArgs args, InvokeOptions options)
public static Output<GetApiShieldOperationResult> getApiShieldOperation(GetApiShieldOperationArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getApiShieldOperation:getApiShieldOperation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ZoneId string
    Identifier
    Feature List<string>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    Filter GetApiShieldOperationFilter
    OperationId string
    UUID
    ZoneId string
    Identifier
    Feature []string
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    Filter GetApiShieldOperationFilter
    OperationId string
    UUID
    zoneId String
    Identifier
    feature List<String>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    filter GetApiShieldOperationFilter
    operationId String
    UUID
    zoneId string
    Identifier
    feature string[]
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    filter GetApiShieldOperationFilter
    operationId string
    UUID
    zone_id str
    Identifier
    feature Sequence[str]
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    filter GetApiShieldOperationFilter
    operation_id str
    UUID
    zoneId String
    Identifier
    feature List<String>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    filter Property Map
    operationId String
    UUID

    getApiShieldOperation Result

    The following output properties are available:

    Endpoint string
    The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
    Features GetApiShieldOperationFeatures
    Host string
    RFC3986-compliant host.
    Id string
    UUID
    LastUpdated string
    Method string
    The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
    OperationId string
    UUID
    ZoneId string
    Identifier
    Feature List<string>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    Filter GetApiShieldOperationFilter
    Endpoint string
    The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
    Features GetApiShieldOperationFeatures
    Host string
    RFC3986-compliant host.
    Id string
    UUID
    LastUpdated string
    Method string
    The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
    OperationId string
    UUID
    ZoneId string
    Identifier
    Feature []string
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    Filter GetApiShieldOperationFilter
    endpoint String
    The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
    features GetApiShieldOperationFeatures
    host String
    RFC3986-compliant host.
    id String
    UUID
    lastUpdated String
    method String
    The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
    operationId String
    UUID
    zoneId String
    Identifier
    feature List<String>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    filter GetApiShieldOperationFilter
    endpoint string
    The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
    features GetApiShieldOperationFeatures
    host string
    RFC3986-compliant host.
    id string
    UUID
    lastUpdated string
    method string
    The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
    operationId string
    UUID
    zoneId string
    Identifier
    feature string[]
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    filter GetApiShieldOperationFilter
    endpoint str
    The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
    features GetApiShieldOperationFeatures
    host str
    RFC3986-compliant host.
    id str
    UUID
    last_updated str
    method str
    The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
    operation_id str
    UUID
    zone_id str
    Identifier
    feature Sequence[str]
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    filter GetApiShieldOperationFilter
    endpoint String
    The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
    features Property Map
    host String
    RFC3986-compliant host.
    id String
    UUID
    lastUpdated String
    method String
    The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
    operationId String
    UUID
    zoneId String
    Identifier
    feature List<String>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    filter Property Map

    Supporting Types

    GetApiShieldOperationFeatures

    GetApiShieldOperationFeaturesApiRouting

    LastUpdated string
    Route string
    Target route.
    LastUpdated string
    Route string
    Target route.
    lastUpdated String
    route String
    Target route.
    lastUpdated string
    route string
    Target route.
    last_updated str
    route str
    Target route.
    lastUpdated String
    route String
    Target route.

    GetApiShieldOperationFeaturesConfidenceIntervals

    GetApiShieldOperationFeaturesConfidenceIntervalsSuggestedThreshold

    confidenceIntervals Property Map
    mean Number
    Suggested threshold.

    GetApiShieldOperationFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervals

    p90 Property Map
    Upper and lower bound for percentile estimate
    p95 Property Map
    Upper and lower bound for percentile estimate
    p99 Property Map
    Upper and lower bound for percentile estimate

    GetApiShieldOperationFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90

    Lower double
    Lower bound for percentile estimate
    Upper double
    Upper bound for percentile estimate
    Lower float64
    Lower bound for percentile estimate
    Upper float64
    Upper bound for percentile estimate
    lower Double
    Lower bound for percentile estimate
    upper Double
    Upper bound for percentile estimate
    lower number
    Lower bound for percentile estimate
    upper number
    Upper bound for percentile estimate
    lower float
    Lower bound for percentile estimate
    upper float
    Upper bound for percentile estimate
    lower Number
    Lower bound for percentile estimate
    upper Number
    Upper bound for percentile estimate

    GetApiShieldOperationFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95

    Lower double
    Lower bound for percentile estimate
    Upper double
    Upper bound for percentile estimate
    Lower float64
    Lower bound for percentile estimate
    Upper float64
    Upper bound for percentile estimate
    lower Double
    Lower bound for percentile estimate
    upper Double
    Upper bound for percentile estimate
    lower number
    Lower bound for percentile estimate
    upper number
    Upper bound for percentile estimate
    lower float
    Lower bound for percentile estimate
    upper float
    Upper bound for percentile estimate
    lower Number
    Lower bound for percentile estimate
    upper Number
    Upper bound for percentile estimate

    GetApiShieldOperationFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99

    Lower double
    Lower bound for percentile estimate
    Upper double
    Upper bound for percentile estimate
    Lower float64
    Lower bound for percentile estimate
    Upper float64
    Upper bound for percentile estimate
    lower Double
    Lower bound for percentile estimate
    upper Double
    Upper bound for percentile estimate
    lower number
    Lower bound for percentile estimate
    upper number
    Upper bound for percentile estimate
    lower float
    Lower bound for percentile estimate
    upper float
    Upper bound for percentile estimate
    lower Number
    Lower bound for percentile estimate
    upper Number
    Upper bound for percentile estimate

    GetApiShieldOperationFeaturesParameterSchemas

    lastUpdated String
    parameterSchemas Property Map
    An operation schema object containing a response.

    GetApiShieldOperationFeaturesParameterSchemasParameterSchemas

    Parameters List<string>
    An array containing the learned parameter schemas.
    Responses string
    An empty response object. This field is required to yield a valid operation schema.
    Parameters []string
    An array containing the learned parameter schemas.
    Responses string
    An empty response object. This field is required to yield a valid operation schema.
    parameters List<String>
    An array containing the learned parameter schemas.
    responses String
    An empty response object. This field is required to yield a valid operation schema.
    parameters string[]
    An array containing the learned parameter schemas.
    responses string
    An empty response object. This field is required to yield a valid operation schema.
    parameters Sequence[str]
    An array containing the learned parameter schemas.
    responses str
    An empty response object. This field is required to yield a valid operation schema.
    parameters List<String>
    An array containing the learned parameter schemas.
    responses String
    An empty response object. This field is required to yield a valid operation schema.

    GetApiShieldOperationFeaturesSchemaInfo

    ActiveSchema GetApiShieldOperationFeaturesSchemaInfoActiveSchema
    Schema active on endpoint.
    LearnedAvailable bool
    True if a Cloudflare-provided learned schema is available for this endpoint.
    MitigationAction string
    Action taken on requests failing validation. Available values: "none", "log", "block".
    ActiveSchema GetApiShieldOperationFeaturesSchemaInfoActiveSchema
    Schema active on endpoint.
    LearnedAvailable bool
    True if a Cloudflare-provided learned schema is available for this endpoint.
    MitigationAction string
    Action taken on requests failing validation. Available values: "none", "log", "block".
    activeSchema GetApiShieldOperationFeaturesSchemaInfoActiveSchema
    Schema active on endpoint.
    learnedAvailable Boolean
    True if a Cloudflare-provided learned schema is available for this endpoint.
    mitigationAction String
    Action taken on requests failing validation. Available values: "none", "log", "block".
    activeSchema GetApiShieldOperationFeaturesSchemaInfoActiveSchema
    Schema active on endpoint.
    learnedAvailable boolean
    True if a Cloudflare-provided learned schema is available for this endpoint.
    mitigationAction string
    Action taken on requests failing validation. Available values: "none", "log", "block".
    active_schema GetApiShieldOperationFeaturesSchemaInfoActiveSchema
    Schema active on endpoint.
    learned_available bool
    True if a Cloudflare-provided learned schema is available for this endpoint.
    mitigation_action str
    Action taken on requests failing validation. Available values: "none", "log", "block".
    activeSchema Property Map
    Schema active on endpoint.
    learnedAvailable Boolean
    True if a Cloudflare-provided learned schema is available for this endpoint.
    mitigationAction String
    Action taken on requests failing validation. Available values: "none", "log", "block".

    GetApiShieldOperationFeaturesSchemaInfoActiveSchema

    CreatedAt string
    Id string
    UUID
    IsLearned bool
    True if schema is Cloudflare-provided.
    Name string
    Schema file name.
    CreatedAt string
    Id string
    UUID
    IsLearned bool
    True if schema is Cloudflare-provided.
    Name string
    Schema file name.
    createdAt String
    id String
    UUID
    isLearned Boolean
    True if schema is Cloudflare-provided.
    name String
    Schema file name.
    createdAt string
    id string
    UUID
    isLearned boolean
    True if schema is Cloudflare-provided.
    name string
    Schema file name.
    created_at str
    id str
    UUID
    is_learned bool
    True if schema is Cloudflare-provided.
    name str
    Schema file name.
    createdAt String
    id String
    UUID
    isLearned Boolean
    True if schema is Cloudflare-provided.
    name String
    Schema file name.

    GetApiShieldOperationFeaturesThresholds

    AuthIdTokens int
    The total number of auth-ids seen across this calculation.
    DataPoints int
    The number of data points used for the threshold suggestion calculation.
    LastUpdated string
    P50 int
    The p50 quantile of requests (in period_seconds).
    P90 int
    The p90 quantile of requests (in period_seconds).
    P99 int
    The p99 quantile of requests (in period_seconds).
    PeriodSeconds int
    The period over which this threshold is suggested.
    Requests int
    The estimated number of requests covered by these calculations.
    SuggestedThreshold int
    The suggested threshold in requests done by the same authid or periodseconds.
    AuthIdTokens int
    The total number of auth-ids seen across this calculation.
    DataPoints int
    The number of data points used for the threshold suggestion calculation.
    LastUpdated string
    P50 int
    The p50 quantile of requests (in period_seconds).
    P90 int
    The p90 quantile of requests (in period_seconds).
    P99 int
    The p99 quantile of requests (in period_seconds).
    PeriodSeconds int
    The period over which this threshold is suggested.
    Requests int
    The estimated number of requests covered by these calculations.
    SuggestedThreshold int
    The suggested threshold in requests done by the same authid or periodseconds.
    authIdTokens Integer
    The total number of auth-ids seen across this calculation.
    dataPoints Integer
    The number of data points used for the threshold suggestion calculation.
    lastUpdated String
    p50 Integer
    The p50 quantile of requests (in period_seconds).
    p90 Integer
    The p90 quantile of requests (in period_seconds).
    p99 Integer
    The p99 quantile of requests (in period_seconds).
    periodSeconds Integer
    The period over which this threshold is suggested.
    requests Integer
    The estimated number of requests covered by these calculations.
    suggestedThreshold Integer
    The suggested threshold in requests done by the same authid or periodseconds.
    authIdTokens number
    The total number of auth-ids seen across this calculation.
    dataPoints number
    The number of data points used for the threshold suggestion calculation.
    lastUpdated string
    p50 number
    The p50 quantile of requests (in period_seconds).
    p90 number
    The p90 quantile of requests (in period_seconds).
    p99 number
    The p99 quantile of requests (in period_seconds).
    periodSeconds number
    The period over which this threshold is suggested.
    requests number
    The estimated number of requests covered by these calculations.
    suggestedThreshold number
    The suggested threshold in requests done by the same authid or periodseconds.
    auth_id_tokens int
    The total number of auth-ids seen across this calculation.
    data_points int
    The number of data points used for the threshold suggestion calculation.
    last_updated str
    p50 int
    The p50 quantile of requests (in period_seconds).
    p90 int
    The p90 quantile of requests (in period_seconds).
    p99 int
    The p99 quantile of requests (in period_seconds).
    period_seconds int
    The period over which this threshold is suggested.
    requests int
    The estimated number of requests covered by these calculations.
    suggested_threshold int
    The suggested threshold in requests done by the same authid or periodseconds.
    authIdTokens Number
    The total number of auth-ids seen across this calculation.
    dataPoints Number
    The number of data points used for the threshold suggestion calculation.
    lastUpdated String
    p50 Number
    The p50 quantile of requests (in period_seconds).
    p90 Number
    The p90 quantile of requests (in period_seconds).
    p99 Number
    The p99 quantile of requests (in period_seconds).
    periodSeconds Number
    The period over which this threshold is suggested.
    requests Number
    The estimated number of requests covered by these calculations.
    suggestedThreshold Number
    The suggested threshold in requests done by the same authid or periodseconds.

    GetApiShieldOperationFilter

    Direction string
    Direction to order results. Available values: "asc", "desc".
    Endpoint string
    Filter results to only include endpoints containing this pattern.
    Features List<string>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    Hosts List<string>
    Filter results to only include the specified hosts.
    Methods List<string>
    Filter results to only include the specified HTTP methods.
    Order string
    Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".
    Direction string
    Direction to order results. Available values: "asc", "desc".
    Endpoint string
    Filter results to only include endpoints containing this pattern.
    Features []string
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    Hosts []string
    Filter results to only include the specified hosts.
    Methods []string
    Filter results to only include the specified HTTP methods.
    Order string
    Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".
    direction String
    Direction to order results. Available values: "asc", "desc".
    endpoint String
    Filter results to only include endpoints containing this pattern.
    features List<String>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    hosts List<String>
    Filter results to only include the specified hosts.
    methods List<String>
    Filter results to only include the specified HTTP methods.
    order String
    Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".
    direction string
    Direction to order results. Available values: "asc", "desc".
    endpoint string
    Filter results to only include endpoints containing this pattern.
    features string[]
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    hosts string[]
    Filter results to only include the specified hosts.
    methods string[]
    Filter results to only include the specified HTTP methods.
    order string
    Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".
    direction str
    Direction to order results. Available values: "asc", "desc".
    endpoint str
    Filter results to only include endpoints containing this pattern.
    features Sequence[str]
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    hosts Sequence[str]
    Filter results to only include the specified hosts.
    methods Sequence[str]
    Filter results to only include the specified HTTP methods.
    order str
    Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".
    direction String
    Direction to order results. Available values: "asc", "desc".
    endpoint String
    Filter results to only include endpoints containing this pattern.
    features List<String>
    Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
    hosts List<String>
    Filter results to only include the specified hosts.
    methods List<String>
    Filter results to only include the specified HTTP methods.
    order String
    Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare