Endpoints - Create

Reference

Service:: Service Endpoint

API Version:: 5.1-preview.2

Create a service endpoint.

POST https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?api-version=5.1-preview.2

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '5.1-preview.2' to use this version of the api.

Request Body

Name	Type	Description
administratorsGroup	IdentityRef	Gets or sets the identity reference for the administrators group of the service endpoint.
authorization	EndpointAuthorization	Gets or sets the authorization data for talking to the endpoint.
createdBy	IdentityRef	Gets or sets the identity reference for the user who created the Service endpoint.
data	object
description	string	Gets or sets the description of endpoint.
groupScopeId	string	This is a deprecated field.
id	string	Gets or sets the identifier of this endpoint.
isReady	boolean	EndPoint state indicator
isShared	boolean	Indicates whether service endpoint is shared with other projects or not.
name	string	Gets or sets the friendly name of the endpoint.
operationStatus	JObject	Error message during creation/deletion of endpoint
owner	string	Owner of the endpoint Supported values are "library", "agentcloud"
readersGroup	IdentityRef	Gets or sets the identity reference for the readers group of the service endpoint.
type	string	Gets or sets the type of the endpoint.
url	string	Gets or sets the url of the endpoint.

Responses

Name	Type	Description
200 OK	ServiceEndpoint	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

Create a service endpoint

Sample request

HTTP

POST https://dev.azure.com/fabrikam/DefaultAgileGitProject/_apis/serviceendpoint/endpoints?api-version=5.1-preview.2

{
  "data": {
    "SubscriptionId": "12345678-1234-1234-1234-123456129012",
    "SubscriptionName": "TestSubscriptionName"
  },
  "id": "64be39c2-102b-416d-a3ac-2de40ebc8513",
  "name": "TestEndpoint",
  "type": "Azure",
  "authorization": {
    "parameters": {
      "Certificate": "dummyCertificate"
    },
    "scheme": "Certificate"
  },
  "isReady": false
}

Sample response

Status code:: 200

{
  "data": {
    "SubscriptionId": "12345678-1234-1234-1234-123456789012",
    "SubscriptionName": "TestSubscriptionName",
    "environment": "AzureCloud"
  },
  "id": "106a0c71-70fe-4d96-ba5c-5b6548708d15",
  "name": "TestEndpoint",
  "type": "Azure",
  "url": "https://testAcount.core.endpoint.net/",
  "createdBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "authorization": {
    "parameters": {
      "Certificate": null
    },
    "scheme": "Certificate"
  },
  "isReady": true
}

Definitions

Name	Description
EndpointAuthorization	Represents the authorization used for service endpoint.
IdentityRef
JObject	Represents a JSON object.
JToken	Represents an abstract JSON token.
ReferenceLinks	The class to represent a collection of REST reference links.
ServiceEndpoint	Represents an endpoint which may be used by an orchestration job.

EndpointAuthorization

Represents the authorization used for service endpoint.

Name	Type	Description
parameters	object	Gets or sets the parameters for the selected authorization scheme.
scheme	string	Gets or sets the scheme used for service endpoint authentication.

IdentityRef

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

JObject

Represents a JSON object.

Name	Type	Description
item	JToken	Represents an abstract JSON token.
type	string	Gets the node type for this JToken.

JToken

Represents an abstract JSON token.

Name	Type	Description
first	JToken	Get the first child token of this token.
hasValues	boolean	Gets a value indicating whether this token has child tokens.
item	JToken	Represents an abstract JSON token.
last	JToken	Get the last child token of this token.
next	JToken	Gets the next sibling token of this node.
parent	string	Gets or sets the parent.
path	string	Gets the path of the JSON token.
previous	JToken	Gets the previous sibling token of this node.
root	JToken	Gets the root JToken of this JToken.
type	string	Gets the node type for this JToken.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

ServiceEndpoint

Represents an endpoint which may be used by an orchestration job.

Name	Type	Description
administratorsGroup	IdentityRef	Gets or sets the identity reference for the administrators group of the service endpoint.
authorization	EndpointAuthorization	Gets or sets the authorization data for talking to the endpoint.
createdBy	IdentityRef	Gets or sets the identity reference for the user who created the Service endpoint.
data	object
description	string	Gets or sets the description of endpoint.
groupScopeId	string	This is a deprecated field.
id	string	Gets or sets the identifier of this endpoint.
isReady	boolean	EndPoint state indicator
isShared	boolean	Indicates whether service endpoint is shared with other projects or not.
name	string	Gets or sets the friendly name of the endpoint.
operationStatus	JObject	Error message during creation/deletion of endpoint
owner	string	Owner of the endpoint Supported values are "library", "agentcloud"
readersGroup	IdentityRef	Gets or sets the identity reference for the readers group of the service endpoint.
type	string	Gets or sets the type of the endpoint.
url	string	Gets or sets the url of the endpoint.

Share via