Retire

Retire Seed

Set the seed status to retired

POSThttps://app.seedata.io/api/seeds/{seedId}/retire

Path parameters

seedId*string (uuid)

Body

application/json

retiredAtstring (date-time)

When the seed should be retired. Should be a UTC date in the future. If not input is provided it will default to UTC now. This operation will fail if the seed has already been retired.

Response

200

OK

Body

application/json

idstring (uuid)

typeenum

emaildocxdocx__financial_reportdocx__intelectual_property_reportdocx__strategic_plandocx__supplier_agreementxlsxpdfhtmlsvgdns_redirectaws_credentialshoneypot__printerhoneypot__linux_5honeypot__windows_10honeypot__windows_server_2016

contentTypenullable string

Type of content generated from AI

contentKeywordsnullable array of string

List of content keywords to use for generative AI

slugstring

Example: "yellow-jump-magic"

Pattern: ^[a-z]+-[a-z]+-[0-9]+$

domainstring (hostname)

descriptionnullable string

Generic freetext user entered description

plantedDescriptionnullable string

Human readable description of where this seed has been planted.

plantedLocationnullable string

Where the seed has been planted

plantedMethodIdnullable string

The Integration ID used by deployment to plant this seed

muteNotificationsUntilnullable string (date-time)

The date until which notifications for events related to this seed will be muted. The date has to be in the future, otherwise the operation will result in an error

statusenum

initialisingavailableplantedretired

lockedboolean

eventCountnullable number

seedImpactnumber

The impact of the seed on the target system

seedMetadatanullable object

Additional properties which are contextual to the seed type.

plantedAtnullable string (date-time)

plantedByTypenullable string

The type of entity that created the seed

plantedByIdnullable string (uuid)

The ID of entity that created the seed

retiredAtnullable string (date-time)

retiredByTypenullable string

The type of entity that created the seed

retiredByIdnullable string (uuid)

The ID of entity that created the seed

createdByTypestring

The type of entity that created the seed

createdByIdstring (uuid)

The ID of entity that created the seed

createdAtstring (date-time)

downloadedByTypenullable string

The type of entity that downloaded the seed

downloadedByIdnullable string (uuid)

The ID of entity that downloaded the seed

downloadedAtstring (date-time)

deploymentIdstring (uuid)

The ID of the deployment which planted the Seed

updatedAtstring (date-time)

externalIdentifierstring

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "email",
  "contentType": "text",
  "contentKeywords": [
    "text"
  ],
  "slug": "yellow-jump-magic",
  "domain": "example.com",
  "description": "text",
  "plantedDescription": "text",
  "plantedLocation": "text",
  "plantedMethodId": "text",
  "muteNotificationsUntil": "2024-12-21T12:02:10.038Z",
  "status": "initialising",
  "locked": false,
  "eventCount": 0,
  "seedImpact": 0,
  "seedMetadata": {
    "md5SeededFileHash": "text",
    "locale": "text",
    "title": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "password": "text",
    "dob": "text",
    "company": "text",
    "phoneDialCode": "text",
    "phone": "text",
    "address": "text",
    "addressLine1": "text",
    "addressCity": "text",
    "addressCountry": "text",
    "addressZipCode": "text"
  },
  "plantedAt": "2024-12-21T12:02:10.038Z",
  "plantedByType": "text",
  "plantedById": "123e4567-e89b-12d3-a456-426614174000",
  "retiredAt": "2024-12-21T12:02:10.038Z",
  "retiredByType": "text",
  "retiredById": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-12-21T12:02:10.038Z",
  "downloadedByType": "text",
  "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
  "downloadedAt": "2024-12-21T12:02:10.038Z",
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2024-12-21T12:02:10.038Z",
  "externalIdentifier": "text"
}