# Get settings From **GitHub v3 REST API**. `GET /setup/api/settings` Get settings ## Responses ### `200` Response ### `application/json` - Type: `object` ```json { "enterprise": { "admin_password": null, "assets": null, "auth_mode": "default", "avatar": { "enabled": false, "uri": "" }, "cas": { "url": null }, "collectd": { "enabled": false, "encryption": null, "password": null, "port": 0, "server": null, "username": null }, "configuration_id": 1401777404, "configuration_run_count": 4, "customer": { "email": "stannis@themannis.biz", "name": "GitHub", "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n", "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n", "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9" }, "expire_sessions": false, "github_hostname": "ghe.local", "github_oauth": { "client_id": "12313412", "client_secret": "kj123131132", "organization_name": "Homestar Runners", "organization_team": "homestarrunners/characters" }, "github_ssl": { "cert": null, "enabled": false, "key": null }, "http_proxy": null, "identicons_host": "dotcom", "ldap": { "admin_group": null, "base": [], "bind_dn": null, "host": null, "method": "Plain", "password": null, "port": 0, "posix_support": true, "profile": { "key": null, "mail": null, "name": null, "uid": "uid" }, "reconciliation": { "org": null, "user": null }, "recursive_group_search": false, "search_strategy": "detect", "sync_enabled": false, "team_sync_interval": 4, "uid": null, "user_groups": [], "user_sync_emails": false, "user_sync_interval": 4, "user_sync_keys": false, "virtual_attribute_enabled": false }, "license": { "cluster_support": false, "evaluation": false, "expire_at": "2016-04-27T00:00:00-07:00", "perpetual": false, "seats": 0, "ssh_allowed": true, "support_key": "ssh-rsa AAAAB3N....", "unlimited_seating": true }, "load_balancer": null, "mapping": { "basemap": "company.map-qsz2zrvs", "enabled": true, "tileserver": null, "token": null }, "ntp": { "primary_server": "0.pool.ntp.org", "secondary_server": "1.pool.ntp.org" }, "pages": { "enabled": true }, "private_mode": false, "public_pages": false, "saml": { "certificate": null, "certificate_path": null, "disable_admin_demote": false, "idp_initiated_sso": false, "issuer": null, "sso_url": null }, "signup_enabled": false, "smtp": { "address": "smtp.example.com", "authentication": "plain", "discard-to-noreply-address": true, "domain": "blah", "enable_starttls_auto": true, "enabled": true, "noreply_address": "noreply@github.com", "password": "bar", "port": "1234", "support_address": "enterprise@github.com", "support_address_type": "email", "user_name": "mr_foo", "username": "foo" }, "snmp": { "community": "", "enabled": false }, "subdomain_isolation": true, "syslog": { "enabled": false, "protocol_name": "udp", "server": null }, "timezone": null }, "run_list": [ "recipe[enterprise-configure]" ] } ``` ```json {"properties":{"enterprise":{"properties":{"admin_password":{"nullable":true,"type":"string"},"assets":{"nullable":true,"type":"string"},"auth_mode":{"type":"string"},"avatar":{"properties":{"enabled":{"type":"boolean"},"uri":{"type":"string"}},"type":"object"},"cas":{"properties":{"url":{"nullable":true,"type":"string"}},"type":"object"},"collectd":{"properties":{"enabled":{"type":"boolean"},"encryption":{"nullable":true,"type":"string"},"password":{"nullable":true,"type":"string"},"port":{"type":"integer"},"server":{"nullable":true,"type":"string"},"username":{"nullable":true,"type":"string"}},"type":"object"},"configuration_id":{"type":"integer"},"configuration_run_count":{"type":"integer"},"customer":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"public_key_data":{"type":"string"},"secret_key_data":{"type":"string"},"uuid":{"type":"string"}},"type":"object"},"expire_sessions":{"type":"boolean"},"github_hostname":{"type":"string"},"github_oauth":{"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"organization_name":{"type":"string"},"organization_team":{"type":"string"}},"type":"object"},"github_ssl":{"properties":{"cert":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"},"key":{"nullable":true,"type":"string"}},"type":"object"},"http_proxy":{"nullable":true,"type":"string"},"identicons_host":{"type":"string"},"ldap":{"properties":{"admin_group":{"nullable":true,"type":"string"},"base":{"items":{},"type":"array"},"bind_dn":{"nullable":true,"type":"string"},"host":{"nullable":true,"type":"string"},"method":{"type":"string"},"password":{"nullable":true,"type":"string"},"port":{"type":"integer"},"posix_support":{"type":"boolean"},"profile":{"properties":{"key":{"nullable":true,"type":"string"},"mail":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"uid":{"type":"string"}},"type":"object"},"reconciliation":{"properties":{"org":{"nullable":true,"type":"string"},"user":{"nullable":true,"type":"string"}},"type":"object"},"recursive_group_search":{"type":"boolean"},"search_strategy":{"type":"string"},"sync_enabled":{"type":"boolean"},"team_sync_interval":{"type":"integer"},"uid":{"nullable":true,"type":"string"},"user_groups":{"items":{},"type":"array"},"user_sync_emails":{"type":"boolean"},"user_sync_interval":{"type":"integer"},"user_sync_keys":{"type":"boolean"},"virtual_attribute_enabled":{"type":"boolean"}},"type":"object"},"license":{"properties":{"cluster_support":{"type":"boolean"},"evaluation":{"type":"boolean"},"expire_at":{"type":"string"},"perpetual":{"type":"boolean"},"seats":{"type":"integer"},"ssh_allowed":{"type":"boolean"},"support_key":{"type":"string"},"unlimited_seating":{"type":"boolean"}},"type":"object"},"load_balancer":{"nullable":true,"type":"string"},"mapping":{"properties":{"basemap":{"type":"string"},"enabled":{"type":"boolean"},"tileserver":{"nullable":true,"type":"string"},"token":{"nullable":true,"type":"string"}},"type":"object"},"ntp":{"properties":{"primary_server":{"type":"string"},"secondary_server":{"type":"string"}},"type":"object"},"pages":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"private_mode":{"type":"boolean"},"public_pages":{"type":"boolean"},"saml":{"properties":{"certificate":{"nullable":true,"type":"string"},"certificate_path":{"nullable":true,"type":"string"},"disable_admin_demote":{"type":"boolean"},"idp_initiated_sso":{"type":"boolean"},"issuer":{"nullable":true,"type":"string"},"sso_url":{"nullable":true,"type":"string"}},"type":"object"},"signup_enabled":{"type":"boolean"},"smtp":{"properties":{"address":{"type":"string"},"authentication":{"type":"string"},"discard-to-noreply-address":{"type":"boolean"},"domain":{"type":"string"},"enable_starttls_auto":{"type":"boolean"},"enabled":{"type":"boolean"},"noreply_address":{"type":"string"},"password":{"type":"string"},"port":{"type":"string"},"support_address":{"type":"string"},"support_address_type":{"type":"string"},"user_name":{"type":"string"},"username":{"type":"string"}},"type":"object"},"snmp":{"properties":{"community":{"type":"string"},"enabled":{"type":"boolean"}},"type":"object"},"subdomain_isolation":{"type":"boolean"},"syslog":{"properties":{"enabled":{"type":"boolean"},"protocol_name":{"type":"string"},"server":{"nullable":true,"type":"string"}},"type":"object"},"timezone":{"nullable":true,"type":"string"}},"type":"object"},"run_list":{"items":{"type":"string"},"type":"array"}},"type":"object"} ``` ## Request examples ### cURL ```shell curl --request GET \ --url {protocol}://{hostname}/api/v3/setup/api/settings ```