Domains

Each and every test is done against a domain.

In order to limit misuse of our platform, we enforce that you must prove ownership for all domains that your team uses.

Permissions

Member role vs API call

List domains

Add domain

Validate domain

Remove domain

Reader

True

False

False

False

Editor

True

False

False

False

Admin

True

True

True

True

Owner

True

True

True

True

List domains

Web

In order to view the domains on our platform, all you have to do is browse to the Domains page.

API call

The API call is:

curl -s \
    -d '{"team_id":"my-team"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/domains/list | jq . -r

{
  "Domains": [
    {
      "domain_name": "my_domain",
      "domain_state": "validated",
      "validation_method": "DNS",
      "submitted_date": "2020-03-05T07:03:20Z",
      "validated_date": "2020-03-05T07:13:17Z",
      "validation_code": "som_validation_code"
    }
  ]
}

CLI

As simple as:

$ rungutan domains list
{
    "Domains": [
        {
            "domain_name": "rungutan.com",
            "domain_state": "validated",
            "validation_method": "DNS",
            "submitted_date": "2020-03-05T07:06:27Z",
            "validated_date": "2020-03-05T07:13:37Z",
            "validation_code": "AQICAHjBiPLidQ4JTVLBkQRmMJyRk8dwm1wk3EYAGfXKBY2PNQHu3fvOMLlhx3w1IKTXxwp6AAAAZjBkBgkqhkiG9w0BBwagVzBVAgEAMFAGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM1CExZHfXTMhWSWCLAgEQgCMyn6ORcasKf9B4qHEs98UvrrWJFl272IQygfWVmt9z0nb56A=="
        }
    ]
}

Add domains

Web

In order to add a new domain on our platform, all you have to do is browse to the Domains page and click on the Add domain button.

API call

The API call is:

curl -s \
    -d '{"team_id":"my-team", "domain_name": "my-domain.com"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/domains/add | jq . -r

{
  "message": "Successfully added your domain."
}

CLI

$ rungutan domains add --domain_name other-domain.com
{
    "message": "Successfully added your domain"
}

Validate domains

Web

In order to validate a domain on our platform, all you have to do is browse to the Domains page and:

  1. Click on the Copy validation code button for the respective domain

  2. Using that code, create either a DNS TXT record or publish a HTML file on your webserver

  3. Click on the Validate domain button for the respective domain

A sample validation code looks like this:

rungutan-domain-verification: AQICAHjBiPLidQ4JTVLBkQRmMJyRk8dwm1wk3EYAGfXKBY2PNQFalQtnfcJvEuefE1fjSIkTAAAAZjBkBgkqhkiG9w0BBwagVzBVAgEAMFAGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM55ZnwU5AyQjnzmfYAgEQgCMqxqSvq9mjRdEBaes3gqXy2hA8OnJ0idK5ITnF5qJhHJS9Cw==

PS: If you decide to go for HTML file instead of the much simpler DNS TXT record method, don’t worry, we check the following locations:

  • http(s)://my-domain.com/rungutan-domain-verification.html

  • http(s)://my-domain.com/rungutan-domain-verification

  • http(s)://my-domain.com/rungutan-domain-verification/

API call

The API call is:

curl -s \
    -d '{"team_id":"my-team", "domain_name": "my-domain.com"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/domains/validate | jq . -r

{
  "message": "Successfully validated your domain."
}

CLI

You might want to wait for the DNS to propagate first (if you’re using the DNS mechanism), but it’s as simple as:

$ rungutan domains validate --domain_name rungutan.com
{
    "message": "You have already validated this domain!"
}

Remove domains

Web

In order to remove a domain on our platform, all you have to do is browse to the Domains page anclick on the Remove domain button for the respective domain.

API call

The API call is:

curl -s \
    -d '{"team_id":"my-team", "domain_name": "my-domain.com"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/domains/remove | jq . -r

{
  "message": "Successfully removed your domain."
}

CLI

Drop it like it’s hot:

$ rungutan domains remove --domain_name other-domain.com
{
    "message": "Successfully removed your domain"
}