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

Nym Technologies dVPN Directory Cache API

The dVPN Directory Cache API from Nym Technologies — 9 operation(s) for dvpn directory cache.

Nym Technologies dVPN Directory Cache API is one of 23 APIs that Nym Technologies publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include dVPN Directory Cache. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 9 paths, and defines 26 schemas. It is described by OpenAPI 3.1.0, at version 4.6.2.

Requests are made against the base URL https://validator.nymtech.net/api.

9 operations 9 paths 26 schemas 9 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.6.2
Base URL
https://validator.nymtech.net/api
Contact
Nym Technologies SA
License
Apache-2.0
Resource Areas
1

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 GET. Each is listed below with its method, path, parameters, and response codes.

dVPN Directory Cache 9
GET
/dvpn/v1/directory/gateways
Gets available entry and exit gateways from the Nym network directory
getGateways 1 param → 200
GET
/dvpn/v1/directory/gateways/countries
Gets available exit gateway countries as two-letter ISO country codes from the Nym network directory
getGatewayCountries → 200
GET
/dvpn/v1/directory/gateways/country/{two_letter_country_code}
Gets available gateways from the Nym network directory by country
getGatewaysByCountry 1 param → 200
GET
/dvpn/v1/directory/gateways/entry
Gets available entry gateways from the Nym network directory
getEntryGateways → 200
GET
/dvpn/v1/directory/gateways/entry/countries
Gets available entry gateway countries as two-letter ISO country codes from the Nym network directory
getEntryGatewayCountries → 200
GET
/dvpn/v1/directory/gateways/entry/country/{two_letter_country_code}
Gets available entry gateways from the Nym network directory by country
getEntryGatewaysByCountry 1 param → 200
GET
/dvpn/v1/directory/gateways/exit
Gets available exit gateways from the Nym network directory
getExitGateways → 200
GET
/dvpn/v1/directory/gateways/exit/countries
Gets available exit gateway countries as two-letter ISO country codes from the Nym network directory
getExitGatewayCountries → 200
GET
/dvpn/v1/directory/gateways/exit/country/{two_letter_country_code}
Gets available exit gateways from the Nym network directory by country
getExitGatewaysByCountry 1 param → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are WgProbeResults (24 properties), DVpnGateway (20 properties), BinaryBuildInformationOwned (10 properties), Location (9 properties). Each schema is shown below with its type and property counts.

BasicEntryInformation
object
3 properties 1 required
Exit
object
5 properties 5 required
WgProbeResults
object
24 properties 15 required
AuthenticatorDetailsV1
object
1 property 1 required
BridgeInformation
object
2 properties 2 required
DvpnProbeOutcome
object
this structure is parsed on VPN API so it has some fields which must not be changed
5 properties 1 required
LewesProtocolDetailsDataV1
object
5 properties 5 required
DvpnGwProbe
object
gateway probe output returned on the API
2 properties 2 required
NodeFamilyInformation
object
5 properties 5 required
Location
object
9 properties 8 required
Entry
BinaryBuildInformationOwned
object
10 properties 9 required
Asn
object
5 properties 5 required
LpProbeResults
object
4 properties 3 required
LewesProtocolDetailsV1
object
2 properties 2 required
NodeRole
EntryTestResult
object
2 properties 2 required
IpPacketRouterDetailsV1
object
1 property 1 required
QuicClientOptions
object
3 properties 2 required
NodeStakeInformation
object
4 properties 4 required
AsnKind
string
ScoreValue
string
DVpnGateway
object
20 properties 8 required
Socks5
object
3 properties 2 required
DVpnGatewayPerformance
object
5 properties 5 required
BridgeParameters

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nym-technologies-dvpn-directory-cache-api-openapi.yml Raw ↑

Other APIs Nym Technologies publishes across the network.

Nym Technologies API Status API
Nym Technologies circulating-supply API
Nym Technologies contract-cache API
Nym Technologies Ecash API
Nym Technologies Ecash Global Data API
Nym Technologies Gateways API
Nym Technologies Mixnodes API
Nym Technologies network API
Nym Technologies network-monitor-status API
Nym Technologies Node Families API
Nym Technologies Nym Explorer API
Nym Technologies Nym Nodes API