Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
PUTAgentSince 1.0SynchronousAuth Required

UpdateLockConfig

Update the global lock configuration for TTL and auto-release behavior

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • lockTtlMinutesIntegerRequired

    Updated lock TTL in minutes

    Example: 30

  • allowForceUnlockBooleanRequired

    Whether to allow force unlock

    Example: true

  • requireIfMatchHeaderBooleanRequired

    Whether to require If-Match header on updates

    Example: true

Responses

200 OK

On success, this API returns the following response structure.

  • defaultTtlSecondsInteger

    Default lock TTL in seconds if not specified at acquire time

    Example: 300

  • maxTtlSecondsInteger

    Maximum allowed TTL in seconds for any lock

    Example: 3600

  • autoReleaseEnabledBoolean

    Whether expired locks are automatically released by the system

    Example: true

Endpoint

PUT/api/v1/agents/locks/config

/api/v1/agents/locks/config

Operation ID

UpdateLockConfig

Permalink

Request Example

curl -X PUT '{host}/api/v1/agents/locks/config' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"lockTtlMinutes":30,"allowForceUnlock":true,"requireIfMatchHeader":true}'

Response Example

200
{
  "defaultTtlSeconds": 300,
  "maxTtlSeconds": 3600,
  "autoReleaseEnabled": true
}

Change History

This API has no change history records yet.

View all change history