Jump to

• Request
• Response
• Examples

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 is the exclusive right to modify the configuration. If no other user or session is currently modifying the system configuration, 204 No Content is returned and the client can begin issuing configuration-modifying requests. If another user or session already owns the configuration lock, 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

• version:
  REST API version string.
  Available values: v1.2

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

Client has successfully acquired the configuration lock and can begin making configuration changes.

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

Client did not acquire the configuration lock; another client/user already owns the lock.

Back to Top

Examples

Example of Accessing the API with cURL

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://${SBCIP}/rest/v1.1/configuration/lock"

Example of Accessing the API with Python

The following example shows how to lock 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/lock"
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 14:06:08 GMT
Content-Type: application/xml
Connection: keep-alive

Example of the Response Body

This endpoint does not return a response body.

Back to Top