Skip to content

Override Settings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/override-settings/ Get all overridable settings
Other Actions
POST /api/override-settings/ Update overridable settings

Core CRUD

Get all overridable settings

Returns all settings that can be overridden in the database via the Constance backend. Requires admin permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/override-settings/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.override_settings import override_settings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = override_settings_retrieve.sync(client=client)

print(response)
  1. API Source: override_settings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { overrideSettingsRetrieve } from 'waldur-js-client';

try {
  const response = await overrideSettingsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
SITE_NAME string
SITE_DESCRIPTION string
HOMEPORT_URL string
RANCHER_USERNAME_INPUT_LABEL string
SITE_ADDRESS string
SITE_EMAIL string
SITE_PHONE string
CURRENCY_NAME string
THUMBNAIL_SIZE string
ANONYMOUS_USER_CAN_VIEW_OFFERINGS boolean
ANONYMOUS_USER_CAN_VIEW_PLANS boolean
NOTIFY_STAFF_ABOUT_APPROVALS boolean
NOTIFY_ABOUT_RESOURCE_CHANGE boolean
DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE boolean
MARKETPLACE_LANDING_PAGE string
ENABLE_STALE_RESOURCE_NOTIFICATIONS boolean
TELEMETRY_URL string
TELEMETRY_VERSION integer
SCRIPT_RUN_MODE string
DOCKER_CLIENT string
DOCKER_RUN_OPTIONS string
DOCKER_SCRIPT_DIR string
DOCKER_REMOVE_CONTAINER boolean
DOCKER_IMAGES string
DOCKER_VOLUME_NAME string
K8S_NAMESPACE string
K8S_CONFIG_PATH string
K8S_JOB_TIMEOUT integer
ENABLE_STRICT_CHECK_ACCEPTING_INVITATION boolean
INVITATION_DISABLE_MULTIPLE_ROLES boolean
DEFAULT_IDP string
DOCS_URL string (uri)
SHORT_PAGE_TITLE string
FULL_PAGE_TITLE string
PROJECT_END_DATE_MANDATORY boolean
ENABLE_ORDER_START_DATE boolean
BRAND_COLOR string
HERO_LINK_LABEL string
HERO_LINK_URL string (uri)
SUPPORT_PORTAL_URL string (uri)
COMMON_FOOTER_TEXT string
COMMON_FOOTER_HTML string
LANGUAGE_CHOICES string
DISABLE_DARK_THEME boolean
POWERED_BY_LOGO string (uri)
HERO_IMAGE string (uri)
MARKETPLACE_HERO_IMAGE string (uri)
CALL_MANAGEMENT_HERO_IMAGE string (uri)
SIDEBAR_LOGO string (uri)
SIDEBAR_LOGO_DARK string (uri)
SIDEBAR_LOGO_MOBILE string (uri)
SIDEBAR_STYLE string
SITE_LOGO string (uri)
LOGIN_LOGO string (uri)
FAVICON string (uri)
OFFERING_LOGO_PLACEHOLDER string (uri)
WALDUR_SUPPORT_ENABLED boolean
WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE string
WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE boolean
ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS boolean
ATLASSIAN_API_URL string (uri)
ATLASSIAN_USERNAME string
ATLASSIAN_PASSWORD string
ATLASSIAN_EMAIL string (email)
ATLASSIAN_USE_OLD_API boolean
ATLASSIAN_TOKEN string
ATLASSIAN_PERSONAL_ACCESS_TOKEN string
ATLASSIAN_OAUTH2_CLIENT_ID string
ATLASSIAN_OAUTH2_ACCESS_TOKEN string
ATLASSIAN_OAUTH2_TOKEN_TYPE string
ATLASSIAN_VERIFY_SSL boolean
ATLASSIAN_PROJECT_ID string
ATLASSIAN_SHARED_USERNAME boolean
ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED boolean
ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE string
ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES string
ATLASSIAN_ISSUE_TYPES string
ATLASSIAN_SUPPORT_TYPE_MAPPING string
ATLASSIAN_DESCRIPTION_TEMPLATE string
ATLASSIAN_SUMMARY_TEMPLATE string
ATLASSIAN_AFFECTED_RESOURCE_FIELD string
ATLASSIAN_IMPACT_FIELD string
ATLASSIAN_ORGANISATION_FIELD string
ATLASSIAN_RESOLUTION_SLA_FIELD string
ATLASSIAN_PROJECT_FIELD string
ATLASSIAN_REPORTER_FIELD string
ATLASSIAN_CALLER_FIELD string
ATLASSIAN_SLA_FIELD string
ATLASSIAN_LINKED_ISSUE_TYPE string
ATLASSIAN_SATISFACTION_FIELD string
ATLASSIAN_REQUEST_FEEDBACK_FIELD string
ATLASSIAN_TEMPLATE_FIELD string
ATLASSIAN_WALDUR_BACKEND_ID_FIELD string
ZAMMAD_API_URL string (uri)
ZAMMAD_TOKEN string
ZAMMAD_GROUP string
ZAMMAD_ARTICLE_TYPE string
ZAMMAD_COMMENT_MARKER string
ZAMMAD_COMMENT_PREFIX string
ZAMMAD_COMMENT_COOLDOWN_DURATION integer
SMAX_API_URL string (uri)
SMAX_TENANT_ID string
SMAX_LOGIN string
SMAX_PASSWORD string
SMAX_ORGANISATION_FIELD string
SMAX_PROJECT_FIELD string
SMAX_AFFECTED_RESOURCE_FIELD string
SMAX_TIMES_TO_PULL integer
SMAX_SECONDS_TO_WAIT integer
SMAX_CREATION_SOURCE_NAME string
SMAX_REQUESTS_OFFERING string
SMAX_VERIFY_SSL boolean
ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND boolean
ENABLE_MOCK_COURSE_ACCOUNT_BACKEND boolean
PROPOSAL_REVIEW_DURATION integer
USER_TABLE_COLUMNS string
AUTO_APPROVE_USER_TOS boolean
FREEIPA_ENABLED boolean
FREEIPA_HOSTNAME string
FREEIPA_USERNAME string
FREEIPA_PASSWORD string
FREEIPA_VERIFY_SSL boolean
FREEIPA_USERNAME_PREFIX string
FREEIPA_GROUPNAME_PREFIX string
FREEIPA_BLACKLISTED_USERNAMES array of strings
FREEIPA_GROUP_SYNCHRONIZATION_ENABLED boolean
KEYCLOAK_ICON string (uri)
COUNTRIES array of strings
OIDC_AUTH_URL string
OIDC_INTROSPECTION_URL string
OIDC_CLIENT_ID string
OIDC_CLIENT_SECRET string
OIDC_USER_FIELD string
OIDC_CACHE_TIMEOUT integer
OIDC_ACCESS_TOKEN_ENABLED boolean
OIDC_BLOCK_CREATION_OF_UNINVITED_USERS boolean
DEACTIVATE_USER_IF_NO_ROLES boolean
MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES integer
MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM array of strings
ENFORCE_USER_CONSENT_FOR_OFFERINGS boolean
DISABLED_OFFERING_TYPES array of strings
ONBOARDING_COUNTRY string
ONBOARDING_VERIFICATION_EXPIRY_HOURS integer
ONBOARDING_ARIREGISTER_BASE_URL string (uri)
ONBOARDING_ARIREGISTER_USERNAME string
ONBOARDING_ARIREGISTER_PASSWORD string
ONBOARDING_ARIREGISTER_TIMEOUT integer
ONBOARDING_WICO_API_URL string (uri)
ONBOARDING_WICO_TOKEN string
ONBOARDING_BOLAGSVERKET_API_URL string (uri)
ONBOARDING_BOLAGSVERKET_TOKEN_API_URL string (uri)
ONBOARDING_BOLAGSVERKET_CLIENT_ID string
ONBOARDING_BOLAGSVERKET_CLIENT_SECRET string

Other Actions

Update overridable settings

Updates one or more settings in the database via the Constance backend. Requires admin permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/override-settings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.constance_settings_request import ConstanceSettingsRequest # (1)
from waldur_api_client.api.override_settings import override_settings # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ConstanceSettingsRequest()
response = override_settings.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ConstanceSettingsRequest
  2. API Source: override_settings
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { overrideSettings } from 'waldur-js-client';

try {
  const response = await overrideSettings({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
SITE_NAME string
SITE_DESCRIPTION string
HOMEPORT_URL string
RANCHER_USERNAME_INPUT_LABEL string
SITE_ADDRESS string
SITE_EMAIL string
SITE_PHONE string
CURRENCY_NAME string
THUMBNAIL_SIZE string
ANONYMOUS_USER_CAN_VIEW_OFFERINGS boolean
ANONYMOUS_USER_CAN_VIEW_PLANS boolean
NOTIFY_STAFF_ABOUT_APPROVALS boolean
NOTIFY_ABOUT_RESOURCE_CHANGE boolean
DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE boolean
MARKETPLACE_LANDING_PAGE string
ENABLE_STALE_RESOURCE_NOTIFICATIONS boolean
TELEMETRY_URL string
TELEMETRY_VERSION integer
SCRIPT_RUN_MODE string
DOCKER_CLIENT string
DOCKER_RUN_OPTIONS string
DOCKER_SCRIPT_DIR string
DOCKER_REMOVE_CONTAINER boolean
DOCKER_IMAGES string
DOCKER_VOLUME_NAME string
K8S_NAMESPACE string
K8S_CONFIG_PATH string
K8S_JOB_TIMEOUT integer
ENABLE_STRICT_CHECK_ACCEPTING_INVITATION boolean
INVITATION_DISABLE_MULTIPLE_ROLES boolean
DEFAULT_IDP string
DOCS_URL string (uri)
SHORT_PAGE_TITLE string
FULL_PAGE_TITLE string
PROJECT_END_DATE_MANDATORY boolean
ENABLE_ORDER_START_DATE boolean
BRAND_COLOR string
HERO_LINK_LABEL string
HERO_LINK_URL string (uri)
SUPPORT_PORTAL_URL string (uri)
COMMON_FOOTER_TEXT string
COMMON_FOOTER_HTML string
LANGUAGE_CHOICES string
DISABLE_DARK_THEME boolean
POWERED_BY_LOGO string (binary)
HERO_IMAGE string (binary)
MARKETPLACE_HERO_IMAGE string (binary)
CALL_MANAGEMENT_HERO_IMAGE string (binary)
SIDEBAR_LOGO string (binary)
SIDEBAR_LOGO_DARK string (binary)
SIDEBAR_LOGO_MOBILE string (binary)
SIDEBAR_STYLE string
SITE_LOGO string (binary)
LOGIN_LOGO string (binary)
FAVICON string (binary)
OFFERING_LOGO_PLACEHOLDER string (binary)
WALDUR_SUPPORT_ENABLED boolean
WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE string
WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE boolean
ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS boolean
ATLASSIAN_API_URL string (uri)
ATLASSIAN_USERNAME string
ATLASSIAN_PASSWORD string
ATLASSIAN_EMAIL string (email)
ATLASSIAN_USE_OLD_API boolean
ATLASSIAN_TOKEN string
ATLASSIAN_PERSONAL_ACCESS_TOKEN string
ATLASSIAN_OAUTH2_CLIENT_ID string
ATLASSIAN_OAUTH2_ACCESS_TOKEN string
ATLASSIAN_OAUTH2_TOKEN_TYPE string
ATLASSIAN_VERIFY_SSL boolean
ATLASSIAN_PROJECT_ID string
ATLASSIAN_SHARED_USERNAME boolean
ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED boolean
ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE string
ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES string
ATLASSIAN_ISSUE_TYPES string
ATLASSIAN_SUPPORT_TYPE_MAPPING string
ATLASSIAN_DESCRIPTION_TEMPLATE string
ATLASSIAN_SUMMARY_TEMPLATE string
ATLASSIAN_AFFECTED_RESOURCE_FIELD string
ATLASSIAN_IMPACT_FIELD string
ATLASSIAN_ORGANISATION_FIELD string
ATLASSIAN_RESOLUTION_SLA_FIELD string
ATLASSIAN_PROJECT_FIELD string
ATLASSIAN_REPORTER_FIELD string
ATLASSIAN_CALLER_FIELD string
ATLASSIAN_SLA_FIELD string
ATLASSIAN_LINKED_ISSUE_TYPE string
ATLASSIAN_SATISFACTION_FIELD string
ATLASSIAN_REQUEST_FEEDBACK_FIELD string
ATLASSIAN_TEMPLATE_FIELD string
ATLASSIAN_WALDUR_BACKEND_ID_FIELD string
ZAMMAD_API_URL string (uri)
ZAMMAD_TOKEN string
ZAMMAD_GROUP string
ZAMMAD_ARTICLE_TYPE string
ZAMMAD_COMMENT_MARKER string
ZAMMAD_COMMENT_PREFIX string
ZAMMAD_COMMENT_COOLDOWN_DURATION integer
SMAX_API_URL string (uri)
SMAX_TENANT_ID string
SMAX_LOGIN string
SMAX_PASSWORD string
SMAX_ORGANISATION_FIELD string
SMAX_PROJECT_FIELD string
SMAX_AFFECTED_RESOURCE_FIELD string
SMAX_TIMES_TO_PULL integer
SMAX_SECONDS_TO_WAIT integer
SMAX_CREATION_SOURCE_NAME string
SMAX_REQUESTS_OFFERING string
SMAX_VERIFY_SSL boolean
ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND boolean
ENABLE_MOCK_COURSE_ACCOUNT_BACKEND boolean
PROPOSAL_REVIEW_DURATION integer
USER_TABLE_COLUMNS string
AUTO_APPROVE_USER_TOS boolean
FREEIPA_ENABLED boolean
FREEIPA_HOSTNAME string
FREEIPA_USERNAME string
FREEIPA_PASSWORD string
FREEIPA_VERIFY_SSL boolean
FREEIPA_USERNAME_PREFIX string
FREEIPA_GROUPNAME_PREFIX string
FREEIPA_BLACKLISTED_USERNAMES array of strings
FREEIPA_GROUP_SYNCHRONIZATION_ENABLED boolean
KEYCLOAK_ICON string (binary)
COUNTRIES array of strings
OIDC_AUTH_URL string
OIDC_INTROSPECTION_URL string
OIDC_CLIENT_ID string
OIDC_CLIENT_SECRET string
OIDC_USER_FIELD string
OIDC_CACHE_TIMEOUT integer
OIDC_ACCESS_TOKEN_ENABLED boolean
OIDC_BLOCK_CREATION_OF_UNINVITED_USERS boolean
DEACTIVATE_USER_IF_NO_ROLES boolean
MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES integer
MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM array of strings
ENFORCE_USER_CONSENT_FOR_OFFERINGS boolean
DISABLED_OFFERING_TYPES array of strings
ONBOARDING_COUNTRY string
ONBOARDING_VERIFICATION_EXPIRY_HOURS integer
ONBOARDING_ARIREGISTER_BASE_URL string (uri)
ONBOARDING_ARIREGISTER_USERNAME string
ONBOARDING_ARIREGISTER_PASSWORD string
ONBOARDING_ARIREGISTER_TIMEOUT integer
ONBOARDING_WICO_API_URL string (uri)
ONBOARDING_WICO_TOKEN string
ONBOARDING_BOLAGSVERKET_API_URL string (uri)
ONBOARDING_BOLAGSVERKET_TOKEN_API_URL string (uri)
ONBOARDING_BOLAGSVERKET_CLIENT_ID string
ONBOARDING_BOLAGSVERKET_CLIENT_SECRET string

200 - No response body