Deployments

List deployments

GEThttps://app.seedata.io/api/deployments

Query parameters

Response

Body

metadatametadata

Pagination Metadata

itemsarray of Deployment Schedule

Request

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

Response

{
  "metadata": {
    "totalCount": 0,
    "offset": 0,
    "limit": 0
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "running",
      "organisationId": "123e4567-e89b-12d3-a456-426614174000",
      "seedType": "email",
      "seedContentType": "text",
      "seedContentKeywords": [
        "text"
      ],
      "seedContentLocales": [
        "text"
      ],
      "maxSeeds": 0,
      "seedLifespan": 0,
      "scheduleRate": "text",
      "nextScheduledRun": "2024-12-21T11:36:13.562Z",
      "destinationId": "123e4567-e89b-12d3-a456-426614174000",
      "failureMessage": "text",
      "muteNotifications": false,
      "seedImpact": 0,
      "createdAt": "2024-12-21T11:36:13.562Z",
      "updatedAt": "2024-12-21T11:36:13.562Z",
      "createdByType": "text",
      "createdById": "text",
      "updatedByType": "text",
      "updatedById": "text"
    }
  ]
}

Create deployment

Endpoint used for creating a deployment schedule.

POSThttps://app.seedata.io/api/deployments

Body

idstring (uuid)

name*string

descriptionnullable string

status*enum

runningstoppeddeletedinitialisingfailed

organisationIdstring (uuid)

seedType*enum

emaildocxdocx__financial_reportdocx__intelectual_property_reportdocx__strategic_plandocx__supplier_agreementxlsxpdfhtmlsvgdns_redirectaws_credentialshoneypot__printerhoneypot__linux_5honeypot__windows_10honeypot__windows_server_2016

seedContentTypenullable string

Type of content generated from AI

seedContentKeywordsnullable array of string

List of content keywords to use for generative AI

seedContentLocalesnullable array of string

List of locales to use for Person Seed Type

maxSeeds*number

seedLifespan*number

scheduleRatenullable string

nextScheduledRunnullable string (date-time)

destinationIdnullable string (uuid)

ID of target Integration used for the planting of seeds

failureMessagenullable string

muteNotifications*boolean

seedImpact*number

The impact of the seed on the target system

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypestring

createdByIdstring

updatedByTypenullable string

updatedByIdnullable string

Response

Created

Body

idstring (uuid)

name*string

descriptionnullable string

status*enum

runningstoppeddeletedinitialisingfailed

organisationIdstring (uuid)

seedType*enum

seedContentTypenullable string

Type of content generated from AI

seedContentKeywordsnullable array of string

List of content keywords to use for generative AI

seedContentLocalesnullable array of string

List of locales to use for Person Seed Type

maxSeeds*number

seedLifespan*number

scheduleRatenullable string

nextScheduledRunnullable string (date-time)

destinationIdnullable string (uuid)

ID of target Integration used for the planting of seeds

failureMessagenullable string

muteNotifications*boolean

seedImpact*number

The impact of the seed on the target system

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypestring

createdByIdstring

updatedByTypenullable string

updatedByIdnullable string

Request

const response = await fetch('https://app.seedata.io/api/deployments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "status": "running",
      "seedType": "email",
      "seedLifespan": 0,
      "maxSeeds": 0,
      "muteNotifications": false,
      "seedImpact": 0
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "running",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedType": "email",
  "seedContentType": "text",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ],
  "maxSeeds": 0,
  "seedLifespan": 0,
  "scheduleRate": "text",
  "nextScheduledRun": "2024-12-21T11:36:13.562Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": false,
  "seedImpact": 0,
  "createdAt": "2024-12-21T11:36:13.562Z",
  "updatedAt": "2024-12-21T11:36:13.562Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

Get deployment

Get a single deployment schedule

GEThttps://app.seedata.io/api/deployments/{deployment_schedule_id}

Path parameters

deployment_schedule_id*string (uuid)

Response

Body

idstring (uuid)

name*string

descriptionnullable string

status*enum

runningstoppeddeletedinitialisingfailed

organisationIdstring (uuid)

seedType*enum

seedContentTypenullable string

Type of content generated from AI

seedContentKeywordsnullable array of string

List of content keywords to use for generative AI

seedContentLocalesnullable array of string

List of locales to use for Person Seed Type

maxSeeds*number

seedLifespan*number

scheduleRatenullable string

nextScheduledRunnullable string (date-time)

destinationIdnullable string (uuid)

ID of target Integration used for the planting of seeds

failureMessagenullable string

muteNotifications*boolean

