Skip to main content
PATCH
/
pipeline-runs
/
{id}
/
status
Acknowledge a pipeline run
curl --request PATCH \
  --url https://api.sftpsync.io/pipeline-runs/{id}/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "acknowledged"
}
'
{
  "id": "<string>",
  "filename": "<string>",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "clientId": "<string>",
  "workspaceId": "<string>",
  "path": "<string>",
  "size": 123,
  "mimetype": "<string>",
  "metadata": {},
  "errorMessage": "<string>",
  "processedAt": "2023-11-07T05:31:56Z",
  "schemaId": "<string>",
  "pipelineId": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Body

application/json
status
enum<string>
required
Available options:
acknowledged

Response

200 - application/json

Updated pipeline run

id
string
required
filename
string
required
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
acknowledged
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
clientId
string
required
workspaceId
string
required
path
string
size
integer
mimetype
string
metadata
object
errorMessage
string
processedAt
string<date-time>
schemaId
string
pipelineId
string