Get OHTTP Gateway enablement

client.Zones.OhttpGateway.Get(ctx, query) (*OhttpGatewayGetResponse, error)

GET/zones/{zone_id}/settings/ohttp-gateway

Returns the state of Oblivious HTTP enablement for the zone. Requires product subscription to call.

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)

Zone Settings Read

ParametersExpand Collapse

query OhttpGatewayGetParams

ZoneID param.Field[string]

The zone tag.

maxLength32

ReturnsExpand Collapse

type OhttpGatewayGetResponse string

One of the following:

const OhttpGatewayGetResponseOn OhttpGatewayGetResponse = "on"

const OhttpGatewayGetResponseOff OhttpGatewayGetResponse = "off"

Get OHTTP Gateway enablement

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  ohttpGateway, err := client.Zones.OhttpGateway.Get(context.TODO(), zones.OhttpGatewayGetParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", ohttpGateway)
}

{
  "errors": [],
  "messages": [],
  "result": "on",
  "success": true
}

{
  "errors": [],
  "messages": [],
  "result": "off",
  "success": true
}

Returns Examples

{
  "errors": [],
  "messages": [],
  "result": "on",
  "success": true
}

{
  "errors": [],
  "messages": [],
  "result": "off",
  "success": true
}