1. REST API for Session Border Controller Release 8.2
  2. Tasks
  3. configuration

Lock the configuration

post

/rest/{version}/configuration/lock

Before a REST client can make any configuration changes, the client must first acquire the configuration lock, which grants the client the exclusive right to modify the configuration. If no other user or session or client is currently modifying the system configuration, 204 No Content is returned and the client can begin issuing configuration-modifying requests. If another client/user already owns the configuration lock, 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 acquired the configuration lock and can begin making configuration changes.

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

Client did not acquire the configuration lock; another client or user already owns 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 lock 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/lock'

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:26:40 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:26:40 GMT
X-Appweb-Seq: 156

Example of the Response Body

This endpoint does not return a response body.

Back to Top