Get Endpoint By Id

Get Endpoint By Id

The API returns a specific endpoint, based on the endpoint id.

Request
URI
GET
https://{api_host}/endpoint-configuration-service/api/endpoints/{id}
COPY
Path Parameters
string
id
Required

The id of the endpoint to be retrieved.

Query Parameters
boolean
secureFields
Optional

Whether to return secure fields such as password or encrypted custom properties.


Responses
200
Returns Endpoint of type(s) */*
{
    "associations": [
        {
            "lastUpdated": "string",
            "createdDate": "string",
            "customProperties": "string",
            "fromEndpointType": "string",
            "associationTypeInfoId": "string",
            "id": "string",
            "toEndpointId": "string",
            "toEndpointType": "string",
            "version": 0,
            "fromEndpointId": "string"
        }
    ],
    "lastUpdated": "string",
    "createdDate": "string",
    "name": "string",
    "tenantId": "string",
    "description": "string",
    "typeId": "string",
    "id": "string",
    "typeDisplayName": "string",
    "version": 0,
    "uri": "string",
    "extensionData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    }
}
associations
Optional

associations

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
createdDate
Optional

createdDate

string
name
Optional

name

string
tenantId
Optional

tenantId

string
description
Optional

description

string
typeId
Optional

typeId

string As uuid As uuid
id
Optional

id

string
typeDisplayName
Optional

typeDisplayName

integer As int64 As int64
version
Optional

version

string
uri
Optional

uri

extensionData
Required

extensionData


400

Bad request.

Operation doesn't return any data structure

403

Unauthorized.

Operation doesn't return any data structure

404

Endpoint with the specified id does not exist.

Operation doesn't return any data structure