Skip to content
getgeolens.com
GeoLens Docs

Dry Run Configuration

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

Preview what an import would change without applying any modifications.

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
DryRunResponse

Result of a dry-run import showing what would change.

object
settings
required
Settings

Per-setting diff result keyed by setting name.

object
key
additional properties
any
oauth_providers
required
Oauth Providers

Per-provider diff result keyed by slug.

object
key
additional properties
any
Example generated
{
  "settings": {},
  "oauth_providers": {}
}

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": {}
    }
  ]
}