Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 1.69 KB

File metadata and controls

67 lines (51 loc) · 1.69 KB
description
Resolves DNS url records (URL records) for a hostname

DNS Resolve srv

URL Requires Auth HTTP Method
api/v1/dns.resolve.srv YES POST

Headers

Argument Example Required Description
X-User-Id myuser-name Required Your username hash (returned after you log in through the API)
X-Auth-Token myauth-token Required Your token (returned after you log in through the API)

Query Params

Argument Example Required Description
url localhost:3000 true The hostname

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/dns.resolve.srv?url=open.rocket.chat\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Result

Success

{
    "success": true
}

Errors

The following errors can occur upon the endpoint.

  • Authorization: Requires an authentication token for the request to be made.
  • Invalid Hostname: Requires a valid hostname for the request to be made.

{% tabs %} {% tab title=" Authorization" %}

{
    "status": "error",
    "message": "You must be logged in to do this."
}

{% endtab %}

{% tab title="Invalid Hostname" %}

{
    "success": false,
    "error": "querySrv ENOTFOUND .rocket.chat/"
}

{% endtab %} {% endtabs %}