Import

Run a scheduled mapper now

Trigger an immediate fetch-and-import of a scheduled (url) mapper, without waiting for its next scheduled occurrence and without altering the schedule. The run executes asynchronously through the exact same pipeline as a scheduled occurrence and shows up in the import history with source = scheduled; the response names its import job so it can be followed right away (GET /v1/imports/:importId). Two runs of the same mapper never overlap: while one is still importing the endpoint answers 409 (IMPORT_RUN_IN_PROGRESS).

post/v1/import/mappers/{id}/run

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/import/mappers/{id}/run
  • Auth: API key in header X-Api-Key

Path parameters

idstring uuid required

The unique identifier of the scheduled mapper to run

Response

Run enqueued

importIdstring required

Identifier of the import job carrying the run, as exposed by GET /v1/imports — follow its progress there (data.source = scheduled).

Example response

{
  "importId": "import:550e8400-e29b-41d4-a716-446655440000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.