CDN and DNS (v2.1)

Update Pipeline

Updates an existing Pipeline object in the specified workspace with the provided configuration.

put/delivery/v2.1/global/workspaces/{workspaceUUID}/pipelines/{resourceId}

Path parameters

resourceIdstring required

Resource ID

workspaceUUIDstring required

UUID of the workspace

Request body

apiVersion'delivery/v2' | 'delivery/v2.1' required

Version identifier of the API schema

kind'Pipeline' required

The string value 'Pipeline' that identifies the schema

Example request

{
  "apiVersion": "delivery/v2",
  "kind": "Pipeline",
  "metadata": {
    "uid": "00000000-0000-0000-0000-000000000000"
  },
  "spec": {
    "outputs": [
      {
        "presetSpec": {
          "audio": {
            "bitrate": "128k",
            "codec": "aac"
          },
          "container": "mp4",
          "speed": "medium",
          "video": {
            "bitrate": "1000k",
            "bufferSize": "2M",
            "codec": "h264",
            "maxBitrate": "2M",
            "minBitrate": "500k",
            "resizeType": "autoHeight"
          }
        }
      }
    ],
    "thumbs": {
      "format": "jpg"
    },
    "watermarks": [
      {
        "input": {
          "http": {
            "url": "https://example.com/video.mp4"
          },
          "protocol": "s3",
          "s3": {
            "endpoint": {
              "accessKey": "your-access-key",
              "address": "s3.amazonaws.com",
              "secretKey": "your-secret-key"
            }
          }
        }
      }
    ]
  }
}

Response

The pipeline was successfully updated. The response contains the complete pipeline details including the assigned unique identifier.

apiVersion'delivery/v2' | 'delivery/v2.1' required

Version identifier of the API schema

kind'Pipeline' required

The string value 'Pipeline' that identifies the schema

Example response

{
  "apiVersion": "delivery/v2",
  "kind": "Pipeline",
  "metadata": {
    "uid": "00000000-0000-0000-0000-000000000000"
  },
  "spec": {
    "outputs": [
      {
        "presetSpec": {
          "audio": {
            "bitrate": "128k",
            "codec": "aac"
          },
          "container": "mp4",
          "speed": "medium",
          "video": {
            "bitrate": "1000k",
            "bufferSize": "2M",
            "codec": "h264",
            "maxBitrate": "2M",
            "minBitrate": "500k",
            "resizeType": "autoHeight"
          }
        }
      }
    ],
    "thumbs": {
      "format": "jpg"
    },
    "watermarks": [
      {
        "input": {
          "http": {
            "url": "https://example.com/video.mp4"
          },
          "protocol": "s3",
          "s3": {
            "endpoint": {
              "accessKey": "your-access-key",
              "address": "s3.amazonaws.com",
              "secretKey": "your-secret-key"
            }
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.