Update By Name Using PUT 1

Update an Endpoint with the given project and name

Request

URI

PUT

http://cava-s-182-041.eng.vmware.com//codestream/api/endpoints/{project}/{name}

COPY

Path Parameters

string

name

Required

The name of the Endpoint

string

project

Required

The project the Endpoint belongs to

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

Request Body

EndpointSpec of type(s) application/json

Optional

{
    "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.

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

'Success' with the updated Endpoint

Returns Endpoint of type(s) application/json

{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "description": "string",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "isRestricted": false,
    "name": "My-Name",
    "project": "My-Project",
    "type": "jenkins",
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1"
}

integer As int64 As int64

_createTimeInMicros

Optional

This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds

string

_createdBy

Optional

This field is provided for backward compatibility. Contains the same value as the 'createdBy' field

string

_link

Optional

Partial URL that provides details of the resource.

integer As int64 As int64

_updateTimeInMicros

Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds

string

_updatedBy

Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field

string

createdAt

Optional

Date when the entity was created. The date is in ISO 8601 with time zone

string

createdBy

Optional

The user that created this entity

string

description

Required

A human-friendly description.

string

Optional

The id of this resource.

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

Optional

Endpoint specific properties.