Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Magic Network Monitoring Rules API

The Magic Network Monitoring Rules API from APIs.io Engineering Platform — 3 operation(s) for magic network monitoring rules.

This API exposes 7 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

7 operations 3 paths 20 schemas 1 DELETE2 GET2 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Magic Network Monitoring Rules API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 2 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Magic Network Monitoring Rules 7
GET
/accounts/{account_id}/mnm/rules
APIs.io Engineering Platform List rules
magic-network-monitoring-rules-list-rules 1 param → 4XX200
POST
/accounts/{account_id}/mnm/rules
APIs.io Engineering Platform Create rules
magic-network-monitoring-rules-create-rules 1 param body → 4XX200
PUT
/accounts/{account_id}/mnm/rules
APIs.io Engineering Platform Update rules
magic-network-monitoring-rules-update-rules 1 param body → 4XX200
DELETE
/accounts/{account_id}/mnm/rules/{rule_id}
APIs.io Engineering Platform Delete rule
magic-network-monitoring-rules-delete-rule 2 params body → 4XX200
GET
/accounts/{account_id}/mnm/rules/{rule_id}
APIs.io Engineering Platform Get rule
magic-network-monitoring-rules-get-rule 2 params → 4XX200
PATCH
/accounts/{account_id}/mnm/rules/{rule_id}
APIs.io Engineering Platform Update rule
magic-network-monitoring-rules-update-rule 2 params body → 4XX200
PATCH
/accounts/{account_id}/mnm/rules/{rule_id}/advertisement
APIs.io Engineering Platform Update advertisement for rule
magic-network-monitoring-rules-update-advertisement-for-rule 2 params body → 4XX200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are magic-visibility_mnm_rule (7 properties), magic-visibility_result_info (4 properties), magic-visibility_api-response-common (4 properties), magic-visibility_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

magic-visibility_rule_identifier
string
The id of the rule. Must be unique.
magic-visibility_api-response-single
object
magic-visibility_mnm_rule_automatic_advertisement
boolean
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…
magic-visibility_mnm_rule
object
7 properties 4 required
magic-visibility_api-response-common-failure
object
4 properties 4 required
magic-visibility_mnm_rule_advertisement_single_response
magic-visibility_mnm_rule_ip_prefixes
array
magic-visibility_mnm_rule_bandwidth_threshold
number
The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.
magic-visibility_account_identifier
string
magic-visibility_mnm_rules_collection_response
magic-visibility_result_info
object
4 properties
magic-visibility_mnm_rule_duration
string
The amount of time that the rule threshold must be exceeded to send an alert notification. The final value must be equivalent to one of the following 8 values…
magic-visibility_api-response-common
object
4 properties 4 required
magic-visibility_mnm_rule_packet_threshold
number
The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.
magic-visibility_mnm_rule_advertisable_response
object
1 property 1 required
magic-visibility_mnm_rule_name
string
The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (), dash (-), period (.), and tilde (~). You can’t have a space in the rule…
magic-visibility_mnm_rules_single_response
magic-visibility_mnm_rule_ip_prefix
string
The IP prefixes that are monitored for this rule. Must be a CIDR range like 203.0.113.0/24. Max 5000 different CIDR ranges.
magic-visibility_messages
array
magic-visibility_api-response-collection
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-network-monitoring-rules-api-openapi.yml Raw ↑