Update advertisement for rule

client.magicNetworkMonitoring.rules.advertisements.edit(, , ?): Advertisement { automatic_advertisement } | null

PATCH/accounts/{account_id}/mnm/rules/{rule_id}/advertisement

Update advertisement for rule.

Security

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)

Magic Network Monitoring AdminMagic Network Monitoring Config Write

ParametersExpand Collapse

ruleId: string

The id of the rule. Must be unique.

params: AdvertisementEditParams { account_id, body }

account_id: string

Path param

body: unknown

Body param

ReturnsExpand Collapse

Advertisement { automatic_advertisement } | null

automatic_advertisement: boolean | null

Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit.

Update advertisement for rule

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const advertisement = await client.magicNetworkMonitoring.rules.advertisements.edit(
  '2890e6fa406311ed9b5a23f70f6fb8cf',
  {
    account_id: '6f91088a406011ed95aed352566e8d4c',
    body: {},
  },
);

console.log(advertisement.automatic_advertisement);

{
  "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": {
    "automatic_advertisement": true
  },
  "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": {
    "automatic_advertisement": true
  },
  "success": true
}