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:descPattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

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-04-22T04:05:56.291Z",
      "updatedAt": "2025-04-22T04:05:56.291Z",
      "createdByType": "text",
      "createdById": "text",
      "updatedByType": "text",
      "updatedById": "text",
      "settings": {
        "email": "[e-mail]"
      }
    }
  ]
}

Create whitelist

post

Create a whitelist (trusted resource)

Body

A trusted resource (e.g. email, domain, IP)

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

objectOptional

A trusted resource (e.g. email, domain, IP)

post

HTTPcURLJavaScriptPython

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": "[e-mail]"
  }
}

201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "domain",
  "name": "text",
  "description": "text",
  "trustedDays": 1,
  "createdAt": "2025-04-22T04:05:56.291Z",
  "updatedAt": "2025-04-22T04:05:56.291Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}

Get whitelist

get

Get a single whitelisted-source

Path parameters

whitelistIdstring · uuidRequired

Responses

application/json

objectOptional

A trusted resource (e.g. email, domain, IP)

get

HTTPcURLJavaScriptPython

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-04-22T04:05:56.291Z",
  "updatedAt": "2025-04-22T04:05:56.291Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}

Delete whitelist

delete

Delete a whitelist resource

Path parameters

whitelistIdstring · uuidRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /api/whitelisted-sources/{whitelistId} HTTP/1.1
Host: app.seedata.io
Accept: */*

204

No Content

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

objectOptional

A trusted resource (e.g. email, domain, IP)

patch

HTTPcURLJavaScriptPython

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-04-22T04:05:56.291Z",
  "updatedAt": "2025-04-22T04:05:56.291Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}