Retrieve information about an operation

client.APIGateway.Operations.Get(ctx, operationID, params) (*OperationGetResponse, error)

GET/zones/{zone_id}/api_gateway/operations/{operation_id}

Gets detailed information about a specific API operation in API Shield, including its schema validation settings and traffic statistics.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Account API GatewayAccount API Gateway ReadDomain API GatewayDomain API Gateway Read

ParametersExpand Collapse

operationID string

UUID.

maxLength36

params OperationGetParams

ZoneID param.Field[string]

Path param: Identifier.

maxLength32

Feature param.Field[[]OperationGetParamsFeature]optional

Query param: 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.

const OperationGetParamsFeatureThresholds OperationGetParamsFeature = "thresholds"

const OperationGetParamsFeatureParameterSchemas OperationGetParamsFeature = "parameter_schemas"

const OperationGetParamsFeatureSchemaInfo OperationGetParamsFeature = "schema_info"

ReturnsExpand Collapse

type OperationGetResponse struct{…}

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/.

formaturi-template

maxLength4096

Host string

RFC3986-compliant host.

formathostname

maxLength255

LastUpdated Time

formatdate-time

Method OperationGetResponseMethod

The HTTP method used to access the endpoint.

One of the following:

const OperationGetResponseMethodGet OperationGetResponseMethod = "GET"

const OperationGetResponseMethodPost OperationGetResponseMethod = "POST"

const OperationGetResponseMethodHead OperationGetResponseMethod = "HEAD"

const OperationGetResponseMethodOptions OperationGetResponseMethod = "OPTIONS"

const OperationGetResponseMethodPut OperationGetResponseMethod = "PUT"

const OperationGetResponseMethodDelete OperationGetResponseMethod = "DELETE"

const OperationGetResponseMethodConnect OperationGetResponseMethod = "CONNECT"

const OperationGetResponseMethodPatch OperationGetResponseMethod = "PATCH"

const OperationGetResponseMethodTrace OperationGetResponseMethod = "TRACE"

OperationID string

UUID.

maxLength36

minLength36

Features OperationGetResponseFeaturesoptional

One of the following:

type OperationGetResponseFeaturesAPIShieldOperationFeatureThresholds struct{…}

Thresholds OperationGetResponseFeaturesAPIShieldOperationFeatureThresholdsThresholdsoptional

AuthIDTokens int64optional

The total number of auth-ids seen across this calculation.

DataPoints int64optional

The number of data points used for the threshold suggestion calculation.

LastUpdated Timeoptional

formatdate-time

P50 int64optional

The p50 quantile of requests (in period_seconds).

P90 int64optional

The p90 quantile of requests (in period_seconds).

P99 int64optional

The p99 quantile of requests (in period_seconds).

PeriodSeconds int64optional

The period over which this threshold is suggested.

Requests int64optional

The estimated number of requests covered by these calculations.

SuggestedThreshold int64optional

The suggested threshold in requests done by the same auth_id or period_seconds.

type OperationGetResponseFeaturesAPIShieldOperationFeatureParameterSchemas struct{…}

ParameterSchemas OperationGetResponseFeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemas

LastUpdated Timeoptional

formatdate-time

ParameterSchemas OperationGetResponseFeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemasParameterSchemasoptional

An operation schema object containing a response.

Parameters []unknownoptional

An array containing the learned parameter schemas.

Responses unknownoptional

An empty response object. This field is required to yield a valid operation schema.

type OperationGetResponseFeaturesAPIShieldOperationFeatureAPIRouting struct{…}

APIRouting OperationGetResponseFeaturesAPIShieldOperationFeatureAPIRoutingAPIRoutingoptional

API Routing settings on endpoint.

LastUpdated Timeoptional

formatdate-time

Route stringoptional

Target route.

type OperationGetResponseFeaturesAPIShieldOperationFeatureConfidenceIntervals struct{…}

ConfidenceIntervals OperationGetResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsoptional

LastUpdated Timeoptional

formatdate-time

SuggestedThreshold OperationGetResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdoptional

ConfidenceIntervals OperationGetResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsoptional

P90 OperationGetResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90optional

Upper and lower bound for percentile estimate

Lower float64optional

Lower bound for percentile estimate

Upper float64optional

Upper bound for percentile estimate

P95 OperationGetResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95optional

Upper and lower bound for percentile estimate

Lower float64optional

Lower bound for percentile estimate

Upper float64optional

Upper bound for percentile estimate

P99 OperationGetResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99optional

Upper and lower bound for percentile estimate

Lower float64optional

Lower bound for percentile estimate

Upper float64optional

Upper bound for percentile estimate

Mean float64optional

Suggested threshold.

type OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfo struct{…}

SchemaInfo OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfooptional

ActiveSchema OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoActiveSchemaoptional

Schema active on endpoint.

ID stringoptional

UUID.

maxLength36

minLength36

CreatedAt Timeoptional

formatdate-time

IsLearned booloptional

True if schema is Cloudflare-provided.

Name stringoptional

Schema file name.

LearnedAvailable booloptional

True if a Cloudflare-provided learned schema is available for this endpoint.

MitigationAction OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionoptional

Action taken on requests failing validation.

One of the following:

const OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionNone OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "none"

const OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionLog OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "log"

const OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionBlock OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "block"

Retrieve information about an operation

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/api_gateway"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  operation, err := client.APIGateway.Operations.Get(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    api_gateway.OperationGetParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", operation.OperationID)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "endpoint": "/api/v1/users/{var1}",
    "host": "www.example.com",
    "last_updated": "2014-01-01T05:20:00.12345Z",
    "method": "GET",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "features": {
      "thresholds": {
        "auth_id_tokens": 0,
        "data_points": 0,
        "last_updated": "2014-01-01T05:20:00.12345Z",
        "p50": 0,
        "p90": 0,
        "p99": 0,
        "period_seconds": 0,
        "requests": 0,
        "suggested_threshold": 0
      }
    }
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "endpoint": "/api/v1/users/{var1}",
    "host": "www.example.com",
    "last_updated": "2014-01-01T05:20:00.12345Z",
    "method": "GET",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "features": {
      "thresholds": {
        "auth_id_tokens": 0,
        "data_points": 0,
        "last_updated": "2014-01-01T05:20:00.12345Z",
        "p50": 0,
        "p90": 0,
        "p99": 0,
        "period_seconds": 0,
        "requests": 0,
        "suggested_threshold": 0
      }
    }
  },
  "success": true
}