API Documentation

Appearance

PUT /pipelines/[ID] ​

Description ​

Update a specific pipeline. Fields not included in the request will not be updated. If you want to delete/reset a field, set it to "null" specifically.

Authentication ​

  • Required: Yes
  • Method: Bearer token

Request Headers ​

  • Authorization: Bearer [AUTH_TOKEN]
  • Accept:
    • application/json (for JSON responses)
    • application/xml (for XML responses)

Parameters ​

Query Parameters ​

  • format: string (Optional)
    Values: json, xml
    Overrides the Request Accept header.
  • human: boolean (Optional)
    Values: true, false
    Returns the response in a structured, more human-readable form.
  • show_null: boolean (Optional)
    Values: true, false
    If set to "true", the response will contain keys that are not set to a value.
  • expand_all: boolean (Optional)
    Values: true, false
    Recursively look up referenced objects and embed the respective JSON as nested objects directly into the response.

Body Parameters ​

Valid Fields ​

Same as for POST /pipelines. Fields not included in the request will not be updated. If you want to delete/reset a field, set it to "null" specifically.

Example Request ​

bash
curl -X PUT "https://api.xvid.com/v1/pipelines/54721f1ee4b09edbcfd16244?human=true" \
  -H "Authorization: Bearer AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline": {
      "name": "My new test Pipeline",
      "description": "My new test Pipeline with input from S3 and output to my company sftp account",
      "cancel_timeout": 0,
      "input_download_dir": "s3://AWSKEY:AWSSECRET@s3.amazonaws.com/my_bucket/",
      "image_download_dir": "https://username:password@mycompanyserver.com/my_logos/",
      "upload_options": {
        "s3_allow_read": "everyone",
        "s3_reduced_redundancy": true
      },
      "ping_urls": {
        "error": "https://mycompany.com/ping/on_error",
        "warning": "https://mycompany.com/ping/on_warning",
        "started": "https://mycompany.com/ping/start_job",
        "finished": "https://mycompany.com/ping/finish_job"
      }
    }
  }'

Example Response ​

Success (200 OK) ​

json
{
  "pipeline": {
    "id": "54721f1ee4b09edbcfd16244",
    "name": "My new test Pipeline",
    "description": "My new test Pipeline with input from S3 and output to my company sftp account",
    ...
  }
}

Error Responses ​

400 Bad Request ​

json
{
  "error": {
    "error_code": "0x0170001",
    "error_message": "Invalid Input"
  }
}

403 Forbidden ​

json
{
  "error": {
    "error_code": "0x0000003",
    "error_message": "Invalid access token"
  }
}

404 Not Found ​

json
{
  "error": {
    "error_code": "0x0170002",
    "error_message": "Pipeline does not exist"
  }
}

500 Internal Server Error ​

json
{
  "error": {
    "error_code": "0x0000001",
    "error_message": "Internal Error"
  }
}