Param name | Description |
---|---|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
paginate results Validations:
|
per_page optional |
number of entries per request Validations:
|
Code | Description |
---|---|
404 | Lock could not be found. |
Param name | Description |
---|---|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
id required |
Id or name of the DLM lock Validations:
|
Param name | Description |
---|---|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
dlmlock required |
Validations:
|
dlmlock[name] required |
Name Validations:
|
dlmlock[type] required |
Type, e.g. Dlmlock:Update Validations:
|
dlmlock[enabled] optional , nil allowed |
Enable the lock Validations:
|
Param name | Description |
---|---|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
id required |
Id or name of the DLM lock Validations:
|
dlmlock required |
Validations:
|
dlmlock[name] optional |
Name Validations:
|
dlmlock[type] optional |
Type, e.g. Dlmlock:Update Validations:
|
dlmlock[enabled] optional , nil allowed |
Enable the lock Validations:
|
Param name | Description |
---|---|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
id required |
Id or name of the DLM lock Validations:
|
This action acquires a lock. It fails, if the lock is currently taken by another host.
The host is authenticated via a client certificate and identified via the CN of that certificate.
Code | Description |
---|---|
200 | Lock acquired successfully. |
412 | Lock could not be acquired. |
Param name | Description |
---|---|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
id required |
Id or name of the DLM lock Validations:
|
This action releases a lock. It fails, if the lock is currently taken by another host.
The host is authenticated via a client certificate and identified via the CN of that certificate.
Code | Description |
---|---|
200 | Lock released successfully. |
412 | Lock could not be released. |
Param name | Description |
---|---|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
id required |
Id or name of the DLM lock Validations:
|