get_system_configs

ManagementApi.get_system_configs(role_id, config=None, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get system information and configuration

Returns deployment identity (Version, Environment, ProjectName, ProjectShortname, AWSRegion, AWSAccountId) when no query parameters are sent. Use config for one stored setting, or config=all for identity plus every setting. Matching is case-insensitive. Any valid authenticated user may call this; there is no extra permission. RAG and web-search settings are returned only when AI services are enabled; otherwise those config values return GE-1034.

Parameters:

  • role_id (str) – Amorphic role ID the request is authorized against. Must be a role the user belongs to. Also recorded in audit logs. (required)

  • config (str) – Named configuration to return. Omit with no other query keys for deployment info only. all merges that info with every getter. Unknown values return GE-1034. Query present with neither config nor projectionExpression returns {}. enabled_verticals_list uses an underscore.

  • projection_expression (str) – Comma-separated names from Version, Environment, ProjectName, ProjectShortname, AWSRegion, AWSAccountId. Applied only to that map; does not filter config fields. Split is not trimmed, so spaces in names do not match.

  • _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:

SystemConfiguration

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /system-configs

Success (HTTP 200)

Body keys depend on config. With no query parameters, only the six deployment identity fields are returned. ProxyDomains is omitted when managed Squid is not in use.

No query string

{
  "Version": "2.6.0",
  "Environment": "dev",
  "ProjectName": "Amorphic",
  "ProjectShortname": "cw",
  "AWSRegion": "us-east-1",
  "AWSAccountId": "123456789012"
}

config=whitelist-ips

{
  "IPV4Enabled": "yes",
  "IPV6Enabled": "no",
  "WhitelistedIPs": {
    "IPV4Addresses": [
      "203.0.113.10"
    ],
    "IPV6Addresses": []
  }
}

Errors

Documented error codes: GE-1060, GE-1034, GE-1113, RTE-1001, EMF-1001.

HTTP 400

GE-1060 invalid user. GE-1034 unsupported config (including rag/web-search when AI is off). GE-1113 as InvalidInput for FlexView SSM only.

Invalid user

{
  "Message": "GE-1060 - User jdoe is not valid user."
}

Unsupported config

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

HTTP 500

GE-1113 SSM read (most getters). ClientError body is the raw boto string. Uncaught Exception is RTE-1001 via EMF-1001.

SSM parameter missing

{
  "Message": "GE-1113 - /adp/amorphic/config/logsretentionperiod is an invalid parameter or parameter not found. Failed to fetch with error - An error occurred (ParameterNotFound) when calling the GetParameter operation"
}

Uncaught Exception

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