GetPortCheck

A GET endpoint to check the status of a specific port on a given resolvable hostname or IPv4 address.

Use me as the host to auto-detect the requester IP address based on the following headers:

  • cf-connecting-ip
  • do-connecting-ip
  • x-real-ip

These headers are typically added by the application ingress router (ie, Nginx) and so does not need to be explicitly provided.

Note: Whilst the results of this endpoints port check are not logged, if a host is explicitly passed, the URL will be logged to STDOUT. For example;

"GET /foo.com/443 HTTP/1.1" 200 OK

If me is provided as the host, requester auto-detection will be used using the above headers. However, the requester will not be logged. For example;

"GET /me/443 HTTP/1.1" 200 OK

Application logs are not forwarded or permanently stored.

get/api/{host}/{port}

Request

  • Base URL: https://portchecker.io
  • URL: https://portchecker.io/api/{host}/{port}
  • Auth: none declared

Path parameters

hoststring required

The IPv4 address or hostname of the host to query

Example:example.com
portinteger required

The port number to query

Example:443

Response

Request fulfilled, document follows

Changes

No recorded changes to this operation across all 1 revision of this API.