Update a specific Pipeline

PUT /pipelines/ID

Authorization Header

  • Bearer token: OAuth 2.0 API access token. 

Parameters

  • format : json or xml. This will override the Request Accept header.
  • human : true or false. Returns the response in a structured, more human-readable form, useful only when calling API through curl or browser.
  • show_null: true or false. If set to "true", the response will contain also keys that are not set to a value.
  • expand_all: true or false. Recursively look up referenced objects (here: user id) and embed the respective json as a nested object directly into the response.

Example 

PUT /pipelines/ID
curl -X PUT -H "Authorization: Bearer um9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j" -H "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" \
		} \
    } \
}' "https://api.xvid.com/v1/pipelines/54721f1ee4b09edbcfd16244?human=true"

Valid Fields:

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


  • No labels