Whitelisted sources

List whitelist sources

Get a list of whitelist resources

GEThttps://app.seedata.io/api/whitelisted-sources

Query parameters

Response

200

OK

Body

application/json

metadatametadata

Pagination Metadata

itemsarray of Whitelisted Source

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/whitelisted-sources', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "metadata": {},
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "domain",
      "name": "text",
      "description": "text",
      "trustedDays": 0,
      "createdAt": "2024-05-11T22:47:07.858Z",
      "updatedAt": "2024-05-11T22:47:07.858Z",
      "createdByType": "text",
      "createdById": "text",
      "updatedByType": "text",
      "updatedById": "text",
      "settings": {
        "email": "[e-mail]"
      }
    }
  ]
}

Create whitelist

Create a whitelist (trusted resource)

POSThttps://app.seedata.io/api/whitelisted-sources

Body

application/json

idstring (uuid)

type*enum

Type of trusted resource

domainipemail

name*string

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

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypenullable string

createdByIdnullable string

updatedByTypenullable string

updatedByIdnullable string

settings*object

objectobjectobjectobject

Response

201

Created

Body

application/json

idstring (uuid)

type*enum

Type of trusted resource

domainipemail

name*string

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

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypenullable string

createdByIdnullable string

updatedByTypenullable string

updatedByIdnullable string

settings*object

objectobjectobjectobject

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/whitelisted-sources', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "domain",
      "name": "text",
      "settings": {
        "email": "[e-mail]"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "domain",
  "name": "text",
  "description": "text",
  "trustedDays": 0,
  "createdAt": "2024-05-11T22:47:07.858Z",
  "updatedAt": "2024-05-11T22:47:07.858Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}

Get whitelist

Get a single whitelisted-source

GEThttps://app.seedata.io/api/whitelisted-sources/{whitelistId}

Path parameters

whitelistId*string (uuid)

Response

200

OK

Body

application/json

idstring (uuid)

type*enum

Type of trusted resource

domainipemail

name*string

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

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypenullable string

createdByIdnullable string

updatedByTypenullable string

updatedByIdnullable string

settings*object

objectobjectobjectobject

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/whitelisted-sources/{whitelistId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "domain",
  "name": "text",
  "description": "text",
  "trustedDays": 0,
  "createdAt": "2024-05-11T22:47:07.858Z",
  "updatedAt": "2024-05-11T22:47:07.858Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}

Delete whitelist

Delete a whitelist resource

DELETEhttps://app.seedata.io/api/whitelisted-sources/{whitelistId}

Path parameters

whitelistId*string (uuid)

Response

204

No Content

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/whitelisted-sources/{whitelistId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update whitelist

Update a whitelisted-source

PATCHhttps://app.seedata.io/api/whitelisted-sources/{whitelistId}

Path parameters

whitelistId*string (uuid)

Body

application/json

statusstring

Whitelisted-source description

trustedDaysnumber

Number of days which this source will be whitelisted for

Response

200

OK

Body

application/json

idstring (uuid)

type*enum

Type of trusted resource

domainipemail

name*string

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

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypenullable string

createdByIdnullable string

updatedByTypenullable string

updatedByIdnullable string

settings*object

objectobjectobjectobject

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/whitelisted-sources/{whitelistId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "domain",
  "name": "text",
  "description": "text",
  "trustedDays": 0,
  "createdAt": "2024-05-11T22:47:07.858Z",
  "updatedAt": "2024-05-11T22:47:07.858Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "settings": {
    "email": "[e-mail]"
  }
}