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 Configuration API

The Magic Network Monitoring Configuration API from APIs.io Engineering Platform — 2 operation(s) for magic network monitoring configuration.

This API exposes 6 operations across 2 paths, and defines 13 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.

6 operations 2 paths 13 schemas 1 DELETE2 GET1 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 Configuration 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 6

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

Magic Network Monitoring Configuration 6
DELETE
/accounts/{account_id}/mnm/config
APIs.io Engineering Platform Delete account configuration
magic-network-monitoring-configuration-delete-account-configuration 1 param body → 4XX200
GET
/accounts/{account_id}/mnm/config
APIs.io Engineering Platform List account configuration
magic-network-monitoring-configuration-list-account-configuration 1 param → 4XX200
PATCH
/accounts/{account_id}/mnm/config
APIs.io Engineering Platform Update account configuration fields
magic-network-monitoring-configuration-update-account-configuration-fields 1 param body → 4XX200
POST
/accounts/{account_id}/mnm/config
APIs.io Engineering Platform Create account configuration
magic-network-monitoring-configuration-create-account-configuration 1 param body → 4XX200
PUT
/accounts/{account_id}/mnm/config
APIs.io Engineering Platform Update an entire account configuration
magic-network-monitoring-configuration-update-an-entire-account-configuration 1 param body → 4XX200
GET
/accounts/{account_id}/mnm/config/full
APIs.io Engineering Platform List rules and account configuration
magic-network-monitoring-configuration-list-rules-and-account-configuration 1 param → 4XX200

Schemas 13

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

magic-visibility_api-response-single
object
magic-visibility_mnm_config_router_ip
string
IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported.
magic-visibility_messages
array
magic-visibility_mnm_config_router_ips
array
magic-visibility_api-response-common-failure
object
4 properties 4 required
magic-visibility_account_identifier
string
magic-visibility_api-response-common
object
4 properties 4 required
magic-visibility_mnm_config
object
4 properties 4 required
magic-visibility_mnm_config_warp_device
object
Object representing a warp device with an ID and name.
3 properties 3 required
magic-visibility_mnm_config_warp_devices
array
magic-visibility_mnm_config_name
string
The account name.
magic-visibility_mnm_config_default_sampling
number
Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
magic-visibility_mnm_config_single_response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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