Validate Configuration

POST

/config-ops/validate/

const url = 'https://example.com/api/config-ops/validate/';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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/validate/ \
  --header 'Authorization: Bearer <token>'

Validate connectivity to storage, cache, and all enabled OIDC providers.

Returns pass/fail with latency and error details for each service.

Authorizations

OAuth2PasswordBearer

Responses

200

Successful Response

application/json

ConnectivityResult

Aggregate connectivity validation result.

object

storage

required

ServiceProbeResult

Object storage probe result.

object

name

required

Name

Service name (e.g. ‘storage’, ‘cache’, ‘oidc:google’).

string

status

required

Status

Probe outcome.

string

Allowed values: ok error

latency_ms

required

Latency Ms

Round-trip latency in milliseconds.

number

error

Any of:

string
null

string

cache

required

ServiceProbeResult

Cache backend probe result.

object

name

required

Name

Service name (e.g. ‘storage’, ‘cache’, ‘oidc:google’).

string

status

required

Status

Probe outcome.

string

Allowed values: ok error

latency_ms

required

Latency Ms

Round-trip latency in milliseconds.

number

error

Any of:

string
null

string

oidc_providers

required

Oidc Providers

Per-provider OIDC discovery probe results, keyed by provider slug.

object

key

additional properties

ServiceProbeResult

Result of a single service connectivity probe.

object

name

required

Name

Service name (e.g. ‘storage’, ‘cache’, ‘oidc:google’).

string

status

required

Status

Probe outcome.

string

Allowed values: ok error

latency_ms

required

Latency Ms

Round-trip latency in milliseconds.

number

error

Any of:

string
null

string

Example

{
  "storage": {
    "status": "ok"
  },
  "cache": {
    "status": "ok"
  },
  "oidc_providers": {
    "additionalProperty": {
      "status": "ok"
    }
  }
}