Skip to main content

Enable / Disable Access Logs

Enables or disables shipping of the load balancer's HAProxy access logs to an object-storage (EOS) bucket. The behaviour is controlled by the is_enabled query parameter together with the request body:

  • Enable: call with ?is_enabled=true and a body containing appliance_id, access_key, secret_key, and bucket - the credentials for the destination object-storage bucket.

  • Disable: call with a body of { "appliance_id": "<id>", "disable": true }.

PUT/api/v1/appliances/load-balancers/log-migrate/

Query parameters

  • is_enabledQuerybooleanoptional

    Used only when enabling access-log shipping - send is_enabled=true together with the bucket-credentials body. For the disable flow this parameter is discarded; send the { "appliance_id": "<id>", "disable": true } body instead.

    • send true only on the enable flow; discarded (not sent) on the disable flow
    exampletrue
  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the load balancer.

    • must be a non-empty string
    example{{location}}

Request body

application/json

object

Body for enabling or disabling access-log shipping. To enable, call with ?is_enabled=true and supply the object-storage access_key, secret_key, and bucket. To disable, send { "appliance_id": "<id>", "disable": true }.

appliance_idstringrequired

ID of the load balancer (appliance) whose access logs are being configured.

example7972
  • required
  • must be a valid load balancer ID
access_keystring

Access key for the destination object-storage (EOS) bucket. Required when enabling.

exampleaccess-key
  • required when enabling (is_enabled=true)
secret_keystring

Secret key for the destination object-storage bucket. Required when enabling.

examplesecret-key
  • required when enabling (is_enabled=true)
bucketstring

Name of the destination object-storage bucket. Required when enabling.

examplebucket-name
  • required when enabling (is_enabled=true)
disableboolean

Send true (with appliance_id) to disable access-log shipping.

exampletrue
  • required when disabling

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess