Endpoints - Share Service Endpoint

  • Reference
Service:
Service Endpoint
API Version:
7.1-preview.4

Share service endpoint across projects

PATCH https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId}?api-version=7.1-preview.4

URI Parameters

Name In Required Type Description
endpointId
 path True

string

uuid

Endpoint Id of the endpoint to share
organization
 path True

string

The name of the Azure DevOps organization.
api-version
 query True

string

Version of the API to use. This should be set to '7.1-preview.4' to use this version of the api.

Request Body

Name Type Description
body

ServiceEndpointProjectReference[]

Project reference details of the target project

Responses

Name Type Description
200 OK

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.serviceendpoint_manage Grants the ability to read, query and manage service endpoints.

Examples

Share service endpoint

Sample Request

PATCH https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId}?api-version=7.1-preview.4

[
  {
    "projectReference": {
      "id": "184fda7e-3559-4b3c-afa0-1b6998330f84",
      "name": "TestProject2"
    },
    "name": "MySharedServiceConnection"
  }
]

Sample Response

Status code:
204

Definitions

Name Description
ProjectReference
ServiceEndpointProjectReference

ProjectReference

Name Type Description
id

string

name

string

ServiceEndpointProjectReference

Name Type Description
description

string

Gets or sets description of the service endpoint.
name

string

Gets or sets name of the service endpoint.
projectReference

ProjectReference

Gets or sets project reference of the service endpoint.