API and agentsAPI reference
InstanceSettingsPatch
object
uploadMaxMbintegeror nullminimum1maximum102400Largest upload. Size cap for one uploaded file. Null clears the stored value.
dataProcessingTimeoutSintegeror nullminimum60maximum21600Data processing time limit. Time to receive one upload, and, counted apart, time for one data processing job, such as an import. Null clears the stored value.
remoteMaxMbintegeror nullminimum1maximum102400Largest link import. Size cap for a URL or object-store import. Null clears the stored value.
remoteTimeoutSintegeror nullminimum10maximum3600Link import time limit. Time for one link import's whole download. Null clears the stored value.
overtureMaxKm2integeror nullminimum1maximum1000000Overture area. The largest area one Overture import of places may cover; other themes may cover more or less, by how dense they are. Null clears the stored value.
osmMaxKm2integeror nullminimum1maximum1000000OpenStreetMap area. The largest area one OpenStreetMap import may cover. Null clears the stored value.
overpassTimeoutSintegeror nullminimum10maximum900Overpass time limit. Time budget sent with every Overpass query. Null clears the stored value.
overpassCacheHoursintegeror nullminimum1maximum720Overpass cache freshness. How long an Overpass response stays fresh. Null clears the stored value.
queryTimeoutSintegeror nullminimum5maximum600Query time limit. Time for one query, whether the SQL people run, a layer, an inspection, a preview or a published map. Null clears the stored value.
previewRowsintegeror nullminimum10maximum100000Rows shown in results. Row cap for result previews. Null clears the stored value.
exportRenderTimeoutSintegeror nullminimum10maximum300Time limit per image. Time for one image, its wait for a turn included. Null clears the stored value.
exportRenderConcurrencyintegeror nullminimum1maximum8Images at once. Images the server draws at the same time. Null clears the stored value.
geocodePaceMsintegeror nullminimum0maximum60000Address finder pace. Minimum request gap; zero means no gap. Null clears the stored value.
geocodeMatchCacheHoursintegeror nullminimum24maximum8760Address match freshness. How long matched addresses are cached. Null clears the stored value.
isochronePaceMsintegeror nullminimum0maximum60000Travel-time pace. Minimum routing request gap; zero means no gap. Null clears the stored value.
isochroneRequestTimeoutSintegeror nullminimum1maximum120Travel-time request limit. Deadline for one routing exchange. Null clears the stored value.
isochroneCacheHoursintegeror nullminimum24maximum8760Travel-time cache freshness. How long complete routing answers are cached. Null clears the stored value.
geocodeRequestTimeoutSintegeror nullminimum1maximum120Address request limit. Deadline for one geocoding exchange. Null clears the stored value.
operationTimeoutSintegeror nullminimum30maximum7200Time limit per run. Time for one tool run, not counting its wait for a turn. Null clears the stored value.
operationConcurrencyintegeror nullminimum1maximum8Operation runs at once. Tool runs at the same time; they share the engine that runs people's SQL. Null clears the stored value.
operationQueueMaxintegeror nullminimum1maximum200Operation runs waiting. Tool runs that may wait for a turn. Null clears the stored value.
publicRateLimitintegeror nullminimum1maximum10000Requests per source. Requests one visitor may make to published maps, counted by network address across every published map. Null clears the stored value.
publicTileRateLimitintegeror nullminimum1maximum100000Tile requests per source. Tile requests one visitor may make to published maps, counted by network address across every published map. Null clears the stored value.
s3Endpointstringor nullpattern^\s*[Hh][Tt][Tt][Pp][Ss]?://[^/\\?#\s]S3 endpoint. The S3-compatible store that s3:// links are read from without the server's credentials. Null clears the stored value. An http or https address with a host, at most 2048 characters once trimmed, kept as given. Write-only: it is stored encrypted with the instance's key and every read gives back its scheme and host alone, so a new key means sending the whole address again. A set DEZFIL_S3_ENDPOINT locks it.
overpassUrlstringor nullpattern^\s*[Hh][Tt][Tt][Pp][Ss]?://[^/\\?#\s]Overpass endpoint. Endpoint for OpenStreetMap imports. Null clears the stored value. An http or https address with a host, at most 2048 characters once trimmed, kept as given. Write-only: it is stored encrypted with the instance's key and every read gives back its scheme and host alone, so a new key means sending the whole address again. A set DEZFIL_OVERPASS_URL locks it.
satelliteUrlstringor nullpattern^\s*[Hh][Tt][Tt][Pp][Ss]?://[^/\\?#\s]Satellite template. Raster tile template enabling satellite imagery. Null clears the stored value. An http or https address with a host, at most 2048 characters once trimmed, kept as given. It must hold {z}, {x}, {y}; the save-time check reads it with each filled with a digit. It must carry no user name or password: the imagery is not drawn from such an address, so the key belongs in the path or the query. Write-only: it is stored encrypted with the instance's key and every read gives back its scheme and host alone, so a new key means sending the whole address again. A set DEZFIL_SATELLITE_URL locks it.
satelliteAttributionstringor nullpattern^\s*[\s\S]{0,160}\s*$Satellite credit. Credit line required by the imagery provider. Null clears the stored value. Text is trimmed before the 160-character limit; empty text clears to the default. A set DEZFIL_SATELLITE_ATTRIBUTION locks it.
geocoderUrlstringor nullpattern^\s*[Hh][Tt][Tt][Pp][Ss]?://[^/\\?#\s]Address finder. Nominatim-compatible endpoint for search and batch geocoding. Null clears the stored value. An http or https address with a host, at most 2048 characters once trimmed, kept as given. Write-only: it is stored encrypted with the instance's key and every read gives back its scheme and host alone, so a new key means sending the whole address again. A set DEZFIL_GEOCODER_URL locks it.
isochroneUrlstringor nullpattern^\s*[Hh][Tt][Tt][Pp][Ss]?://[^/\\?#\s]Travel-time endpoint. Valhalla-compatible endpoint for travel-time areas. Null clears the stored value. An http or https address with a host, at most 2048 characters once trimmed, kept as given. Write-only: it is stored encrypted with the instance's key and every read gives back its scheme and host alone, so a new key means sending the whole address again. A set DEZFIL_ISOCHRONE_URL locks it.
templatesCatalogueUrlstringor nullpattern^\s*[Hh][Tt][Tt][Pp][Ss]?://[^/\\?#\s]Catalogue address. Where the template catalogue's index is read. Null clears the stored value. An http or https address with a host, at most 2048 characters once trimmed, kept as given. Write-only: it is stored encrypted with the instance's key and every read gives back its scheme and host alone, so a new key means sending the whole address again. A set DEZFIL_TEMPLATES_CATALOGUE locks it. Only DEZFIL_TEMPLATES_CATALOGUE may name a folder on the server instead; a folder is never taken here.
instanceNamestringor nullpattern^\s*[\s\S]{0,80}\s*$Instance name. Name beside the wordmark and in browser titles. Null clears the stored value. Text is trimmed before the 80-character limit; empty text clears to the default.
signInMessagestringor nullpattern^\s*[\s\S]{0,280}\s*$Sign-in message. Optional message on the sign-in page. Null clears the stored value. Text is trimmed before the 280-character limit; empty text clears to the default.
lostPasswordContactstringor nullpattern^\s*[\s\S]{0,120}\s*$Lost-password contact. Contact line for password recovery; empty uses the built-in line. Null clears the stored value. Text is trimmed before the 120-character limit; empty text clears to the default.
landingPagestringor nullLanding page. Preferred entry destination after sign-in. Null clears the stored value.
One of
home,projects,maps,workflows,data,sql,nullnewMap.basemapstringor nullBasemap. The basemap a new map starts on. Auto follows the theme; a basemap the instance no longer offers starts on Auto. Null clears the stored value.
One of
auto,dark,light,streets,satellite,nullnewMap.latitudenumberor nullminimum-85maximum85Starting latitude. The latitude a new map opens at. Null clears the stored value.
newMap.longitudenumberor nullminimum-180maximum180Starting longitude. The longitude a new map opens at. Null clears the stored value.
newMap.zoomnumberor nullminimum0maximum22Starting zoom. The zoom a new map opens at. Null clears the stored value.
newMap.legendCornerstringor nullLegend corner. Where a new map's legend sits. Null clears the stored value.
One of
top-left,top-right,bottom-left,bottom-right,nullnewLayer.colorCyclestringor nullColor cycle. The palette whose colors new layers take in turn, drawn sketches included. Null clears the stored value.
One of
uber_viz_qualitative,bold,tab10,paired,dark2,set3,nullnewLayer.pointOpacityintegeror nullminimum10maximum100Point opacity. How opaque a new points layer is drawn, unless it is created with a style. Null clears the stored value.
newLayer.lineOpacityintegeror nullminimum10maximum100Line opacity. How opaque a new lines layer is drawn, unless it is created with a style. Null clears the stored value.
newLayer.areaOpacityintegeror nullminimum10maximum100Area opacity. How opaque a new areas layer is drawn, unless it is created with a style. Null clears the stored value.
newLayer.lineWidthnumberor nullminimum0.5maximum50Line width. How wide a new lines layer is drawn, unless it is created with a style. Null clears the stored value.
newLayer.pointRadiusnumberor nullminimum0.5maximum100Point radius. How large a new layer's points are drawn, unless it is created with a style. Null clears the stored value.
canvas.opensstringor nullCanvas opens. Whether a workflow canvas opens full screen or framed. Null clears the stored value.
One of
full,framed,nullcanvas.minimapstringor nullCanvas minimap. When a workflow canvas shows its minimap until the person chooses: auto shows it from six nodes. Null clears the stored value.
One of
auto,always,never,nullcanvas.resultsBandstringor nullCanvas results band. Whether a workflow canvas opens with its results band closed or open until the person chooses. Null clears the stored value.
One of
closed,open,nullsqlConsole.textSizestringor nullSQL text size. The text size the SQL console's editor opens at. Null clears the stored value.
One of
11,12,13,14,16,nullsqlConsole.lineWrapbooleanor nullSQL line wrap. Whether the SQL console's editor wraps long lines. Null clears the stored value.
imageExport.widthstringor nullImage starting width. The width a fresh image export card opens at. Null clears the stored value.
One of
1280,1920,2560,nullimageExport.shapestringor nullImage starting shape. The shape a fresh image export card opens at. Null clears the stored value.
One of
16:9,4:3,1:1,nullsecurity.sessionDaysstringor nullStay signed in for. How long a session lasts after its last use. A session keeps the expiry it holds; its next use renews it by this length. Null clears the stored value.
One of
1,7,30,90,nullsecurity.linkDaysstringor nullInvite and reset links last. How long an invitation or a password reset link stays valid. A link keeps the lifetime it was issued with. Null clears the stored value.
One of
1,3,7,14,nullsecurity.failedPerAccountintegeror nullminimum3maximum100Failed sign-ins per account. Failed sign-ins for one account, within a fixed 15 minutes, before its next attempt pauses. Wrong current passwords on password and email changes pause those changes at the same count, counted apart. Never above the count per address. Null clears the stored value.
security.failedPerAddressintegeror nullminimum10maximum1000Failed sign-ins per address. Failed sign-ins from one network address, within a fixed 15 minutes, before its next attempt pauses. Never below the count per account. Null clears the stored value.
security.passwordMinintegeror nullminimum8maximum64Shortest password. The fewest characters a password set from now may have. Passwords set earlier keep signing in. Null clears the stored value.
tokens.createstringor nullWho may create tokens. Whether every account or only admins may create API tokens. Tokens made earlier keep working. Null clears the stored value.
One of
everyone,admins,nulltokens.expirystringor nullNew tokens expire after. The lifetime a new API token takes, from its creation. Tokens made earlier keep their own. Null clears the stored value.
One of
never,30d,90d,1y,nullpublishing.publishstringor nullWho may publish. Whether every account, only admins or no one may publish a map or change a publication. Published maps stay public and can be unpublished. Null clears the stored value.
One of
everyone,admins,none,nullpublishing.embeddingstringor nullEmbedding on other sites. Which other sites may show a published page in a frame: any site, only the listed sites (at least one), or none. Null clears the stored value.
One of
any,listed,off,nullpublishing.embedSitesarray of stringor nullmax items50Listed sites. The sites that may show a published page in a frame while embedding is limited to listed sites; never empty while it is. Null clears the stored value. At most 50 sites, each http or https with a host and an optional port and nothing else. Each is kept as its scheme, host and port, a repeated site once; an empty list clears to the default.
(each item)stringpattern^\s*[Hh][Tt][Tt][Pp][Ss]?://[^/?#@\\\s]+/?\s*$
connections.createstringor nullWho may add database connections. Whether every account or only admins may add a database connection. Connections made earlier keep working. Null clears the stored value.
One of
everyone,admins,nullimports.linksstringor nullWho may import from links. Whether every account or only admins may import from web addresses and cloud storage. Link datasets keep refreshing. Null clears the stored value.
One of
everyone,admins,nullbasemaps.darkbooleanor nullDark. Whether Dark is offered where a basemap is chosen: the builder's picker, a published page's switcher and the Maps tab. Off, choosing it anew is refused; a map already on it keeps it. Auto keeps following the theme with it either way. Null clears the stored value.
basemaps.lightbooleanor nullLight. Whether Light is offered where a basemap is chosen: the builder's picker, a published page's switcher and the Maps tab. Off, choosing it anew is refused; a map already on it keeps it. Auto keeps following the theme with it either way. Null clears the stored value.
basemaps.streetsbooleanor nullStreets. Whether Streets is offered where a basemap is chosen: the builder's picker, a published page's switcher and the Maps tab. Off, choosing it anew is refused; a map already on it keeps it. Null clears the stored value.
basemaps.satellitebooleanor nullSatellite. Whether Satellite is offered, while imagery is set up, where a basemap is chosen: the builder's picker, a published page's switcher and the Maps tab. Off, choosing it anew is refused; a map already on it keeps it. Null clears the stored value.
basemaps.singleMapStylesbooleanor nullStyle addresses on single maps. Whether a map may take a style address the library does not offer. Off, such an address is refused on any map, for everyone, admins included; a map that holds one keeps it. Null clears the stored value.
templates.cataloguebooleanor nullUse the catalogue. Whether the server reads the template catalogue: its list, its pictures and its downloads. Off, it reaches the catalogue for nothing; shipped and downloaded templates still open and copy. Null clears the stored value.
No other keys.
7439201b