Dlmlocks

>>>

GET /api/dlmlocks
List all DLM locks

Params

Param name Description
search
optional

filtra els resultats

Validations:

  • Must be a String
order
optional

ordena els resultats

Validations:

  • Must be a String
page
optional

pagina els resultats

Validations:

  • Must be a String
per_page
optional

Nombre d'entrades per petició

Validations:

  • Must be a String
>>>

GET /api/dlmlocks/:id
Show a DLM lock

GET /api/dlmlocks/:id/lock
Show a DLM lock

Errors

Code Description
404 Lock could not be found.

Params

Param name Description
id
required

Id or name of the DLM lock

Validations:

  • Must be a String
>>>

POST /api/dlmlocks
Create a DLM lock

Params

Param name Description
dlmlock
required

Validations:

  • Must be a Hash
dlmlock[name]
required

Nom

Validations:

  • Must be a String
dlmlock[type]
required

Type, e.g. Dlmlock:Update

Validations:

  • Must be one of: Dlmlock:Update.
dlmlock[enabled]
optional , nil allowed

Enable the lock

Validations:

  • Must be one of: true, false, 1, 0
>>>

PUT /api/dlmlocks/:id
Update a DLM lock

Params

Param name Description
id
required

Id or name of the DLM lock

Validations:

  • Must be a String
dlmlock
required

Validations:

  • Must be a Hash
dlmlock[name]
optional

Nom

Validations:

  • Must be a String
dlmlock[type]
optional

Type, e.g. Dlmlock:Update

Validations:

  • Must be one of: Dlmlock:Update.
dlmlock[enabled]
optional , nil allowed

Enable the lock

Validations:

  • Must be one of: true, false, 1, 0
>>>

DELETE /api/dlmlocks/:id
Delete a DLM lock

Params

Param name Description
id
required

Id or name of the DLM lock

Validations:

  • Must be a String
>>>

PUT /api/dlmlocks/:id/lock
Acquire a DLM lock

Acquire a lock ↑

This action acquires a lock. It fails, if the lock is currently taken by another host.

Authentication & Host Identification ↑

The host is authenticated via a client certificate and identified via the CN of that certificate.

Errors

Code Description
200 Lock acquired successfully.
412 Lock could not be acquired.

Params

Param name Description
id
required

Id or name of the DLM lock

Validations:

  • Must be a String
>>>

DELETE /api/dlmlocks/:id/lock
Release a DLM lock

Release a lock ↑

This action releases a lock.
It fails, if the lock is currently taken by another host.

Authentication & Host Identification ↑

The host is authenticated via a client certificate and identified via the CN of that certificate.

Errors

Code Description
200 Lock released successfully.
412 Lock could not be released.

Params

Param name Description
id
required

Id or name of the DLM lock

Validations:

  • Must be a String