Skip to content
getgeolens.com
GeoLens Docs

Import Configuration

POST
/config-ops/import/
 
curl --request POST \
  --url 'https://example.com/api/config-ops/import/?mode=merge' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "settings": {}, "oauth_providers": [ {} ] }'

Import configuration in merge or overwrite mode.

Merge mode: updates existing settings and OAuth providers, adds new ones. Overwrite mode: replaces all settings and OAuth providers.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
mode
Mode
string
default: merge
Allowed values: merge overwrite

Request Body required

Section titled “Request Body required ”
Media type application/json
ConfigImportRequest

Payload for importing configuration.

object
settings
Any of:
object
key
additional properties
any
oauth_providers
Any of:
Array<object>
object
key
additional properties
any
Example generated
{
  "settings": {},
  "oauth_providers": [
    {}
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
ImportResult

Summary of what was applied during an import.

object
settings_applied
required
Settings Applied

Number of settings successfully updated.

integer
settings_skipped
required
Settings Skipped

Number of settings skipped (no change or unknown key).

integer
oauth_created
required
Oauth Created

Number of new OAuth providers created.

integer
oauth_updated
required
Oauth Updated

Number of existing OAuth providers updated.

integer
oauth_deleted
required
Oauth Deleted

Number of OAuth providers deleted (overwrite mode only).

integer
Example generated
{
  "settings_applied": 1,
  "settings_skipped": 1,
  "oauth_created": 1,
  "oauth_updated": 1,
  "oauth_deleted": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}