---
title: Create Pipeline
slug: tp-api/create-pipeline
docTags: 
createdAt: 2023-12-26T14:37:58.070Z
---

{
  "id": "k2zA4sOPjdPrWmBBU4IRl",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "{{url}}/api/portal/external/pipeline",
    "servers": [
      {
        "url": "{{url}}/api/portal/external/pipeline",
        "description": "Development environment"
      }
    ],
    "name": "Create Pipeline",
    "description": "The function of this API is to create a new pipeline within the system.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "customType": "PipelineDTO",
          "schema": [
            {
              "name": "id",
              "kind": "optional",
              "type": "string",
              "example": ""
            },
            {
              "name": "name",
              "kind": "optional",
              "type": "string",
              "example": ""
            },
            {
              "name": "sources",
              "kind": "optional",
              "type": "array",
              "modelRef": "#/components/schemas/ComponentDTO",
              "customType": "ComponentDTO[]",
              "schema": [
                {
                  "name": "id",
                  "kind": "optional",
                  "type": "string",
                  "example": ""
                },
                {
                  "name": "name",
                  "kind": "optional",
                  "type": "string",
                  "example": ""
                },
                {
                  "name": "componentType",
                  "kind": "optional",
                  "type": "object",
                  "modelRef": "#/components/schemas/ComponentTypeDTO",
                  "customType": "ComponentTypeDTO",
                  "schema": [
                    {
                      "name": "categoryName",
                      "kind": "optional",
                      "type": "string",
                      "example": ""
                    },
                    {
                      "name": "vendorName",
                      "kind": "optional",
                      "type": "string",
                      "example": ""
                    },
                    {
                      "name": "elementTypeId",
                      "kind": "optional",
                      "type": "string",
                      "example": ""
                    },
                    {
                      "name": "elementTypeName",
                      "kind": "optional",
                      "type": "string",
                      "example": ""
                    },
                    {
                      "name": "properties",
                      "kind": "optional",
                      "type": "object",
                      "example": "",
                      "schema": [
                        {
                          "name": "empty",
                          "kind": "optional",
                          "type": "boolean",
                          "example": ""
                        }
                      ]
                    },
                    {
                      "name": "totalCount",
                      "kind": "optional",
                      "type": "integer<int32>",
                      "example": 0
                    },
                    {
                      "name": "activeCount",
                      "kind": "optional",
                      "type": "integer<int32>",
                      "example": 0
                    }
                  ]
                },
                {
                  "name": "isActive",
                  "kind": "optional",
                  "type": "boolean",
                  "example": ""
                },
                {
                  "name": "properties",
                  "kind": "optional",
                  "type": "object",
                  "example": "",
                  "schema": []
                },
                {
                  "name": "active",
                  "kind": "optional",
                  "type": "boolean",
                  "example": ""
                }
              ]
            },
            {
              "name": "docks",
              "kind": "optional",
              "type": "array",
              "modelRef": "#/components/schemas/ComponentDTO",
              "customType": "ComponentDTO[]",
              "schema": [
                {
                  "name": "id",
                  "kind": "optional",
                  "type": "string",
                  "example": ""
                },
                {
                  "name": "name",
                  "kind": "optional",
                  "type": "string",
                  "example": ""
                },
                {
                  "name": "componentType",
                  "kind": "optional",
                  "type": "object",
                  "modelRef": "#/components/schemas/ComponentTypeDTO",
                  "customType": "ComponentTypeDTO",
                  "schema": [
                    {
                      "name": "categoryName",
                      "kind": "optional",
                      "type": "string",
                      "example": ""
                    },
                    {
                      "name": "vendorName",
                      "kind": "optional",
                      "type": "string",
                      "example": ""
                    },
                    {
                      "name": "elementTypeId",
                      "kind": "optional",
                      "type": "string",
                      "example": ""
                    },
                    {
                      "name": "elementTypeName",
                      "kind": "optional",
                      "type": "string",
                      "example": ""
                    },
                    {
                      "name": "properties",
                      "kind": "optional",
                      "type": "object",
                      "example": "",
                      "schema": [
                        {
                          "name": "empty",
                          "kind": "optional",
                          "type": "boolean",
                          "example": ""
                        }
                      ]
                    },
                    {
                      "name": "totalCount",
                      "kind": "optional",
                      "type": "integer<int32>",
                      "example": 0
                    },
                    {
                      "name": "activeCount",
                      "kind": "optional",
                      "type": "integer<int32>",
                      "example": 0
                    }
                  ]
                },
                {
                  "name": "isActive",
                  "kind": "optional",
                  "type": "boolean",
                  "example": ""
                },
                {
                  "name": "properties",
                  "kind": "optional",
                  "type": "object",
                  "example": "",
                  "schema": []
                },
                {
                  "name": "active",
                  "kind": "optional",
                  "type": "boolean",
                  "example": ""
                }
              ]
            },
            {
              "name": "transforms",
              "kind": "optional",
              "type": "array",
              "modelRef": "#/components/schemas/TransformDTO",
              "customType": "TransformDTO[]",
              "schema": [
                {
                  "name": "dbId",
                  "kind": "optional",
                  "type": "string<uuid>",
                  "example": ""
                },
                {
                  "name": "transformId",
                  "kind": "optional",
                  "type": "string",
                  "example": ""
                },
                {
                  "name": "transformTypeId",
                  "kind": "optional",
                  "type": "string",
                  "example": ""
                },
                {
                  "name": "properties",
                  "kind": "optional",
                  "type": "object",
                  "example": "",
                  "schema": []
                },
                {
                  "name": "allProperties",
                  "kind": "optional",
                  "type": "object",
                  "example": "",
                  "schema": []
                }
              ]
            },
            {
              "name": "inputLinks",
              "kind": "optional",
              "type": "object",
              "example": "",
              "schema": []
            },
            {
              "name": "properties",
              "kind": "optional",
              "type": "object",
              "example": "",
              "schema": []
            }
          ],
          "modelRef": "#/components/schemas/PipelineDTO",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "cookieAuth",
          "name": "SESSION",
          "kind": "optional",
          "type": "apiKey",
          "in": "cookie"
        },
        {
          "id": "tokenAuth",
          "name": "X-XSRF-TOKEN",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "zfn3FAV41rPALlu0G_C7s",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url {{url}}/api/portal/external/pipeline \\\n     --header 'accept: application/json'"
        },
        {
          "id": "qK65O8WiqUNb-Woh30dQK",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"{{url}}/api/portal/external/pipeline\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "F70nU4MtZ_BZjDpJ4ztLK",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"{{url}}/api/portal/external/pipeline\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "evmNFfyMTWXAO8XhngmiR",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"{{url}}/api/portal/external/pipeline\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "zfn3FAV41rPALlu0G_C7s"
    },
    "results": {
      "languages": [
        {
          "id": "GJQ-zgdCv80ND2Zsi0KlS",
          "language": "200",
          "code": "// OK\n"
        }
      ],
      "selectedLanguageId": "GJQ-zgdCv80ND2Zsi0KlS"
    }
  },
  "children": [
    {
      "id": "0s86rc_DY23l-DWr21now",
      "type": "paragraph",
      "children": [
        {
          "text": "The function of this API is to create a new pipeline within the system.",
          "id": "cGNPYrlRVU3rbhhBHG09y"
        }
      ]
    }
  ]
}