Get IP extraction security settings

GET

/api/admin/settings/ip-security

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/ip-security \
  --header 'Authorization: Bearer <token>'

Returns the configured cloud provider used for trusted client IP extraction and rate-limit safety.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

IP extraction security settings.

Media type application/json

object

settings

object

cloudProvider

object

value

Resolved setting value.

source

Source for the resolved setting.

string

default

Default value.

metadata

Setting metadata and validation constraints.

object

key

additional properties

description

string

min

number

max

number

validOptions

Array

key

additional properties

key

additional properties

availableProviders

Array<object>

Cloud provider IP extraction metadata.

object

key

additional properties

note

string

kv_key

string

key

additional properties

Example

{
  "settings": {
    "cloudProvider": {
      "value": "cloudflare",
      "source": "default",
      "default": "cloudflare",
      "description": "Cloud provider for trusted IP extraction",
      "info": {
        "name": "Cloudflare",
        "ipExtraction": "cf-connecting-ip"
      }
    }
  },
  "availableProviders": [
    {
      "value": "cloudflare",
      "name": "Cloudflare",
      "ipExtraction": "cf-connecting-ip"
    },
    {
      "value": "none",
      "name": "None",
      "ipExtraction": "request-ip",
      "warning": "Use only behind a trusted proxy."
    }
  ],
  "note": "Select your cloud provider to ensure correct client IP extraction for rate limiting. Incorrect configuration may allow IP spoofing attacks.",
  "kv_key": "cloud_provider"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}