A sending domain's DNS records with their live status

GET

/api/v1/workspaces/{workspace}/domains/{domainId}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Permission: providers:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

domainId

required

string format: uuid

Query Parameters

provider

Only the records this provider needs (and the domain-wide ones)

string

Only the records this provider needs (and the domain-wide ones)

refresh

Check DNS again first when the last check is older than 20 seconds

boolean

Check DNS again first when the last check is older than 20 seconds

Responses

200

application/json

object

bimi

required

string

canManage

required

boolean

checkedAt

string format: date-time

cloudflare

required

boolean

counts

required

object

missing

required

integer format: int64

pending

required

integer format: int64

total

required

integer format: int64

verified

required

integer format: int64

dmarcTip

required

string

dnsHost

required

string

domain

required

string

helpers

required

Array<string>

required

string

nameservers

required

Array<string>

note

required

string

notes

required

Array<object>

object

provider

required

string

providerId

required

string

text

required

string

providers

required

Array<object>

object

adapter

required

string

required

string

name

required

string

short

required

string

records

required

Array<object>

object

checkedAt

string format: date-time

found

string

key

required

string

label

required

string

name

required

string

note

required

string

provider

required

string

providerId

required

string

purpose

required

string

Allowed values: dkim return_path spf dmarc verification

status

required

string

Allowed values: verified pending wrong_value missing error

statusText

required

string

type

required

string

value

required

string

zoneLine

required

string

senders

required

integer format: int64

status

required

string

Allowed values: pending verified partial failed

tracking

required

object

domain

required

string

status

required

string

Allowed values: none pending verified wrong_value missing error

suggested

required

string

target

required

string

Example

{
  "records": [
    {
      "purpose": "dkim",
      "status": "verified"
    }
  ],
  "status": "pending",
  "tracking": {
    "status": "none"
  }
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}