EndpointSpec

EndpointSpec
EndpointSpec

An Endpoint is an instance of a DevOps application that connects to Code Stream to provide data for your Pipelines to run, such as a data source, repository, or notification system. Endpoints can be cloud-based or on-premises.

JSON Example 
{
    "description": "string",
    "isRestricted": false,
    "name": "My-Name",
    "project": "My-Project",
    "type": "jenkins"
}
string
description
Required

A human-friendly description.

boolean
isRestricted
Optional

This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

string
project
Optional

The project this entity belongs to.

object
properties
Required

Endpoint specific properties

string
type
Required

The type of this Endpoint instance.

Parameter To