Endpoints - Get Service Endpoints

Get the service endpoints.

GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?api-version=5.0-preview.2
GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?type={type}&authSchemes={authSchemes}&endpointIds={endpointIds}&includeFailed={includeFailed}&includeDetails={includeDetails}&api-version=5.0-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.0-preview.2' to use this version of the api.

authSchemes
query
  • string
array (string)

Authorization schemes used for service endpoints.

endpointIds
query
  • string
array (uuid)

Ids of the service endpoints.

includeDetails
query
  • boolean

Flag to include more details for service endpoints. This is for internal use only and the flag will be treated as false for all other requests

includeFailed
query
  • boolean

Failed flag for service endpoints.

type
query
  • string

Type of the service endpoints.

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 Grants the ability to read service endpoints.

Examples

Get service endpoints

Sample Request

GET https://dev.azure.com/fabrikam/DefaultAgileGitProject/_apis/serviceendpoint/endpoints?type=Azure&authSchemes=Certificate,None&api-version=5.0-preview.2

Sample Response

{
  "count": 1,
  "value": [
    {
      "data": {
        "SubscriptionId": "12345678-1234-1234-1234-123456789012",
        "SubscriptionName": "TestSubscriptionName",
        "environment": "AzureCloud"
      },
      "id": "4b16dc87-22a0-45f9-82d8-2e295c4597c6",
      "name": "TestEndpoint",
      "type": "Azure",
      "url": "https://management.core.windows.net/",
      "createdBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "authorization": {
        "scheme": "Certificate"
      },
      "isReady": true
    }
  ]
}

Definitions

EndpointAuthorization

Represents the authorization used for service endpoint.

IdentityRef
JObject
JToken
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

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
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
inactive
  • boolean
isAadIdentity
  • boolean
isContainer
  • boolean
isDeletedInOrigin
  • boolean
profileUrl
  • string
uniqueName
  • string
url
  • string

This url is the full route to the source resource of this graph subject.

JObject

Name Type Description
item
type
  • string

JToken

Name Type Description
first
hasValues
  • boolean
item
last
next
parent
  • string
path
  • string
previous
root
type
  • string

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

Gets or sets the identity reference for the administrators group of the service endpoint.

authorization

Gets or sets the authorization data for talking to the endpoint.

createdBy

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
id
  • string

Gets or sets the identifier of this endpoint.

isReady
  • boolean

EndPoint state indictor

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

Error message during creation/deletion of endpoint

owner
  • string

Owner of the endpoint Supported values are "library", "agentcloud"

readersGroup

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.