Skip to main content
POST
/
facts
/
collect
Trigger on-demand fact collection
curl --request POST \
  --url https://backstage.example.com/api/soundcheck/facts/collect \
  --header 'Content-Type: application/json' \
  --data '
{
  "collectorIds": [
    "<string>"
  ],
  "entityRefs": [
    "<string>"
  ],
  "factRefs": [
    "<string>"
  ]
}
'
{
  "queued": [
    {
      "collectorId": "<string>",
      "entityRefs": [
        "<string>"
      ],
      "jobsQueued": 123
    }
  ],
  "skipped": [
    {
      "collectorId": "<string>",
      "reason": "<string>"
    }
  ]
}

Body

application/json
​
collectorIds
string[]
required

IDs of registered fact collectors to trigger.

Minimum array length: 1
​
entityRefs
string[]
required

Entity references to collect facts for (e.g. "component:default/my-service").

Minimum array length: 1
​
factRefs
string[]

Optional filter to collect only specific facts. If omitted, all facts from the collector are collected.

Response

Collection jobs accepted and queued

​
queued
object[]
required
​
skipped
object[]
required