Configuration management

App and system configuration management including configuration retrieval, updates, and app configuration UI.

Authentication

None

No authentication required for configuration management operations

Endpoints

Get app UI settings

GET

/workflows/v1/configmap/{config_map_id}

Retrieve application configuration display parameters by identifier. Returns structured configuration data used by the Atlan UI for rendering app forms and validation rules.

Path Parameters

config_map_idstringREQUIRED

Unique string identifier for the application settings and UI display parameters

Example:"pikachu-config-001"

Response

200Configuration retrieved successfully

successbooleanREQUIRED

Boolean flag indicating whether the configuration retrieval operation completed successfully

Example:

true

messagestringREQUIRED

Human-readable status message confirming successful configuration retrieval

Example:"Configuration map fetched successfully"

dataobjectREQUIRED

Configuration data

Error Codes

400

Bad Request

Invalid configuration parameters or malformed JSON payload

401

Unauthorized

Missing or invalid authentication token

404

Not Found

Configuration not found

500

Internal Server Error

Configuration storage or retrieval error

Code examples - Get app UI settings

cURL

BASH Request (cURL)

curl -X GET "http://localhost:8000/workflows/v1/configmap/pikachu-config-001"

Python

Python Request (Python)

import requests

response = requests.get(
  "http://localhost:8000/workflows/v1/configmap/pikachu-config-001"
)
config_map = response.json()