Ctrlk
BlogSupport
For the complete documentation index, see llms.txt. This page is also available as Markdown.

System Management

APIs for system management

Get roles

post

Retrieve information about one or more roles created in your environment.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
Responses
200

OK

post/public_api/v1/rbac/get_roles
POST /public_api/v1/rbac/get_roles HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "request_data": {
    "role_names": [
      "text"
    ]
  }
}
{
  "reply": [
    {
      "pretty_name": "text",
      "permissions": [
        "text"
      ],
      "insert_time": 1,
      "update_time": 1,
      "created_by": "text",
      "description": "text",
      "groups": [
        "text"
      ],
      "users": [
        "text"
      ]
    }
  ]
}

Get user groups

post

Retrieve a list of the current user emails associated with one or more user groups in your environment.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
Responses
200

OK

post/public_api/v1/rbac/get_user_group
POST /public_api/v1/rbac/get_user_group HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "request_data": {
    "group_names": [
      "text"
    ]
  }
}
{
  "reply": [
    {
      "group_name": "text",
      "description": "text",
      "pretty_name": "text",
      "insert_time": 1,
      "update_time": 1,
      "user_email": [
        "text"
      ],
      "source": "text"
    }
  ]
}

Get users

post

Retrieve a list of the current users in your environment.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
objectOptional
Responses
200

OK

post/public_api/v1/rbac/get_users
POST /public_api/v1/rbac/get_users HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "reply": [
    {
      "user_email": "text",
      "user_first_name": "text",
      "user_last_name": "text",
      "role_name": "text",
      "last_logged_in": 1,
      "user_type": "text",
      "groups": [
        "text"
      ],
      "scope": [
        "text"
      ]
    }
  ]
}

Set a user role

post

Add or remove one or more users from a role.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
Responses
200

OK

post/public_api/v1/rbac/set_user_role
POST /public_api/v1/rbac/set_user_role HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "request_data": {
    "user_emails": [
      "text"
    ],
    "role_name": "text"
  }
}
{
  "reply": {
    "update_count": "text"
  }
}

Get System Health Metrics

post

Retrieves system health metrics snapshots for the tenant. Each snapshot contains node metrics, component statuses, storage usage, queue depths, and external connectivity information.

By default, returns data from the last 24 hours. Snapshots are ordered by timestamp descending (most recent first).

Note: This endpoint is supported in XSOAR 8.13 On-prem and later.

Header parameters
authorizationstringRequired

api_key

Example: {your_api_key}
x-xdr-auth-idstringRequired

api_key_id

Example: 1
Responses
200

Successful response containing system diagnostics snapshots.

application/json
post/public_api/v1/system_diagnostics/data/papi/
POST /public_api/v1/system_diagnostics/data/papi/ HTTP/1.1
Host: api-yourfqdn
authorization: {your_api_key}
x-xdr-auth-id: 1
Accept: */*

{
  "reply": {
    "results": [
      {
        "timestamp": "2024-10-27T10:00:00Z",
        "nodes": [
          {
            "name": "ip-10-0-1-5",
            "cpu_usage": 15.5,
            "memory_usage": 42.1,
            "os_disk_usage": 25,
            "connected": true
          },
          {
            "name": "ip-10-0-1-6",
            "cpu_usage": 22.3,
            "memory_usage": 55,
            "os_disk_usage": 30,
            "connected": true
          }
        ],
        "cluster_disk_usage": 35.2,
        "components": {
          "API": "HEALTHY",
          "Databases": "HEALTHY",
          "External Gateways": "WARNING",
          "Playbook Engines": "HEALTHY",
          "Automation Layer": "HEALTHY",
          "System Scheduler": "HEALTHY",
          "System Orchestrators": "HEALTHY",
          "Execution Environments": "HEALTHY",
          "Telemetry": "HEALTHY",
          "Storage": "HEALTHY"
        },
        "storage": {
          "Relational DB": 45,
          "Object Storage": 12.5,
          "Cache": 60.2,
          "Queue": 1.64,
          "Content": 3.04,
          "Document DB": 9.51,
          "Automation Layer": 1.54,
          "Execution Environments": 5.4
        },
        "queues": {
          "Manual": 0,
          "Automated": 12
        },
        "connectivity": {
          "connected": true,
          "since": "2024-10-20T08:00:00Z",
          "error": null
        }
      }
    ]
  }
}
PreviousSyslog Servers
NextWidgets

Last updated

Was this helpful?