Get the Details for Export Endpoints

Use the get details for export endpoints request to get a list of export endpoints along with their details.

Endpoint

Method: POST

URL: /policy/endpoint/details

Request Parameter

There is a request body but there is no need to input data into this request, for an example request, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK

Response Parameter

Parameter Name	Data Type	Description
`endpointDetails`	Array	A list of export endpoints configured in the system consisting of the following parameters.
`id`	Integer	The automatically generated ID for the export endpoint.
`endpoint`	Array	Basic details for the export endpoint, consisting of `name`, `exportChannel`, and `description`.
`name`	String	The friendly name for the export endpoint.
`exportChannel`	Array	Details on the export channel used for the export endpoint, consisting of `exportChannelId` (an ID of the export channel), and `channelName` (the type of export channel).
`description`	String	A useful description of the endpoint.
`uri`	String	The address of the Webhook or Socket export endpoint uses to export to.
`uriAuthHeader`	String	The authorization header to use during export.
`requestTimeout`	String	The number of seconds allowed for exporting content, after which the export will fail. This is only taken into account after an initial export fails. Defaults to 100 seconds if not set.
`certificateHash`	String	The hash to the certificate which allows exports to this endpoint.
`bearerTokenAuthorization` or `credentialsGrantAuthorization` or `noAuthorization`	Array	The details used to obtain an access token for exporting to the endpoint, either by bearer token or credentials grant. If no authorization is needed for the endpoint then `noAuthorization` will be displayed. If `bearerTokenAuthorization` is used, the array consists of the following parameters: `token` - The token used to obtain an access token for export. `authorizationEndpoint` - The address or IP of the Authorization Endpoint used to obtain an access token for export. `clientId` - The client ID used to obtain an access token for export. If `credentialsGrantAuthorization` is used, the array consists of the following parameters: `clientId` - The client ID used to obtain access to the export location. `clientSecret` - The client secret used to obtain access to the export location. `scope` - The scope used to obtain access to the export location. `authorizationEndpoint` - The address or IP of the Authorization Endpoint used to obtain access to the export location.

For an example response, see Sample Response.

Sample Request

{
    "endpointDetailsIds": []
}

Sample Response

{
    "endpointDetails": [
        {
            "id": "46",
            "endpoint": {
                "name": "WebhookZaff",
                "exportChannel": {
                    "exportChannelId": "1",
                    "channelName": "Webhook"
                }
            },
            "uri": "wss://example.us.cloud.domain.com/realtime/testingteam",
            "bearerTokenAuthorization": {
                "token": "67jh458k-ljp2-87d9-56tl-3th7s76a689k",
                "authorizationEndpoint": "/zaff",
                "clientId": "abcd-1234"
            }
        },
        {
            "id": "1317",
            "endpoint": {
                "name": "RealTime Stream",
                "exportChannel": {
                    "exportChannelId": "3",
                    "channelName": "Socket"
                },
                "description": "QA team"
            },
            "uri": "https://example.us.cloud.domain.com/test-server/",
            "noAuthorization": {}
        }
    ]
}

In this section:

Uniphore Customer Portal