Enable or Disable a Shared Pipeline Artifact Version

Enables or disables a specific version of a shared pipeline artifact. The sharedPipelineIdPrefix identifies the shared pipeline group.

PATCH /v1/shared-pipelines/artifacts

Enable or Disable a Shared Pipeline Artifact Version

cURL

curl --request PATCH \
  --url https://eu1.api.matillion.com/dpc/v1/shared-pipelines/artifacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "sharedPipelineIdPrefix": "my-shared-pipeline",
  "versionName": "1.0.0"
}
'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/shared-pipelines/artifacts"

payload = {
    "enabled": True,
    "sharedPipelineIdPrefix": "my-shared-pipeline",
    "versionName": "1.0.0"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    sharedPipelineIdPrefix: 'my-shared-pipeline',
    versionName: '1.0.0'
  })
};

fetch('https://eu1.api.matillion.com/dpc/v1/shared-pipelines/artifacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu1.api.matillion.com/dpc/v1/shared-pipelines/artifacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'sharedPipelineIdPrefix' => 'my-shared-pipeline',
    'versionName' => '1.0.0'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu1.api.matillion.com/dpc/v1/shared-pipelines/artifacts"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"sharedPipelineIdPrefix\": \"my-shared-pipeline\",\n  \"versionName\": \"1.0.0\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://eu1.api.matillion.com/dpc/v1/shared-pipelines/artifacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"sharedPipelineIdPrefix\": \"my-shared-pipeline\",\n  \"versionName\": \"1.0.0\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/shared-pipelines/artifacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"sharedPipelineIdPrefix\": \"my-shared-pipeline\",\n  \"versionName\": \"1.0.0\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "enabled": true,
  "versionName": "1.0.0"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

a valid bearer token

Body

application/json

enabled · boolean · required

Whether this version of the shared pipeline is enabled

Example:

true

sharedPipelineIdPrefix · string · required

The prefix identifier grouping related shared pipelines

Minimum string length: 1

Example:

"my-shared-pipeline"

versionName · string · required

The version name of the shared pipeline artifact

Required string length: 1 - 255

Example:

"1.0.0"

Response

200

application/json

Shared pipeline artifact version updated successfully

enabled · boolean

Whether this version of the shared pipeline is enabled

Example:

true

versionName · string

The version name of the shared pipeline artifact

Example:

"1.0.0"