Toggle the status of a given policy

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
waap_policy_mode = client.waap.domains.policies.toggle(
    policy_id="policy_id",
    domain_id=1,
)
print(waap_policy_mode.mode)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/option"
	"github.com/G-Core/gcore-go/waap"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	waapPolicyMode, err := client.Waap.Domains.Policies.Toggle(
		context.TODO(),
		"policy_id",
		waap.DomainPolicyToggleParams{
			DomainID: 1,
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", waapPolicyMode.Mode)
}

const options = {method: 'PATCH', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/waap/v1/domains/{domain_id}/policies/{policy_id}/toggle', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/waap/v1/domains/{domain_id}/policies/{policy_id}/toggle",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/waap/v1/domains/{domain_id}/policies/{policy_id}/toggle")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "mode": true
}

{
  "type": "http-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid domain name: ''''"
}

{
  "title": "Feature check fail",
  "type": "feature-check",
  "status": 401,
  "detail": "This feature is not available under your current plan. Please upgrade your plan to access this feature."
}

{
  "detail": "Permission denied"
}

{
  "title": "Resource not found",
  "type": "quota-check-no-resource",
  "status": 404,
  "detail": "The quota resource requested does not exist. Cannot enable WAAP for this domain. Please reach out to our support team."
}

{
  "type": "request-validation-failed",
  "title": "Request validation error.",
  "status": 422,
  "detail": "One or more fields have validation errors.",
  "errors": [
    {
      "loc": [
        "body",
        "name"
      ],
      "detail": "Input should be a valid string"
    },
    {
      "loc": [
        "body",
        "date"
      ],
      "detail": "Field required"
    },
    {
      "loc": [
        "query",
        "limit"
      ],
      "detail": "Field required"
    }
  ]
}

{
  "type": "internal-server-error",
  "title": "Internal server error.",
  "status": 500,
  "detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}

PATCH

waap

domains

{domain_id}

policies

{policy_id}

toggle

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
waap_policy_mode = client.waap.domains.policies.toggle(
    policy_id="policy_id",
    domain_id=1,
)
print(waap_policy_mode.mode)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/option"
	"github.com/G-Core/gcore-go/waap"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	waapPolicyMode, err := client.Waap.Domains.Policies.Toggle(
		context.TODO(),
		"policy_id",
		waap.DomainPolicyToggleParams{
			DomainID: 1,
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", waapPolicyMode.Mode)
}

const options = {method: 'PATCH', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/waap/v1/domains/{domain_id}/policies/{policy_id}/toggle', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/waap/v1/domains/{domain_id}/policies/{policy_id}/toggle",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/waap/v1/domains/{domain_id}/policies/{policy_id}/toggle")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "mode": true
}

{
  "type": "http-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid domain name: ''''"
}

{
  "title": "Feature check fail",
  "type": "feature-check",
  "status": 401,
  "detail": "This feature is not available under your current plan. Please upgrade your plan to access this feature."
}

{
  "detail": "Permission denied"
}

{
  "title": "Resource not found",
  "type": "quota-check-no-resource",
  "status": 404,
  "detail": "The quota resource requested does not exist. Cannot enable WAAP for this domain. Please reach out to our support team."
}

{
  "type": "request-validation-failed",
  "title": "Request validation error.",
  "status": 422,
  "detail": "One or more fields have validation errors.",
  "errors": [
    {
      "loc": [
        "body",
        "name"
      ],
      "detail": "Input should be a valid string"
    },
    {
      "loc": [
        "body",
        "date"
      ],
      "detail": "Field required"
    },
    {
      "loc": [
        "query",
        "limit"
      ],
      "detail": "Field required"
    }
  ]
}

{
  "type": "internal-server-error",
  "title": "Internal server error.",
  "status": 500,
  "detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}

Authorizations

Authorization

string

header

required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

domain_id

integer

required

The domain ID

policy_id

string

required

The ID of the policy to toggle

Response

Successful Response

Represents the mode of a security rule.

mode

boolean

required

Indicates if the security rule is active

Fetches rule sets associated with a specific domain Fetch the traffic data for a specific domain.

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Toggle the status of a given policy

Authorizations

Path Parameters

Response