Skip to content
getgeolens.com

Import Configuration

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

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.

mode
Mode
string
default: merge
Allowed values: merge overwrite
Media type application/json
ConfigImportRequest

Payload for importing configuration.

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

Successful Response

Media type application/json
ImportResult

Summary of what was applied during an import.

object
oauth_created
required
Oauth Created

Number of new OAuth providers created.

integer
oauth_deleted
required
Oauth Deleted

Number of OAuth providers deleted (overwrite mode only).

integer
oauth_updated
required
Oauth Updated

Number of existing OAuth providers updated.

integer
settings_applied
required
Settings Applied

Number of settings successfully updated.

integer
settings_skipped
required
Settings Skipped

Number of settings skipped (no change, unknown key, or enterprise-only key in community edition).

integer
settings_skipped_enterprise
Settings Skipped Enterprise

Names of enterprise-only setting keys that were skipped because the caller is on the community edition (BUG-011). Empty on enterprise edition.

Array<string>
Example generated
{
"oauth_created": 1,
"oauth_deleted": 1,
"oauth_updated": 1,
"settings_applied": 1,
"settings_skipped": 1,
"settings_skipped_enterprise": [
"example"
]
}

Bad request — invalid query parameters or payload

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Unauthorized — missing or invalid credentials

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Forbidden — caller lacks access to this resource

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Not found

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Validation error

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Internal server error

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}