1. REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 8.4.0
  2. Tasks
  3. configuration

Unlock the configuration

post

/rest/{version}/configuration/unlock

Releases the configuration lock previously acquired by the client via /configuration/lock POST. If the client does not own the configuration lock and attempts to release it, 423 Locked is returned.

While it exists, the configuration lock is tied to a token. If a REST client loses the token, the client will have to wait until the token expires before requesting the configuration lock.

Request

Path Parameters
  • REST API version string.
    Available values: v1.2
Header Parameters
  • 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

Client has successfully released the configuration lock.

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.

423 Response

The request requires the configuration lock and failed because the client does not currently own the lock. If another client or user currently owns the configuration lock, the error message is "Resource locked by another user". If no client or user owns the configuration lock, the error message is "User does not have the lock".
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to unlock the configuration 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/configuration/unlock"

Example of Accessing the API with Python

The following example shows how to unlock the configuration 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/configuration/unlock"
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: Thu, 02 Apr 2020 07:59:10 GMT
Content-Type: application/xml
Connection: keep-alive

Example of the Response Body

This endpoint does not return a response body.

Back to Top