How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.

APIs.io Engineering Platform Diagnostics API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Diagnostics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://{bucketname}.s3.amazonaws.com.

1 operations 1 paths 38 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Diagnostics API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

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_options (5 properties), magic-transit_colo_result (5 properties), magic-transit_result_info (4 properties). Each schema is shown below with its type and property counts.

magic-transit_options
object
5 properties
magic-transit_asn
string
AS number associated with the node object.
magic-transit_node_result
object
9 properties
magic-transit_messages
array
magic-transit_std_dev_rtt_ms
number
Standard deviation of the RTTs in ms.
magic-transit_packets_lost
integer
Number of packets where no response was received.
magic-transit_min_rtt_ms
number
Minimum RTT in ms.
magic-transit_identifier
string
Identifier
magic-transit_packets_per_ttl
integer
Number of packets sent at each TTL.
magic-transit_targets
array
magic-transit_ip
string
IP address of the node.
magic-transit_wait_time
integer
Set the time (in seconds) to wait for a response to a probe.
magic-transit_traceroute_time_ms
integer
Total time of traceroute in ms.
magic-transit_max_ttl
integer
Max TTL.
magic-transit_packet_type
string
Type of packet sent.
magic-transit_target_summary
object
Aggregated statistics from all hops about the target.
magic-transit_target
string
The target hostname, IPv6, or IPv6 address.
magic-transit_target_result
object
2 properties
magic-transit_mean_rtt_ms
number
Mean RTT in ms.
magic-transit_packet_count
integer
Number of packets with a response from this node.
magic-transit_colo_name
string
Source colo name.
magic-transit_api-response-common-failure
object
4 properties 4 required
magic-transit_error
string
Errors resulting from collecting traceroute from colo to target.
magic-transit_packets_sent
integer
Number of packets sent with specified TTL.
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_colos
array
If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.
magic-transit_colo
object
2 properties
magic-transit_api-response-common
object
4 properties 4 required
magic-transit_traceroute_response_collection
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_hop_result
object
4 properties
magic-transit_name
string
Host name of the address, this may be the same as the IP address.
magic-transit_api-response-collection
object
magic-transit_colo_city
string
Source colo city.
magic-transit_packets_ttl
integer
The time to live (TTL).
magic-transit_result_info
object
4 properties
magic-transit_max_rtt_ms
number
Maximum RTT in ms.
magic-transit_colo_result
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Diagnostics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.