This API exposes
8 operations
across 6 paths,
and defines 32 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.
8 operations6 paths32 schemas1 DELETE4 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Magic PCAP Collection 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 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Magic PCAP Collection 8
GET
/accounts/{account_id}/pcaps
APIs.io Engineering Platform List packet capture requests
The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are magic-visibility_pcaps_response_full (11 properties), magic-visibility_pcaps_request_full (8 properties), magic-visibility_pcaps_response_simple (7 properties), magic-visibility_pcaps_ownership_response (6 properties). Each schema is shown below with its type and property counts.
magic-visibility_api-response-single
object
magic-visibility_pcaps_system
string
The system used to collect packet captures.
magic-visibility_pcaps_colo_name
string
The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to full packet…
magic-visibility_pcaps_byte_limit
number
The maximum number of bytes to capture. This field only applies to full packet captures.
magic-visibility_pcaps_filter_v1
object
The packet capture filter. When this field is empty, all packets are captured.
5 properties
magic-visibility_identifier
string
Identifier
magic-visibility_pcaps_ownership_request
object
1 property1 required
magic-visibility_pcaps_request_full
object
8 properties5 required
magic-visibility_pcaps_status
string
The status of the packet capture request.
magic-visibility_pcaps_response_full
object
11 properties
magic-visibility_pcaps_id
string
The ID for the packet capture.
magic-visibility_pcaps_submitted
string
The RFC 3339 timestamp when the packet capture was created.
magic-visibility_pcaps_error_message
string
An error message that describes why the packet capture failed. This field only applies to full packet captures.
magic-visibility_api-response-common-failure
object
4 properties4 required
magic-visibility_pcaps_ownership_single_response
magic-visibility_pcaps_destination_conf
string
The full URI for the bucket. This field only applies to full packet captures.
magic-visibility_pcaps_packet_limit
number
The limit of packets contained in a packet capture.
magic-visibility_pcaps_request_simple
object
5 properties4 required
magic-visibility_pcaps_request_pcap
magic-visibility_result_info
object
4 properties
magic-visibility_pcaps_ownership_response
object
6 properties5 required
magic-visibility_pcaps_ownership_challenge
string
The ownership challenge filename stored in the bucket.
magic-visibility_api-response-common
object
4 properties4 required
magic-visibility_pcaps_collection_response
magic-visibility_pcaps_type
string
The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets.
magic-visibility_pcaps_time_limit
number
The packet capture duration in seconds.
magic-visibility_pcaps_ownership_collection
magic-visibility_messages
array
magic-visibility_pcaps_ownership_validate_request
object
2 properties2 required
magic-visibility_pcaps_single_response
magic-visibility_api-response-collection
object
magic-visibility_pcaps_response_simple
object
7 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
