Get Endpoints

Get Endpoints

The API returns paged list of endpoints.

Request
URI
GET
https://{api_host}/endpoint-configuration-service/api/endpoints
COPY
Query Parameters
string
category
Optional

DEPRECATED The category of the endpoints to be retrieved.

string
type
Optional

DEPRECATED The type of the endpoints to be retrieved.

boolean
secureFields
Optional

Whether to retrieve secure data.

integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response


Responses
200
[
    {
        "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"
                }
            ]
        }
    }
]

403

Unauthorized.

Operation doesn't return any data structure