update_system_configs

ManagementApi.update_system_configs(config, role_id, update_system_configuration, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a named system configuration

Updates one stored setting selected by the required config query parameter (IPV-1052 if omitted). Requires system-settings.manage. web-search-configuration also requires ai.manage; missing that permission returns AUTH-1030 as HTTP 400. Request body fields depend on config. Matching is case-insensitive. ai-services-configuration is not a supported update target (GE-1034) even though the handler still requires ai.manage before rejecting it.

Parameters:

  • config (str) – Named configuration to update. Compared lowercase. Not the same set as GET (no all, redshift, studio-instance-types, enabled_verticals_list, flexview-details, rag-configuration). (required)

  • role_id (str) – Amorphic role ID the request is authorized against. Must be a role the user belongs to. Used for permission checks and audit logs. (required)

  • update_system_configuration (UpdateSystemConfiguration) – (required)

  • content_type (str) – Must be application/json when a body is sent.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

UpdateSystemConfigurationResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /system-configs

Request

config=logs-retention-period

{
  "LogsRetentionPeriod": "90"
}

config=whitelist-ips

{
  "IPV4Addresses": [
    "203.0.113.10"
  ]
}

Success (HTTP 200)

Message text depends on config. Previous-object-versions can still be HTTP 200 when some bucket lifecycle updates failed.

Logs retention

{
  "Message": "System logs retention period updated. It will be applied to logs within a day"
}

Whitelist IPs

{
  "Message": "Successfully updated whitelisted IPs."
}

Errors

Documented error codes: GE-1060, AUTH-1030, IPV-1052, GE-1034, IPV-1008, IPV-1002, IPV-1004, IPV-1005, IPV-1010, IPV-1012, IPV-1015, IPV-1041, IPV-1071, GE-1119, GE-1120, AI-1002, GE-1012, GE-1113, RTE-1001, EMF-1001.

HTTP 400

GE-1060. AUTH-1030 from is_user_action_valid, or from missing ai.manage (II). IPV-1052 missing config. GE-1034 unsupported config or several validation paths. IPV-1008, IPV-1002, IPV-1004, IPV-1005, IPV-1010, IPV-1012, IPV-1015, IPV-1041, IPV-1071, GE-1119, GE-1120.

Missing config

{
  "Message": "IPV-1052 - Missing mandatory parameter(s) config in queryStringParameters/pathParameters"
}

Unsupported config

{
  "Message": "GE-1034 - Failed to process the api request, unsupported configuration is passed."
}

Missing ai.manage

{
  "Message": "AUTH-1030 - User is not authorized to AI configuration due to the following missing permission(s) - {'AI': ['manage']}"
}

HTTP 500

GE-1034 for bucket versioning off, Squid not enabled, datasource/log-level failures. AI-1002 web-search agent missing. GE-1012 tag SSM delete. GE-1113. ClientError raw. RTE-1001 via EMF-1001.

Bucket versioning disabled

{
  "Message": "GE-1034 - PreviousObjectVersionsRetentionPeriod is applicable only if BucketVersioning is enabled. Please contact admin to enable BucketVersioning."
}

Uncaught Exception

{
  "Message": "RTE-1001 - Internal error."
}