1. REST API for Session Border Controller Release 8.2
  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.

Request

Path Parameters
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 /auth/token request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

204 Response

Client has successfully released the configuration lock.

400 Response

The request is malformed or missing required information.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

401 Response

The client is not authorized.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

403 Response

This request requires the client to have administrator privileges.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

404 Response

Unsupported versionId in URI.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

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".
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source
Back to Top

Examples

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://10.0.0.2/rest/v1.0/configuration/unlock'

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Date: Wed, 08 Aug 2018 13:27:44 GMT
Cache-Control: no-cache
Content-Length: 0
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Wed, 08 Aug 2018 13:27:44 GMT
X-Appweb-Seq: 157

Example of the Response Body

This endpoint does not return a response body.

Back to Top