POST
/
api
/
v1
/
runs
/
{id}
/
cancel
/
cURL
curl --request POST \
  --url https://api.nekt.ai/api/v1/runs/{id}/cancel/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration_seconds": 123,
  "status": "queued",
  "trigger": {
    "type": "<string>",
    "cron_expression": "<string>",
    "cron_timezone": "<string>",
    "event_rule": "<string>"
  },
  "full_sync": true,
  "extra_config": "<any>",
  "credit_charge_status": "unsuccessful",
  "triggered_by": 123,
  "triggered_by_token": "<string>",
  "source": "<string>",
  "destination": "<string>",
  "transformation": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this Pipeline run.

Body

Response

200 - application/json
​
id
string<uuid>
required
​
number
integer | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
started_at
string<date-time> | null
required
​
ended_at
string<date-time> | null
required
​
duration_seconds
integer | null
required
​
status
enum<string>
required
  • queued - QUEUED
  • running - RUNNING
  • success - SUCCESS
  • failed - FAILED
  • cancelling - CANCELLING
  • canceled - CANCELED
Available options:
queued,
running,
success,
failed,
cancelling,
canceled
​
trigger
object
required
​
full_sync
boolean | null
required
​
extra_config
any
required
​
credit_charge_status
required
  • unsuccessful - Unsuccessful
  • first_extraction - First extraction
  • charged - Charged
Available options:
unsuccessful,
first_extraction,
charged
​
triggered_by
integer
required

User that triggered the run (Expandable)

​
triggered_by_token
string
required

API token that triggered the run (Expandable)

​
source
string
required

Source of the run (Expandable)

​
destination
string
required

Destination of the run (Expandable)

​
transformation
string
required

Transformation of the run (Expandable)