Update housekeeping config

PUT

/api/housekeeping/config

curl --request PUT \
  --url https://gateway.example.com/api/housekeeping/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "cronExpression": "example", "nginxLogs": { "enabled": true, "retentionDays": 1 }, "auditLog": { "enabled": true, "retentionDays": 1 }, "dismissedAlerts": { "enabled": true, "retentionDays": 1 }, "deliveryLog": { "enabled": true, "retentionDays": 1 }, "structuredLogs": { "enabled": true, "maxRows": 1, "maxSizeBytes": 1 }, "clickHouseInternals": { "enabled": true, "maxSizeBytes": 1 }, "orphanedAIArtifacts": { "enabled": true }, "internalRegistry": { "enabled": true, "retentionSuccessfulArtifacts": 1 }, "orphanedVolumes": { "enabled": true, "retentionDays": 1 }, "dockerPrune": { "enabled": true }, "orphanedCerts": { "enabled": true }, "acmeCleanup": { "enabled": true } }'

• Your Gateway instance

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

enabled

boolean

cronExpression

string

/^[\d*,/-]+\s+[\d*,/-]+\s+[\d*,/-]+\s+[\d*,/-]+\s+[\d*,/-]+$/

nginxLogs

object

enabled

boolean

retentionDays

integer

>= 1 <= 365

auditLog

object

enabled

boolean

retentionDays

integer

>= 1 <= 365

dismissedAlerts

object

enabled

boolean

retentionDays

integer

>= 1 <= 365

deliveryLog

object

enabled

boolean

retentionDays

integer

>= 1 <= 365

structuredLogs

object

enabled

boolean

maxRows

integer

>= 1000 <= 9007199254740991

maxSizeBytes

integer

>= 1048576 <= 9007199254740991

clickHouseInternals

object

enabled

boolean

maxSizeBytes

integer

>= 1048576 <= 9007199254740991

orphanedAIArtifacts

object

enabled

boolean

internalRegistry

object

enabled

boolean

retentionSuccessfulArtifacts

integer

>= 1 <= 100

orphanedVolumes

object

enabled

boolean

retentionDays

integer

>= 1 <= 365

dockerPrune

object

enabled

boolean

orphanedCerts

object

enabled

boolean

acmeCleanup

object

enabled

boolean

Responses

200

Successful response

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "enabled": true,
    "cronExpression": "0 3 * * *",
    "lastRunAt": "2024-01-01T03:00:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}