Whitelisted sources

List whitelist sources

get

Get a list of whitelist resources

Query parameters

offsetintegeroptional

Pagination offset

limitinteger · min: 1 · max: 100optional

Pagination limit

orderBystringoptional

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

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

200

200

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "domain",
      "name": "text",
      "description": "text",
      "trustedDays": 1,
      "createdAt": "2025-03-31T16:42:14.935Z",
      "updatedAt": "2025-03-31T16:42:14.935Z",
      "createdByType": "text",
      "createdById": "text",
      "updatedByType": "text",
      "updatedById": "text",
      "settings": {
        "email": "[e-mail]"
      }
    }
  ]
}

OK

Create whitelist

post

Create a whitelist (trusted resource)

Body

idstring · uuidread-onlyoptional

typestring · enumrequired

Type of trusted resource

Available options:

namestringrequired

Friendly name of trusted resource

descriptionstring | nullableoptional

Freetext description of trusted resource

trustedDaysnumber | nullableoptional

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

createdAtstring · date-timeread-onlyoptional

updatedAtstring · date-timeread-onlyoptional

createdByTypestring | nullableread-onlyoptional

createdByIdstring | nullableread-onlyoptional

updatedByTypestring | nullableread-onlyoptional

updatedByIdstring | nullableread-onlyoptional

settingsany ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "domain",
  "name": "text",
  "description": "text",
  "trustedDays": 1,
  "createdAt": "2025-03-31T16:42:14.935Z",
  "updatedAt": "2025-03-31T16:42:14.935Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}

Created

Get whitelist

get

Get a single whitelisted-source

Path parameters

whitelistIdstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "domain",
  "name": "text",
  "description": "text",
  "trustedDays": 1,
  "createdAt": "2025-03-31T16:42:14.935Z",
  "updatedAt": "2025-03-31T16:42:14.935Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}

OK

Delete whitelist

delete

Delete a whitelist resource

Path parameters

whitelistIdstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

204

No body

No Content

Update whitelist

patch

Update a whitelisted-source

Path parameters

whitelistIdstring · uuidrequired

Body

statusstringoptional

Whitelisted-source description

trustedDaysnumberoptional

Number of days which this source will be whitelisted for

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app.seedata.io/api/whitelisted-sources/{whitelistId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "text",
    "trustedDays": 1
  }'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "domain",
  "name": "text",
  "description": "text",
  "trustedDays": 1,
  "createdAt": "2025-03-31T16:42:14.935Z",
  "updatedAt": "2025-03-31T16:42:14.935Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}

OK