---
title: "Get a list of servers"
method: GET
path: "/server"
tags: ["Server"]
---

# Get a list of servers

`GET /server`

## Request

- Base URL: `/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/server`
- Auth: none declared. Required headers: `X-Auth-Token`
- TypeScript: <https://skmtc.dev/neuvector/apis/neuvector-api/docs/server/get.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `X-Auth-Token` string, required

## Response `200`

Success

- RESTServersData
  - `servers` RESTServer[], required
    - `server_name` string, required
    - `server_type` string, required
    - `ldap` RESTServerLDAP
      - `directory` string, required
      - `hostname` string, required
      - `port` integer, required
      - `ssl` boolean, required
      - `base_dn` string, required
      - `bind_dn` string, required
      - `bind_password` string
      - `group_member_attr` string, required
      - `username_attr` string, required
      - `enable` boolean, required
      - `default_role` string, required
      - `role_groups` object
        - `role` string
        - `groups` string[]
      - `group_mapped_roles` GroupRoleMapping[]
        - `group` string, required
        - `global_role` string, required
        - `role_domains` object
          - `role` string
          - `domains` string[]
    - `saml` RESTServerSAML
      - `sso_url` string, required
      - `issuer` string, required
      - `x509_cert` string
      - `group_claim` string, required
      - `enable` boolean, required
      - `default_role` string, required
      - `role_groups` object
        - `role` string
        - `groups` string[]
      - `group_mapped_roles` GroupRoleMapping[]
        - `group` string, required
        - `global_role` string, required
        - `role_domains` object
          - `role` string
          - `domains` string[]
    - `oidc` RESTServerOIDC
      - `issuer` string, required
      - `authorization_endpoint` string, required
      - `token_endpoint` string, required
      - `user_info_endpoint` string, required
      - `client_id` string, required
      - `ClientSecret` string
      - `group_claim` string, required
      - `scopes` string[], required
      - `enable` boolean, required
      - `default_role` string, required
      - `role_groups` object
        - `role` string
        - `groups` string[]
      - `group_mapped_roles` GroupRoleMapping[]
        - `group` string, required
        - `global_role` string, required
        - `role_domains` object
          - `role` string
          - `domains` string[]
  - `mappable_role` RESTMappableRoles
    - `default_roles` string[], required
    - `group_roles` string[], required
    - `group_domain_roles` string[], required

---

[API](https://skmtc.dev/neuvector/apis/neuvector-api.md) - [All operations](https://skmtc.dev/neuvector/apis/neuvector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/neuvector/apis/neuvector-api/revisions/b8d8d28840b3?raw)