API Reference

User

Security

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get User Security Settings

$ nirvana user:security get

GET/v1/user/security

Get the current user’s security settings

ReturnsExpand Collapse

user_security: object { source_ip_rule, created_at, updated_at }

User security settings response.

source_ip_rule: object { allowed, blocked }

IP filter rules.

allowed: array of string

List of IPv4 CIDR addresses to allow.

blocked: array of string

List of IPv4 CIDR addresses to deny.

created_at: optional string

When the user security settings were created.

updated_at: optional string

When the user security settings were updated.

Get User Security Settings

CLI Tool

HTTP

TypeScript

Go

Terraform

CLI Tool

nirvana user:security get \
  --api-key 'My API Key'

200 example

{
  "source_ip_rule": {
    "allowed": [
      "192.168.1.0/24",
      "10.0.0.0/8"
    ],
    "blocked": [
      "192.168.1.100/32"
    ]
  },
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Returns Examples

200 example

{
  "source_ip_rule": {
    "allowed": [
      "192.168.1.0/24",
      "10.0.0.0/8"
    ],
    "blocked": [
      "192.168.1.100/32"
    ]
  },
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}