seedata.io DOCS
  • Welcome
  • Getting Started
    • What is seedata.io?
    • Core Concepts
    • Quick Start
    • Get Help
    • Subscriptions
  • Features
    • Dashboard
    • Alerts
    • Integrations
      • AWS
      • Webhook
    • Deployments
    • Seeds
      • Email
      • URL
      • Person
      • Microsoft Document (XLSX, DOCX)
      • PDF Document
      • HTML Page
      • SVG Image
      • AWS Credential
      • Virtual Machine Honeypot
      • EC2 Honeypot
    • Events
    • Intel
    • Settings
      • Whitelists
      • Users & Tokens
      • Profiles
  • Tutorials
    • Managing your alerts
      • Webhook
      • Webforms
      • Teams
      • Syslog
      • Slack
      • ServiceNow
      • Jira
      • Email
      • Elasticsearch
      • Datadog
    • Registering for a new account
    • Planting a VM honeypot seed
    • Preparing a VM Honeypot host
    • Planting an EC2 honeypot seed
    • Planting AWS Serverless Seeds
  • API reference
    • Activities
    • Api tokens
    • Copilot
      • Assessment
    • Data widgets
    • Deployments
    • Events
      • Next
      • Previous
      • Alert
      • Journal
    • Integrations
    • Intel
    • Notification recipients
      • Test
    • Seeds
      • Bulk
      • Retire
      • Test
      • Next
      • Previous
    • Stats
    • Whitelisted sources
Powered by GitBook
On this page

Was this helpful?

  1. API reference

Integrations

PreviousJournalNextIntel

Last updated 1 month ago

Was this helpful?

Get integration

get

Get the integration for the organisation

Path parameters
integrationIdstring · uuidRequired
Responses
200
OK
application/json
get
GET /api/integrations/{integrationId} HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "integrated_server",
  "integrationToken": "text",
  "settings": {
    "status": "active",
    "subtype": "linux"
  },
  "createdByType": "text",
  "createdById": "text",
  "createdAt": "2025-05-12T21:34:31.895Z",
  "updatedAt": "2025-05-12T21:34:31.895Z"
}

Delete integration

delete

Delete the integration for the organisation

Path parameters
integrationIdstring · uuidRequired
Responses
204
No Content
delete
DELETE /api/integrations/{integrationId} HTTP/1.1
Host: app.seedata.io
Accept: */*
204

No Content

No content

  • GETList Integrations
  • POSTCreate Integration
  • GETGet integration
  • DELETEDelete integration
  • PATCHUpdate integration

List Integrations

get

List of integrations

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
200
OK
application/json
get
GET /api/integrations 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": "integrated_server",
      "integrationToken": "text",
      "settings": {
        "status": "active",
        "subtype": "linux"
      },
      "createdByType": "text",
      "createdById": "text",
      "createdAt": "2025-05-12T21:34:31.895Z",
      "updatedAt": "2025-05-12T21:34:31.895Z"
    }
  ]
}

Create Integration

post

Create a new integration

Body
one ofOptional
or
Responses
201
Created
application/json
post
POST /api/integrations HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "name": "text",
  "description": "text",
  "type": "web_form",
  "seedType": "email",
  "url": "text",
  "headers": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "fieldMappings": [
    {
      "from": "text",
      "to": "text",
      "length": 1
    }
  ]
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "integrated_server",
  "integrationToken": "text",
  "settings": {
    "status": "active",
    "subtype": "linux"
  },
  "createdByType": "text",
  "createdById": "text",
  "createdAt": "2025-05-12T21:34:31.895Z",
  "updatedAt": "2025-05-12T21:34:31.895Z"
}

Update integration

patch

Update the integration for the organisation

Path parameters
integrationIdstring · uuidRequired
Body
one ofOptional
or
Responses
200
OK
application/json
patch
PATCH /api/integrations/{integrationId} HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "name": "text",
  "description": "text",
  "type": "web_form",
  "seedType": "email",
  "url": "text",
  "headers": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "fieldMappings": [
    {
      "from": "text",
      "to": "text",
      "length": 1
    }
  ]
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "integrated_server",
  "integrationToken": "text",
  "settings": {
    "status": "active",
    "subtype": "linux"
  },
  "createdByType": "text",
  "createdById": "text",
  "createdAt": "2025-05-12T21:34:31.895Z",
  "updatedAt": "2025-05-12T21:34:31.895Z"
}