Create pipeline

POST

workspaces

{workspaceSlug}

pipelines

Create pipeline

curl --request POST \
  --url https://api.example.com/workspaces/{workspaceSlug}/pipelines/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "slug": "<string>",
  "definition": {
    "defaultScope": {
      "countries": [
        "<string>"
      ],
      "languages": [],
      "metadata": {
        "audience": [],
        "purpose": null,
        "tags": []
      }
    },
    "policySlugs": [
      "<string>"
    ]
  },
  "description": "<string>",
  "retention": {
    "auditLogs": {
      "mode": "forever"
    },
    "redactedDocuments": {
      "mode": "forever"
    }
  },
  "status": "draft"
}
'

import requests

url = "https://api.example.com/workspaces/{workspaceSlug}/pipelines/"

payload = {
    "displayName": "<string>",
    "slug": "<string>",
    "definition": {
        "defaultScope": {
            "countries": ["<string>"],
            "languages": [],
            "metadata": {
                "audience": [],
                "purpose": None,
                "tags": []
            }
        },
        "policySlugs": ["<string>"]
    },
    "description": "<string>",
    "retention": {
        "auditLogs": { "mode": "forever" },
        "redactedDocuments": { "mode": "forever" }
    },
    "status": "draft"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    slug: '<string>',
    definition: {
      defaultScope: {
        countries: ['<string>'],
        languages: [],
        metadata: {audience: [], purpose: null, tags: []}
      },
      policySlugs: ['<string>']
    },
    description: '<string>',
    retention: {auditLogs: {mode: 'forever'}, redactedDocuments: {mode: 'forever'}},
    status: 'draft'
  })
};

fetch('https://api.example.com/workspaces/{workspaceSlug}/pipelines/', 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://api.example.com/workspaces/{workspaceSlug}/pipelines/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'slug' => '<string>',
    'definition' => [
        'defaultScope' => [
                'countries' => [
                                '<string>'
                ],
                'languages' => [
                                
                ],
                'metadata' => [
                                'audience' => [
                                                                
                                ],
                                'purpose' => null,
                                'tags' => [
                                                                
                                ]
                ]
        ],
        'policySlugs' => [
                '<string>'
        ]
    ],
    'description' => '<string>',
    'retention' => [
        'auditLogs' => [
                'mode' => 'forever'
        ],
        'redactedDocuments' => [
                'mode' => 'forever'
        ]
    ],
    'status' => 'draft'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/workspaces/{workspaceSlug}/pipelines/"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"definition\": {\n    \"defaultScope\": {\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"languages\": [],\n      \"metadata\": {\n        \"audience\": [],\n        \"purpose\": null,\n        \"tags\": []\n      }\n    },\n    \"policySlugs\": [\n      \"<string>\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"retention\": {\n    \"auditLogs\": {\n      \"mode\": \"forever\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"forever\"\n    }\n  },\n  \"status\": \"draft\"\n}")

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

	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.post("https://api.example.com/workspaces/{workspaceSlug}/pipelines/")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"definition\": {\n    \"defaultScope\": {\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"languages\": [],\n      \"metadata\": {\n        \"audience\": [],\n        \"purpose\": null,\n        \"tags\": []\n      }\n    },\n    \"policySlugs\": [\n      \"<string>\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"retention\": {\n    \"auditLogs\": {\n      \"mode\": \"forever\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"forever\"\n    }\n  },\n  \"status\": \"draft\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/{workspaceSlug}/pipelines/")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"definition\": {\n    \"defaultScope\": {\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"languages\": [],\n      \"metadata\": {\n        \"audience\": [],\n        \"purpose\": null,\n        \"tags\": []\n      }\n    },\n    \"policySlugs\": [\n      \"<string>\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"retention\": {\n    \"auditLogs\": {\n      \"mode\": \"forever\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"forever\"\n    }\n  },\n  \"status\": \"draft\"\n}"

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

{
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "username": "<string>",
    "avatarUrl": "<string>",
    "displayName": "<string>"
  },
  "definition": {
    "defaultScope": {
      "countries": [
        "<string>"
      ],
      "languages": [],
      "metadata": {
        "audience": [],
        "purpose": null,
        "tags": []
      }
    },
    "policySlugs": [
      "<string>"
    ]
  },
  "displayName": "<string>",
  "slug": "<string>",
  "status": "draft",
  "updatedAt": "2023-11-07T05:31:56Z",
  "workspaceSlug": "<string>",
  "description": "<string>",
  "retention": {
    "auditLogs": {
      "mode": "forever"
    },
    "redactedDocuments": {
      "mode": "forever"
    }
  }
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

"<string>"

"<string>"

Path Parameters

workspaceSlug

string

required

URL-safe workspace identifier.

Body

application/json

Request payload for creating a new pipeline.

Creates a new pipeline with the specified name and optional description. The definition can be added later via update.

Request payload for creating a new pipeline.

Creates a new pipeline with the specified name and optional description. The definition can be added later via update.

displayName

string

required

Pipeline display name (2-128 characters).

Required string length: 2 - 128

slug

string

required

URL slug, unique within the workspace and immutable after creation.

Required string length: 3 - 32

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

definition

object

Optional detection + redaction configuration. Defaults to an empty definition that can be filled in via update.

Show child attributes

description

string

Optional description of the pipeline (max 500 characters).

Maximum string length: 500

retention

object

Optional per-scope data-retention override for this pipeline. Each unset scope inherits the workspace retention.

Show child attributes

status

Optional lifecycle status. Defaults to draft; pass enabled to create a pipeline ready to run without a follow-up update.

