Whitelisted sources

PreviousStats

Was this helpful?

List whitelist sources

Get a list of whitelist resources

get

/whitelisted-sources

Query parameters

offsetinteger

Pagination offset

limitinteger

Pagination limit

orderBystring

Order the results by this field, in this direction

Example: createdAt:desc

Pattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.seedata.io/api/whitelisted-sources'

200

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-15T16:31:40.864Z",
      "updatedAt": "2025-02-15T16:31:40.864Z",
      "createdByType": "text",
      "createdById": "text",
      "updatedByType": "text",
      "updatedById": "text",
      "name": "text",
      "description": "text",
      "trustedDays": 1,
      "type": "domain",
      "settings": {
        "email": "hello@example.com"
      }
    }
  ]
}

Create whitelist

Create a whitelist (trusted resource)

post

/whitelisted-sources

Body

idstring uuid

createdAtstring date-time

updatedAtstring date-time

createdByTypenullable string

createdByIdnullable string

updatedByTypenullable string

updatedByIdnullable string

namestringrequired

Friendly name of trusted resource

descriptionnullable string

Freetext description of trusted resource

trustedDaysnullable number

Consider this resource trusted for this duration of time since the seed has been planted

typeenumrequired

Type of trusted resource

Options: domain, ip, email

settingsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.seedata.io/api/whitelisted-sources' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","type":"domain","settings":{}}'

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-15T16:31:40.864Z",
  "updatedAt": "2025-02-15T16:31:40.864Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "name": "text",
  "description": "text",
  "trustedDays": 1,
  "type": "domain",
  "settings": {
    "email": "hello@example.com"
  }
}

Created

Get whitelist

Get a single whitelisted-source

get

/whitelisted-sources/{whitelistId}

Path parameters

whitelistIdstring uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.seedata.io/api/whitelisted-sources/{whitelistId}'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-15T16:31:40.864Z",
  "updatedAt": "2025-02-15T16:31:40.864Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "name": "text",
  "description": "text",
  "trustedDays": 1,
  "type": "domain",
  "settings": {
    "email": "hello@example.com"
  }
}

Delete whitelist

Delete a whitelist resource

delete

/whitelisted-sources/{whitelistId}

Path parameters

whitelistIdstring uuidrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://app.seedata.io/api/whitelisted-sources/{whitelistId}'

204

No body

No Content

Update whitelist

Update a whitelisted-source

patch

/whitelisted-sources/{whitelistId}

Path parameters

whitelistIdstring uuidrequired

Body

statusstring

Whitelisted-source description

trustedDaysnumber

Number of days which this source will be whitelisted for

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://app.seedata.io/api/whitelisted-sources/{whitelistId}' \
  --header 'Content-Type: application/json'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-15T16:31:40.864Z",
  "updatedAt": "2025-02-15T16:31:40.864Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "name": "text",
  "description": "text",
  "trustedDays": 1,
  "type": "domain",
  "settings": {
    "email": "hello@example.com"
  }
}