core
POST /sources/{source_id}/collect

Run source collect (by creating a source collect job.)

Path parameters

  • source_id integer Required
application/json

Body

object | null object | null

Additional properties are allowed.

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • id integer | null
    • source integer Required
    • created_at string(date-time)
    • started_at string(date-time) | null
    • closed_at string(date-time) | null
    • status string

      Values are pending, running, finished, or failed.

    • state object

      Additional properties are allowed.

    • config object

      Additional properties are allowed.
  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
      • loc array[string | integer] Required
      • msg string Required
      • type string Required
POST /sources/{source_id}/collect 
curl \
 --request POST 'http://api.example.com/sources/{source_id}/collect' \
 --header "Content-Type: application/json"
Request examples 
{}
Response examples (200) 
{
  "id": 42,
  "source": 42,
  "created_at": "2025-05-04T09:42:00Z",
  "started_at": "2025-05-04T09:42:00Z",
  "closed_at": "2025-05-04T09:42:00Z",
  "status": "pending",
  "state": {},
  "config": {}
}
Response examples (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}