seedImpact*number

The impact of the seed on the target system

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypestring

createdByIdstring

updatedByTypenullable string

updatedByIdnullable string

Request

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

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "running",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedType": "email",
  "seedContentType": "text",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ],
  "maxSeeds": 0,
  "seedLifespan": 0,
  "scheduleRate": "text",
  "nextScheduledRun": "2024-12-21T11:36:13.562Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": false,
  "seedImpact": 0,
  "createdAt": "2024-12-21T11:36:13.562Z",
  "updatedAt": "2024-12-21T11:36:13.562Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

Delete deployment

Delete a deployment schedule

DELETEhttps://app.seedata.io/api/deployments/{deployment_schedule_id}

Path parameters

deployment_schedule_id*string (uuid)

Response

Body

idstring (uuid)

name*string

descriptionnullable string

status*enum

runningstoppeddeletedinitialisingfailed

organisationIdstring (uuid)

seedType*enum

seedContentTypenullable string

Type of content generated from AI

seedContentKeywordsnullable array of string

List of content keywords to use for generative AI

seedContentLocalesnullable array of string

List of locales to use for Person Seed Type

maxSeeds*number

seedLifespan*number

scheduleRatenullable string

nextScheduledRunnullable string (date-time)

destinationIdnullable string (uuid)

ID of target Integration used for the planting of seeds

failureMessagenullable string

muteNotifications*boolean

seedImpact*number

The impact of the seed on the target system

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypestring

createdByIdstring

updatedByTypenullable string

updatedByIdnullable string

Request

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

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "running",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedType": "email",
  "seedContentType": "text",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ],
  "maxSeeds": 0,
  "seedLifespan": 0,
  "scheduleRate": "text",
  "nextScheduledRun": "2024-12-21T11:36:13.562Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": false,
  "seedImpact": 0,
  "createdAt": "2024-12-21T11:36:13.562Z",
  "updatedAt": "2024-12-21T11:36:13.562Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

Update deployment

PATCHhttps://app.seedata.io/api/deployments/{deployment_schedule_id}

Path parameters

deployment_schedule_id*string (uuid)

Body

statusstring

Deployment Status

muteNotificationsboolean

Mute notifications from this deployment

Response

Body

idstring (uuid)

name*string

descriptionnullable string

status*enum

runningstoppeddeletedinitialisingfailed

organisationIdstring (uuid)

seedType*enum

seedContentTypenullable string

Type of content generated from AI

seedContentKeywordsnullable array of string

List of content keywords to use for generative AI

seedContentLocalesnullable array of string

List of locales to use for Person Seed Type

maxSeeds*number

seedLifespan*number

scheduleRatenullable string

nextScheduledRunnullable string (date-time)

destinationIdnullable string (uuid)

ID of target Integration used for the planting of seeds

failureMessagenullable string

muteNotifications*boolean

seedImpact*number

The impact of the seed on the target system

createdAtstring (date-time)

updatedAtstring (date-time)

createdByTypestring

createdByIdstring

updatedByTypenullable string

updatedByIdnullable string

Request

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

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "running",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedType": "email",
  "seedContentType": "text",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ],
  "maxSeeds": 0,
  "seedLifespan": 0,
  "scheduleRate": "text",
  "nextScheduledRun": "2024-12-21T11:36:13.562Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": false,
  "seedImpact": 0,
  "createdAt": "2024-12-21T11:36:13.562Z",
  "updatedAt": "2024-12-21T11:36:13.562Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

PreviousData widgets NextEvents

{ "id": "123e4567-e89b-12d3-a456-426614174000", "name": "text", "description": "text", "status": "running", "organisationId": "123e4567-e89b-12d3-a456-426614174000", "seedType": "email", "seedContentType": "text", "seedContentKeywords": [ "text" ], "seedContentLocales": [ "text" ], "maxSeeds": 0, "seedLifespan": 0, "scheduleRate": "text", "nextScheduledRun": "2024-12-21T11:36:13.562Z", "destinationId": "123e4567-e89b-12d3-a456-426614174000", "failureMessage": "text", "muteNotifications": false, "seedImpact": 0, "createdAt": "2024-12-21T11:36:13.562Z", "updatedAt": "2024-12-21T11:36:13.562Z", "createdByType": "text", "createdById": "text", "updatedByType": "text", "updatedById": "text" }

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

const response = await fetch('https://app.seedata.io/api/deployments', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "status": "running", "seedType": "email", "seedLifespan": 0, "maxSeeds": 0, "muteNotifications": false, "seedImpact": 0 }), }); const data = await response.json();