Other

Delete specified locks

Delete the specified locks, their associated gb_sessions records, and record each deletion in gb_locks_deleted. All selected locks must still exist or the request is rejected (no partial deletes). Restricted locks (whole-table locks and locks on gb_unique_ids, gb_controls or gl_controls) can only be deleted by super users. When a transaction has been holding locks on a selected table for longer than the configured threshold, the delete is rejected; super users may re-submit with override_slow_query set to true. This method requires the Locks:Delete permission to be associated with your role.

DELETE

/gb/locks

curl --request DELETE \
  --url https://api.catch-e.com/gb/locks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lock_keys": [
    "98f2488326b3aa1d36fd7faca50fd17b",
    "8f648effeca05180cbc99cfbf83b880f"
  ],
  "override_slow_query": false
}
'

{
  "detail": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Body

JSON payload consisting of the [gb_locks]lock_key values to delete and an optional slow-query override (super users only). A plain array of lock_key values is also accepted for backwards compatibility.

lock_keysstring[]required

Maximum array length: 100

override_slow_querybooleandefault:false

Super users only - proceed even when a selected table is experiencing a delay

Response

Success

Still need help? Ask the team