Get information about a specific Pipeline


GET /pipelines/ID

Authorization Header

  • Bearer token: OAuth 2.0 API access token. 

Parameters

  • format : json or xml. This will override Request Accept header.
  • human : true or false. It causes the response to be in a structured, more human-readible form. This is useful when calling the API through curl or a 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 

GET /pipelines/ID
curl -H "Authorization: Bearer um9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j" "https://api.xvid.com/v1/pipelines/5475dc68e4b00d2b0f7a6100?human=true&show_null=true"
{
  "pipeline": {
    "name": "Default Pipeline",
    "description": "Default Pipeline",
    "default_object_timeout": null,
    "cancel_timeout": null,
    "input_download_dir": null,
    "image_download_dir": null,
    "download_options": {
      "https_certificate_check": null
    },
    "output_upload_dir": null,
    "image_upload_dir": null,
    "upload_options": {
      "s3_allow_read": null,
      "s3_reduced_redundancy": null
    },
    "store_options": {
      "mode": null
    },
    "ping_urls": {
      "error": null,
      "warning": null,
      "started": null,
      "finished": null
    },
    "file": {
      "id": "5475dc68e4b00d2b0f7a6102",
      "href": "https://api.xvid.com/v1/files/5475dc68e4b00d2b0f7a6102"
    },
    "version": 1,
    "user": {
      "id": "5475dc68e4b00d2b0f7a60fe",
      "href": "https://api.xvid.com/v1/users/5475dc68e4b00d2b0f7a60fe"
    },
    "created_at": 1417010280925,
    "updated_at": 1417010280925,
    "id": "5475dc68e4b00d2b0f7a6100",
    "href": "https://api.xvid.com/v1/pipelines/5475dc68e4b00d2b0f7a6100"
  }
}
  • No labels