Deployments

List deployments

List deployments

get

/deployments

Query parameters

searchstring

statusstring

seedTypestring · enum

Options: email, docx, docx__financial_report, docx__intelectual_property_report, docx__strategic_plan, docx__supplier_agreement, xlsx, pdf, html, svg, dns_redirect, aws_credentials, honeypot__printer, honeypot__linux_5, honeypot__windows_10, honeypot__windows_server_2016

offsetinteger

Pagination offset

limitinteger · min: 1 · max: 100

Pagination limit

orderBystring

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/deployments'

200

200

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "organisationId": "123e4567-e89b-12d3-a456-426614174000",
      "seedContentType": "text",
      "maxSeeds": 1,
      "seedLifespan": 1,
      "scheduleRate": "text",
      "nextScheduledRun": "2025-02-27T04:47:43.230Z",
      "destinationId": "123e4567-e89b-12d3-a456-426614174000",
      "failureMessage": "text",
      "muteNotifications": true,
      "seedImpact": 1,
      "createdAt": "2025-02-27T04:47:43.230Z",
      "updatedAt": "2025-02-27T04:47:43.230Z",
      "createdByType": "text",
      "createdById": "text",
      "updatedByType": "text",
      "updatedById": "text",
      "status": "running",
      "seedType": "email",
      "seedContentKeywords": [
        "text"
      ],
      "seedContentLocales": [
        "text"
      ]
    }
  ]
}

OK

Create deployment

Endpoint used for creating a deployment schedule.

post

/deployments

Body

idstring · uuid

namestringrequired

descriptionstring | nullable

organisationIdstring · uuid

seedContentTypestring | nullable

Type of content generated from AI

maxSeedsnumberrequired

seedLifespannumberrequired

scheduleRatestring | nullable

nextScheduledRunstring · date-time | nullable

destinationIdstring · uuid | nullable

ID of target Integration used for the planting of seeds

failureMessagestring | nullable

muteNotificationsbooleanrequired

seedImpactnumber · min: 1 · max: 5required

The impact of the seed on the target system

createdAtstring · date-time

updatedAtstring · date-time

createdByTypestring

createdByIdstring

updatedByTypestring | nullable

updatedByIdstring | nullable

statusstring · enumrequired

Options: running, stopped, deleted, initialising, failed

seedTypestring · enumrequired

Options: email, docx, docx__financial_report, docx__intelectual_property_report, docx__strategic_plan, docx__supplier_agreement, xlsx, pdf, html, svg, dns_redirect, aws_credentials, honeypot__printer, honeypot__linux_5, honeypot__windows_10, honeypot__windows_server_2016

seedContentKeywordsstring[] | nullable

seedContentLocalesstring[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.seedata.io/api/deployments' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "organisationId": "123e4567-e89b-12d3-a456-426614174000",
    "seedContentType": "text",
    "maxSeeds": 1,
    "seedLifespan": 1,
    "scheduleRate": "text",
    "nextScheduledRun": "2025-02-27T04:47:43.230Z",
    "destinationId": "123e4567-e89b-12d3-a456-426614174000",
    "failureMessage": "text",
    "muteNotifications": true,
    "seedImpact": 1,
    "createdAt": "2025-02-27T04:47:43.230Z",
    "updatedAt": "2025-02-27T04:47:43.230Z",
    "createdByType": "text",
    "createdById": "text",
    "updatedByType": "text",
    "updatedById": "text",
    "status": "running",
    "seedType": "email",
    "seedContentKeywords": [
      "text"
    ],
    "seedContentLocales": [
      "text"
    ]
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedContentType": "text",
  "maxSeeds": 1,
  "seedLifespan": 1,
  "scheduleRate": "text",
  "nextScheduledRun": "2025-02-27T04:47:43.230Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-02-27T04:47:43.230Z",
  "updatedAt": "2025-02-27T04:47:43.230Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "status": "running",
  "seedType": "email",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ]
}

Created

Get deployment

Get a single deployment schedule

get

/deployments/{deployment_schedule_id}

Path parameters

deployment_schedule_idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.seedata.io/api/deployments/{deployment_schedule_id}'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedContentType": "text",
  "maxSeeds": 1,
  "seedLifespan": 1,
  "scheduleRate": "text",
  "nextScheduledRun": "2025-02-27T04:47:43.230Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-02-27T04:47:43.230Z",
  "updatedAt": "2025-02-27T04:47:43.230Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "status": "running",
  "seedType": "email",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ]
}

OK

Delete deployment

Delete a deployment schedule

delete

/deployments/{deployment_schedule_id}

Path parameters

deployment_schedule_idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.seedata.io/api/deployments/{deployment_schedule_id}'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedContentType": "text",
  "maxSeeds": 1,
  "seedLifespan": 1,
  "scheduleRate": "text",
  "nextScheduledRun": "2025-02-27T04:47:43.230Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-02-27T04:47:43.230Z",
  "updatedAt": "2025-02-27T04:47:43.230Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "status": "running",
  "seedType": "email",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ]
}

OK

Update deployment

patch

/deployments/{deployment_schedule_id}

Path parameters

deployment_schedule_idstring · uuidrequired

Body

statusstring

Deployment Status

muteNotificationsboolean

Mute notifications from this deployment

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app.seedata.io/api/deployments/{deployment_schedule_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "text",
    "muteNotifications": true
  }'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedContentType": "text",
  "maxSeeds": 1,
  "seedLifespan": 1,
  "scheduleRate": "text",
  "nextScheduledRun": "2025-02-27T04:47:43.230Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-02-27T04:47:43.230Z",
  "updatedAt": "2025-02-27T04:47:43.230Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text",
  "status": "running",
  "seedType": "email",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ]
}

OK