Allowed value: "draft"

Response

Pipeline response.

createdAt

string<date-time>

required

Timestamp when the pipeline was created.

createdBy

object

required

Account that created this pipeline.

Show child attributes

definition

object

required

Detection + redaction configuration.

Show child attributes

displayName

string

required

Pipeline display name.

slug

string

required

URL slug of the pipeline, unique within its workspace.

Required string length: 3 - 32

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

status

required

Pipeline lifecycle status.

Allowed value: "draft"

updatedAt

string<date-time>

required

Timestamp when the pipeline was last updated.

workspaceSlug

string

required

Handle of the workspace this pipeline belongs to.

Required string length: 3 - 32

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

description

string

Pipeline description.

retention

object

Per-scope data-retention override, when the pipeline sets one.

Show child attributes

Create pipeline

curl --request POST \
  --url https://api.example.com/workspaces/{workspaceSlug}/pipelines/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "slug": "<string>",
  "definition": {
    "defaultScope": {
      "countries": [
        "<string>"
      ],
      "languages": [],
      "metadata": {
        "audience": [],
        "purpose": null,
        "tags": []
      }
    },
    "policySlugs": [
      "<string>"
    ]
  },
  "description": "<string>",
  "retention": {
    "auditLogs": {
      "mode": "forever"
    },
    "redactedDocuments": {
      "mode": "forever"
    }
  },
  "status": "draft"
}
'

import requests

url = "https://api.example.com/workspaces/{workspaceSlug}/pipelines/"

payload = {
    "displayName": "<string>",
    "slug": "<string>",
    "definition": {
        "defaultScope": {
            "countries": ["<string>"],
            "languages": [],
            "metadata": {
                "audience": [],
                "purpose": None,
                "tags": []
            }
        },
        "policySlugs": ["<string>"]
    },
    "description": "<string>",
    "retention": {
        "auditLogs": { "mode": "forever" },
        "redactedDocuments": { "mode": "forever" }
    },
    "status": "draft"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    slug: '<string>',
    definition: {
      defaultScope: {
        countries: ['<string>'],
        languages: [],
        metadata: {audience: [], purpose: null, tags: []}
      },
      policySlugs: ['<string>']
    },
    description: '<string>',
    retention: {auditLogs: {mode: 'forever'}, redactedDocuments: {mode: 'forever'}},
    status: 'draft'
  })
};

fetch('https://api.example.com/workspaces/{workspaceSlug}/pipelines/', 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://api.example.com/workspaces/{workspaceSlug}/pipelines/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'slug' => '<string>',
    'definition' => [
        'defaultScope' => [
                'countries' => [
                                '<string>'
                ],
                'languages' => [
                                
                ],
                'metadata' => [
                                'audience' => [
                                                                
                                ],
                                'purpose' => null,
                                'tags' => [
                                                                
                                ]
                ]
        ],
        'policySlugs' => [
                '<string>'
        ]
    ],
    'description' => '<string>',
    'retention' => [
        'auditLogs' => [
                'mode' => 'forever'
        ],
        'redactedDocuments' => [
                'mode' => 'forever'
        ]
    ],
    'status' => 'draft'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/workspaces/{workspaceSlug}/pipelines/"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"definition\": {\n    \"defaultScope\": {\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"languages\": [],\n      \"metadata\": {\n        \"audience\": [],\n        \"purpose\": null,\n        \"tags\": []\n      }\n    },\n    \"policySlugs\": [\n      \"<string>\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"retention\": {\n    \"auditLogs\": {\n      \"mode\": \"forever\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"forever\"\n    }\n  },\n  \"status\": \"draft\"\n}")

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

	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.post("https://api.example.com/workspaces/{workspaceSlug}/pipelines/")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"definition\": {\n    \"defaultScope\": {\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"languages\": [],\n      \"metadata\": {\n        \"audience\": [],\n        \"purpose\": null,\n        \"tags\": []\n      }\n    },\n    \"policySlugs\": [\n      \"<string>\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"retention\": {\n    \"auditLogs\": {\n      \"mode\": \"forever\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"forever\"\n    }\n  },\n  \"status\": \"draft\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/{workspaceSlug}/pipelines/")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"definition\": {\n    \"defaultScope\": {\n      \"countries\": [\n        \"<string>\"\n      ],\n      \"languages\": [],\n      \"metadata\": {\n        \"audience\": [],\n        \"purpose\": null,\n        \"tags\": []\n      }\n    },\n    \"policySlugs\": [\n      \"<string>\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"retention\": {\n    \"auditLogs\": {\n      \"mode\": \"forever\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"forever\"\n    }\n  },\n  \"status\": \"draft\"\n}"

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

{
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "username": "<string>",
    "avatarUrl": "<string>",
    "displayName": "<string>"
  },
  "definition": {
    "defaultScope": {
      "countries": [
        "<string>"
      ],
      "languages": [],
      "metadata": {
        "audience": [],
        "purpose": null,
        "tags": []
      }
    },
    "policySlugs": [
      "<string>"
    ]
  },
  "displayName": "<string>",
  "slug": "<string>",
  "status": "draft",
  "updatedAt": "2023-11-07T05:31:56Z",
  "workspaceSlug": "<string>",
  "description": "<string>",
  "retention": {
    "auditLogs": {
      "mode": "forever"
    },
    "redactedDocuments": {
      "mode": "forever"
    }
  }
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

"<string>"

"<string>"

API Reference

Endpoints

Create pipeline

Path Parameters

Body

Response