v1

latestOpenAPI 3.0.02026-07-17508972.4 KB
Broods

Get broods list

get/broods/index

Query parameters

quickFilterstring
Example:user@example.com

Quick filter used to match multiple attributes such as name, description, emails, etc.

Response

Brood list response

idinteger
uuidstring uuid
namestring
urlstring
descriptionstring
organisation_idinteger
trustedboolean

Trusted upstream source

pullboolean

Enable pulling of trust information

skip_proxyboolean
authkeystring
createdstring datetime
modifiedstring datetime

Example response

[
  {
    "id": 1,
    "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
    "organisation_id": 1,
    "organisation": {
      "id": 1,
      "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
      "created": "2022-01-05T11:19:26+00:00",
      "modified": "2022-01-05T11:19:26+00:00",
      "tags": [
        {
          "id": 1,
          "name": "white",
          "namespace": "tlp",
          "colour": "FFFFFF",
          "text_colour": "white",
          "created": "2022-01-05T11:19:26+00:00",
          "modified": "2022-01-05T11:19:26+00:00"
        }
      ]
    },
    "created": "2022-01-05T11:19:26+00:00",
    "modified": "2022-01-05T11:19:26+00:00"
  }
]