Dry Run Configuration
POST
/config-ops/dry-run/
const url = 'https://example.com/api/config-ops/dry-run/?mode=merge';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"settings":{},"oauth_providers":[{}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Request Body required
Section titled “Request Body required ” Media type application/json
ConfigImportRequest
Payload for importing configuration.
object
oauth_providers
Any of:
Array<object>
object
key
additional properties
any
null
Example generated
{ "settings": {}, "oauth_providers": [ {} ]}Responses
Section titled “ Responses ”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": {}}Bad request — invalid query parameters or payload
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Unauthorized — missing or invalid credentials
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Forbidden — caller lacks access to this resource
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Not found
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Validation error
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}Internal server error
ProblemDetail
object
type
Type
string
title
required
Title
string
status
required
Status
integer
detail
required
Detail
string
Example
{ "type": "about:blank"}