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

The Diagnostics API from APIs.io Engineering Platform — 1 operation(s) for diagnostics.

This API exposes 1 operation across 1 path, and defines 38 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.

1 operations 1 paths 38 schemas 1 POST

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 Diagnostics 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Diagnostics 1
POST
/accounts/{account_id}/diagnostics/traceroute
APIs.io Engineering Platform Traceroute
diagnostics-traceroute 1 param body → 4XX200

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are magic-transit_node_result (9 properties), magic-transit_colo_result (5 properties), magic-transit_options (5 properties), magic-transit_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

magic-transit_api-response-common
object
4 properties 4 required
magic-transit_wait_time
integer
Set the time (in seconds) to wait for a response to a probe.
magic-transit_packets_ttl
integer
The time to live (TTL).
magic-transit_mean_rtt_ms
number
Mean RTT in ms.
magic-transit_std_dev_rtt_ms
number
Standard deviation of the RTTs in ms.
magic-transit_colo_city
string
Source colo city.
magic-transit_port
integer
For UDP and TCP, specifies the destination port. For ICMP, specifies the initial ICMP sequence value. Default value 0 will choose the best value to use for eac…
magic-transit_ip
string
IP address of the node.
magic-transit_node_result
object
9 properties
magic-transit_api-response-common-failure
object
4 properties 4 required
magic-transit_options
object
5 properties
magic-transit_packets_per_ttl
integer
Number of packets sent at each TTL.
magic-transit_traceroute_time_ms
integer
Total time of traceroute in ms.
magic-transit_asn
string
AS number associated with the node object.
magic-transit_packet_count
integer
Number of packets with a response from this node.
magic-transit_packet_type
string
Type of packet sent.
magic-transit_messages
array
magic-transit_hop_result
object
4 properties
magic-transit_target_summary
object
Aggregated statistics from all hops about the target.
magic-transit_labels
array
Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which tracer…
magic-transit_max_ttl
integer
Max TTL.
magic-transit_name
string
Host name of the address, this may be the same as the IP address.
magic-transit_packets_sent
integer
Number of packets sent with specified TTL.
magic-transit_target
string
The target hostname, IPv6, or IPv6 address.
magic-transit_targets
array
magic-transit_api-response-collection
object
magic-transit_result_info
object
4 properties
magic-transit_colo_result
object
5 properties
magic-transit_max_rtt_ms
number
Maximum RTT in ms.
magic-transit_min_rtt_ms
number
Minimum RTT in ms.
magic-transit_packets_lost
integer
Number of packets where no response was received.
magic-transit_colos
array
If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.
magic-transit_traceroute_response_collection
magic-transit_target_result
object
2 properties
magic-transit_error
string
Errors resulting from collecting traceroute from colo to target.
magic-transit_colo_name
string
Source colo name.
magic-transit_identifier
string
Identifier
magic-transit_colo
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-diagnostics-api-openapi.yml Raw ↑