v1

latestOpenAPI 3.0.02026-07-17166300328.1 KB
Collections

Edit a collection

post/collections/edit/{collectionId}

Path parameters

string required
OR
string uuid required
Example:12345

UUID or numeric ID of the collection

Request body

type'campaign' | 'intrusion_set' | 'named_threat' | 'other' | 'research'
namestring
descriptionstring
distribution'0' | '1' | '2' | '3' | '4' | '5'

Who will be able to see this event once it becomes published and eventually when it becomes pulled:

  • 0 - Your organization only
  • 1 - This community only
  • 2 - Connected communities
  • 3 - All communities
  • 4 - Sharing group
  • 5 - Inherit Event

Example request

{
  "name": "APT Campaign Collection",
  "description": "This is a dummy description, for a collection about Aiur.",
  "distribution": "4",
  "sharing_group_id": "1"
}

Response

A collection

Example response

{
  "Collection": {
    "id": "12345",
    "org_id": "12345",
    "orgc_id": "12345",
    "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
    "created": "2024-03-19 11:10:24",
    "modified": "2024-03-19 11:10:24",
    "user_id": "12345",
    "name": "APT Campaign Collection",
    "description": "This is a dummy description, for a collection about Aiur.",
    "distribution": "4",
    "sharing_group_id": "1"
  }
}