# Config ## Get tenant core configuration > Returns the tenant name, favicon URLs, effective public URI, enabled extensions, and tenant language settings.\ > \ > \## Authorization\ > Requires \`tenant.core:read\` scope. ```json {"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"Config"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["ScopedAuthorizeRequirement"]},{"apiKey":["ScopedAuthorizeRequirement"]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"TenantConfigWeb":{"required":["availableLanguages","defaultLanguage","extensions","favicons","name","publicUri"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the tenant."},"favicons":{"description":"Favicon URLs returned for the tenant.","$ref":"#/components/schemas/TenantConfigFaviconsWeb"},"logoUrl":{"type":["null","string"],"description":"Optional logo URL."},"appTitle":{"type":["null","string"],"description":"Optional browser/application title override."},"status":{"description":"Tenant operational status.","$ref":"#/components/schemas/TenantStatus"},"purpose":{"description":"Tenant usage purpose.","$ref":"#/components/schemas/TenantPurpose"},"publicUri":{"minLength":1,"type":"string","description":"Effective public base URI used for end-user links."},"defaultLanguage":{"minLength":1,"type":"string","description":"Default language configured for the tenant."},"availableLanguages":{"type":"array","items":{"type":"string"},"description":"List of languages available for the tenant."},"extensions":{"type":"array","items":{"type":"string"},"description":"List of enabled extensions for this tenant."}},"additionalProperties":false,"description":"Tenant core configuration response"},"TenantConfigFaviconsWeb":{"required":["rawFaviconUrl"],"type":"object","properties":{"faviconUrl":{"type":["null","string"],"description":"Resolved 192x192 favicon URL. Can be a full URL or fallback data URL."},"rawFaviconUrl":{"minLength":1,"type":"string","description":"Raw 48x48 favicon URL from `config.yml`."},"rawLargeFaviconUrl":{"type":["null","string"],"description":"Raw 192x192 favicon URL from `config.yml`."},"rawAppleFaviconUrl":{"type":["null","string"],"description":"Raw Apple touch icon URL from `config.yml`."}},"additionalProperties":false,"description":"Favicon URLs for tenant configuration response."},"TenantStatus":{"enum":[1,2,3],"type":"integer","description":"Operational status of the tenant.","format":"int32"},"TenantPurpose":{"enum":[1,2,3],"type":"integer","description":"Intended usage context of the tenant.","format":"int32"}}},"paths":{"/api/{tenantId}/admin/config":{"get":{"tags":["Config"],"summary":"Get tenant core configuration","description":"Returns the tenant name, favicon URLs, effective public URI, enabled extensions, and tenant language settings.\n \n## Authorization\nRequires `tenant.core:read` scope.","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Configuration returned.","content":{"text/plain":{"schema":{"description":"Tenant core configuration response","$ref":"#/components/schemas/TenantConfigWeb"}},"application/json":{"schema":{"description":"Tenant core configuration response","$ref":"#/components/schemas/TenantConfigWeb"}},"text/json":{"schema":{"description":"Tenant core configuration response","$ref":"#/components/schemas/TenantConfigWeb"}}}}}}}}} ``` ## Update tenant core configuration > Updates editable core fields in \`config.yml\`.\ > Status and purpose can only be modified by global administrators.\ > \ > \## Authorization\ > Requires \`tenant.configuration.general:write\` scope. ```json {"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"Config"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["ScopedAuthorizeRequirement"]},{"apiKey":["ScopedAuthorizeRequirement"]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"UpdateTenantConfigWebRequest":{"type":"object","properties":{"logoUrl":{"type":["null","string"],"description":"Optional logo URL."},"faviconUrl":{"type":["null","string"],"description":"Optional 48x48 favicon URL."},"largeFaviconUrl":{"type":["null","string"],"description":"Optional 192x192 favicon URL. Set empty string to clear."},"appleFaviconUrl":{"type":["null","string"],"description":"Optional Apple touch icon URL. Set empty string to clear."},"appTitle":{"type":["null","string"],"description":"Optional application title override. Set empty string to clear."},"defaultLanguage":{"type":["null","string"],"description":"Optional default language."},"availableLanguages":{"type":["null","array"],"items":{"type":"string"},"description":"Optional available languages."},"status":{"description":"Optional tenant status (global administrators only).","$ref":"#/components/schemas/TenantStatus"},"purpose":{"description":"Optional tenant purpose (global administrators only).","$ref":"#/components/schemas/TenantPurpose"}},"additionalProperties":false,"description":"Tenant core configuration patch request."},"TenantStatus":{"enum":[1,2,3],"type":"integer","description":"Operational status of the tenant.","format":"int32"},"TenantPurpose":{"enum":[1,2,3],"type":"integer","description":"Intended usage context of the tenant.","format":"int32"},"TenantConfigWeb":{"required":["availableLanguages","defaultLanguage","extensions","favicons","name","publicUri"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the tenant."},"favicons":{"description":"Favicon URLs returned for the tenant.","$ref":"#/components/schemas/TenantConfigFaviconsWeb"},"logoUrl":{"type":["null","string"],"description":"Optional logo URL."},"appTitle":{"type":["null","string"],"description":"Optional browser/application title override."},"status":{"description":"Tenant operational status.","$ref":"#/components/schemas/TenantStatus"},"purpose":{"description":"Tenant usage purpose.","$ref":"#/components/schemas/TenantPurpose"},"publicUri":{"minLength":1,"type":"string","description":"Effective public base URI used for end-user links."},"defaultLanguage":{"minLength":1,"type":"string","description":"Default language configured for the tenant."},"availableLanguages":{"type":"array","items":{"type":"string"},"description":"List of languages available for the tenant."},"extensions":{"type":"array","items":{"type":"string"},"description":"List of enabled extensions for this tenant."}},"additionalProperties":false,"description":"Tenant core configuration response"},"TenantConfigFaviconsWeb":{"required":["rawFaviconUrl"],"type":"object","properties":{"faviconUrl":{"type":["null","string"],"description":"Resolved 192x192 favicon URL. Can be a full URL or fallback data URL."},"rawFaviconUrl":{"minLength":1,"type":"string","description":"Raw 48x48 favicon URL from `config.yml`."},"rawLargeFaviconUrl":{"type":["null","string"],"description":"Raw 192x192 favicon URL from `config.yml`."},"rawAppleFaviconUrl":{"type":["null","string"],"description":"Raw Apple touch icon URL from `config.yml`."}},"additionalProperties":false,"description":"Favicon URLs for tenant configuration response."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/admin/config":{"patch":{"tags":["Config"],"summary":"Update tenant core configuration","description":"Updates editable core fields in `config.yml`.\nStatus and purpose can only be modified by global administrators.\n \n## Authorization\nRequires `tenant.configuration.general:write` scope.","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Tenant core configuration patch request.","$ref":"#/components/schemas/UpdateTenantConfigWebRequest"}},"text/json":{"schema":{"description":"Tenant core configuration patch request.","$ref":"#/components/schemas/UpdateTenantConfigWebRequest"}},"application/*+json":{"schema":{"description":"Tenant core configuration patch request.","$ref":"#/components/schemas/UpdateTenantConfigWebRequest"}}},"required":true},"responses":{"200":{"description":"Configuration updated and returned.","content":{"text/plain":{"schema":{"description":"Tenant core configuration response","$ref":"#/components/schemas/TenantConfigWeb"}},"application/json":{"schema":{"description":"Tenant core configuration response","$ref":"#/components/schemas/TenantConfigWeb"}},"text/json":{"schema":{"description":"Tenant core configuration response","$ref":"#/components/schemas/TenantConfigWeb"}}}},"400":{"description":"Invalid language configuration.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"403":{"description":"Status or purpose update attempted without global-admin role.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.thewalletcrew.io/develop/api-reference/advanced/config.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.