Whitelisted sources
Get a list of whitelist resources
Query parameters
offsetintegerOptional
Pagination offset
limitinteger · min: 1 · max: 100Optional
Pagination limit
orderBystringOptionalExample:
Order the results by this field, in this direction
createdAt:desc
Pattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$
Responses
200
OK
application/json
get
GET /api/whitelisted-sources HTTP/1.1
Host: app.seedata.io
Accept: */*
200
OK
{
"metadata": {
"totalCount": 1,
"offset": 1,
"limit": 1
},
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "domain",
"name": "text",
"description": "text",
"trustedDays": 1,
"createdAt": "2025-06-24T04:31:34.446Z",
"updatedAt": "2025-06-24T04:31:34.446Z",
"createdByType": "text",
"createdById": "text",
"updatedByType": "text",
"updatedById": "text",
"settings": {
"email": "[email protected]"
}
}
]
}
Create a whitelist (trusted resource)
Body
A trusted resource (e.g. email, domain, IP)
idstring · uuidRead-onlyOptional
typestring · enumRequiredPossible values:
Type of trusted resource
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
or
or
or
Responses
201
Created
application/json
post
POST /api/whitelisted-sources HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"type": "domain",
"name": "text",
"description": "text",
"trustedDays": 1,
"settings": {
"email": "[email protected]"
}
}
201
Created
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "domain",
"name": "text",
"description": "text",
"trustedDays": 1,
"createdAt": "2025-06-24T04:31:34.446Z",
"updatedAt": "2025-06-24T04:31:34.446Z",
"createdByType": "text",
"createdById": "text",
"updatedByType": "text",
"updatedById": "text",
"settings": {
"email": "[email protected]"
}
}
Get a single whitelisted-source
Path parameters
whitelistIdstring · uuidRequired
Responses
200
OK
application/json
get
GET /api/whitelisted-sources/{whitelistId} HTTP/1.1
Host: app.seedata.io
Accept: */*
200
OK
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "domain",
"name": "text",
"description": "text",
"trustedDays": 1,
"createdAt": "2025-06-24T04:31:34.446Z",
"updatedAt": "2025-06-24T04:31:34.446Z",
"createdByType": "text",
"createdById": "text",
"updatedByType": "text",
"updatedById": "text",
"settings": {
"email": "[email protected]"
}
}
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
200
OK
application/json
patch
PATCH /api/whitelisted-sources/{whitelistId} HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"status": "text",
"trustedDays": 1
}
200
OK
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "domain",
"name": "text",
"description": "text",
"trustedDays": 1,
"createdAt": "2025-06-24T04:31:34.446Z",
"updatedAt": "2025-06-24T04:31:34.446Z",
"createdByType": "text",
"createdById": "text",
"updatedByType": "text",
"updatedById": "text",
"settings": {
"email": "[email protected]"
}
}
Was this helpful?