Jump to

• Request
• Response
• Examples

Refresh internal tasks

post

/rest/{version}/admin/refresh/{task}

Refreshes either the Fraud Protection Engine (FPE) with the recently uploaded FPE file or the Local Routing Table (LRT) with the recently uploaded LRT file.

For more information, see Telephony Fraud Protection or Using the Local Route Table (LRT) for Routing in the ACLI Configuration Guide.

This API is only available for SBC and ESBC.

Request

Path Parameters

• task:
  Specifies the internal task to execute a refresh on.
• version:
  REST API version string.
  Available values: v1.2

Query Parameters

• filename:
  File name to use for refresh action

Header Parameters

• Authorization:
  The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

Back to Top

Response

204 Response

Successful refresh of the internal task data. There is no response body for a successful refresh.

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

403 Response

This request requires the client credentials to have administrator privileges.

404 Response

Unsupported versionId in URI.

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to refresh internal tasks by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.1/admin/refresh/fpe"

Note:

The value of '{task}' must be either 'all', 'fpe', or 'lrt'.

Example of Accessing the API with Python

The following example shows how to refresh internal tasks by submitting a POST request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.1/admin/refresh/fpe"
resp = requests.post(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 204
Server: nginx/1.14.1
Date: Wed, 01 Apr 2020 11:08:53 GMT
Content-Type: application/xml
Transfer-Encoding: chunked
Connection: keep-alive

Example of the Response Body

This endpoint does not return a response body.

Back to Top