Check Authorization And Alter Pipeline

Check Authorization And Alter Pipeline

Alter pipeline

Request
URI
PATCH
https://{api_host}/pipeline/api/pipelines/{id}
COPY
Path Parameters
string
id
Required

id

Responses
200

OK

Returns Pipeline of type(s) application/json 
{
    "name": "string",
    "kind": "string",
    "tags": [
        "string"
    ],
    "_link": "/pipeline/api/..",
    "_createdBy": "Test user",
    "_updatedBy": "Test user",
    "_updateTimeInMicros": 1499279153081002,
    "project": "Test Project",
    "description": "Demo Pipeline",
    "enabled": true,
    "concurrency": "10",
    "iteration": "string",
    "stageOrder": [
        "string"
    ],
    "notifications": {
        "email": [
            {
                "event": "string",
                "endpoint": "string",
                "stage": "string",
                "task": "string",
                "to": [
                    "string"
                ],
                "subject": "string",
                "body": "string"
            }
        ],
        "jira": [
            {
                "event": "string",
                "endpoint": "string",
                "stage": "string",
                "task": "string",
                "issuetype": "string",
                "project": "string",
                "summary": "string",
                "description": "string",
                "assignee": "string"
            }
        ],
        "webhook": [
            {
                "event": "string",
                "endpoint": "string",
                "stage": "string",
                "task": "string",
                "action": "string",
                "url": "string",
                "payload": "string",
                "agent": "string"
            }
        ]
    },
    "options": [
        "string"
    ],
    "ciWorkspace": {
        "image": "string",
        "path": "string",
        "endpoint": "string",
        "cache": [
            "string"
        ],
        "registry": "string",
        "limits": {
            "cpu": "number",
            "memory": 0
        }
    },
    "_warnings": [
        {
            "success": false,
            "classType": "string",
            "message": {
                "containerName": "string",
                "fieldName": "string",
                "level": "string",
                "message": "string"
            }
        }
    ],
    "_version": 0,
    "rollbacks": [
        {
            "stage": "string",
            "task": "string",
            "name": "string"
        }
    ]
}
string
name
Optional

name

string
kind
Optional

kind

array of string
tags
Optional

tags

string
_link
Optional

_link

string
_createdBy
Optional

_createdBy

string
_updatedBy
Optional

updatedBy

integer As int64 As int64
_updateTimeInMicros
Optional

_updateTimeInMicros

string
project
Optional

project

object
icon
Optional

icon

string
description
Optional

description

boolean
enabled
Optional

enabled flag

string
concurrency
Optional

Number of concurrent runs

string
iteration
Optional

iteration

object
input
Optional

input parameters

object
output
Optional

output parameters

object
starred
Optional

starred properties

array of string
stageOrder
Optional

stageOrder

object
stages
Optional

stages in pipeline

NotificationConfiguration
notifications
Optional

notifications

array of string
options
Optional

options

Possible values are : GIT_TRIGGER, GERRIT_TRIGGER, DOCKER_TRIGGER,
Workspace
ciWorkspace
Optional

ciWorkspace

object
_inputMeta
Optional

_inputMeta

object
_outputMeta
Optional

_outputMeta

array of ValidatorResponse
_warnings
Optional

_warnings

integer As int64 As int64
_version
Optional

_version

array of RollbackConfiguration
rollbacks
Optional

roll back configured


404

Not found

Operation doesn't return any data structure

500

Error

Operation doesn't return any data structure

On This Page
Pipeline Service Operations
POST
Action On Execution
PATCH
Check Authorization And Alter Pipeline
DELETE
Check Authorization And Delete Pipeline
POST
Check Authorization And Execute Pipeline
PUT
Check Authorization And Update Pipeline
POST
Create Pipeline
GET
List Execution
GET
List Executions
GET
List Pipeline
GET
List Pipelines
POST
Post Pipeline