---
title: "Get settings"
method: GET
path: "/setup/api/settings"
tags: ["enterprise-admin"]
---

# Get settings

`GET /setup/api/settings`

Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/management-console#set-settings).

**Note:** You cannot retrieve the management console password with the Enterprise administration API.

## Response `200`

Response

- EnterpriseSettings
  - `enterprise` object
    - `private_mode` boolean
    - `public_pages` boolean
    - `subdomain_isolation` boolean
    - `signup_enabled` boolean
    - `github_hostname` string
    - `identicons_host` string
    - `http_proxy` string, nullable
    - `auth_mode` string
    - `expire_sessions` boolean
    - `admin_password` string, nullable
    - `configuration_id` integer
    - `configuration_run_count` integer
    - `avatar` object
      - `enabled` boolean
      - `uri` string
    - `customer` object
      - `name` string
      - `email` string
      - `uuid` string
      - `secret_key_data` string
      - `public_key_data` string
    - `license` object
      - `seats` integer
      - `evaluation` boolean
      - `perpetual` boolean
      - `unlimited_seating` boolean
      - `support_key` string
      - `ssh_allowed` boolean
      - `cluster_support` boolean
      - `expire_at` string
    - `github_ssl` object
      - `enabled` boolean
      - `cert` string, nullable
      - `key` string, nullable
    - `ldap` object
      - `host` string, nullable
      - `port` integer
      - `base` unknown[]
        - unknown
      - `uid` string, nullable
      - `bind_dn` string, nullable
      - `password` string, nullable
      - `method` string
      - `search_strategy` string
      - `user_groups` unknown[]
        - unknown
      - `admin_group` string, nullable
      - `virtual_attribute_enabled` boolean
      - `recursive_group_search` boolean
      - `posix_support` boolean
      - `user_sync_emails` boolean
      - `user_sync_keys` boolean
      - `user_sync_interval` integer
      - `team_sync_interval` integer
      - `sync_enabled` boolean
      - `reconciliation` object
        - `user` string, nullable
        - `org` string, nullable
      - `profile` object
        - `uid` string
        - `name` string, nullable
        - `mail` string, nullable
        - `key` string, nullable
    - `cas` object
      - `url` string, nullable
    - `saml` object
      - `sso_url` string, nullable
      - `certificate` string, nullable
      - `certificate_path` string, nullable
      - `issuer` string, nullable
      - `idp_initiated_sso` boolean
      - `disable_admin_demote` boolean
    - `github_oauth` object
      - `client_id` string
      - `client_secret` string
      - `organization_name` string
      - `organization_team` string
    - `smtp` object
      - `enabled` boolean
      - `address` string
      - `authentication` string
      - `port` string
      - `domain` string
      - `username` string
      - `user_name` string
      - `enable_starttls_auto` boolean
      - `password` string
      - `discard-to-noreply-address` boolean
      - `support_address` string
      - `support_address_type` string
      - `noreply_address` string
    - `ntp` object
      - `primary_server` string
      - `secondary_server` string
    - `timezone` string, nullable
    - `snmp` object
      - `enabled` boolean
      - `community` string
    - `syslog` object
      - `enabled` boolean
      - `server` string, nullable
      - `protocol_name` string
    - `assets` string, nullable
    - `pages` object
      - `enabled` boolean
    - `collectd` object
      - `enabled` boolean
      - `server` string, nullable
      - `port` integer
      - `encryption` string, nullable
      - `username` string, nullable
      - `password` string, nullable
    - `mapping` object
      - `enabled` boolean
      - `tileserver` string, nullable
      - `basemap` string
      - `token` string, nullable
    - `load_balancer` string, nullable
  - `run_list` string[]

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/github/apis/github-v3-rest-api-5.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api-5/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api-5/versions/50ae54440071/schema)