Get settings

GET/setup/api/settings

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Responses

application/json enterprise-settings object

Response

enterprise object

optional

admin_password string

optionalnullable

assets string

optionalnullable

auth_mode string

optional

avatar object

optional

enabled boolean

optional

uri string

optional

cas object

optional

url string

optionalnullable

collectd object

optional

enabled boolean

optional

encryption string

optionalnullable

password string

optionalnullable

port integer

optional

server string

optionalnullable

username string

optionalnullable

configuration_id integer

optional

configuration_run_count integer

optional

customer object

optional

email string

optional

name string

optional

public_key_data string

optional

secret_key_data string

optional

uuid string

optional

expire_sessions boolean

optional

github_hostname string

optional

github_oauth object

optional

client_id string

optional

client_secret string

optional

organization_name string

optional

organization_team string

optional

github_ssl object

optional

cert string

optionalnullable

enabled boolean

optional

key string

optionalnullable

http_proxy string

optionalnullable

identicons_host string

optional

ldap object

optional

admin_group string

optionalnullable

base array

optional

bind_dn string

optionalnullable

host string

optionalnullable

method string

optional

password string

optionalnullable

port integer

optional

posix_support boolean

optional

profile object

optional

key string

optionalnullable

mail string

optionalnullable

name string

optionalnullable

uid string

optional

reconciliation object

optional

org string

optionalnullable

user string

optionalnullable

recursive_group_search boolean

optional

search_strategy string

optional

sync_enabled boolean

optional

team_sync_interval integer

optional

uid string

optionalnullable

user_groups array

optional

user_sync_emails boolean

optional

user_sync_interval integer

optional

user_sync_keys boolean

optional

virtual_attribute_enabled boolean

optional

license object

optional

cluster_support boolean

optional

evaluation boolean

optional

expire_at string

optional

perpetual boolean

optional

seats integer

optional

ssh_allowed boolean

optional

support_key string

optional

unlimited_seating boolean

optional

load_balancer string

optionalnullable

mapping object

optional

basemap string

optional

enabled boolean

optional

tileserver string

optionalnullable

token string

optionalnullable

ntp object

optional

primary_server string

optional

secondary_server string

optional

pages object

optional

enabled boolean

optional

private_mode boolean

optional

public_pages boolean

optional

saml object

optional

certificate string

optionalnullable

certificate_path string

optionalnullable

disable_admin_demote boolean

optional

idp_initiated_sso boolean

optional

issuer string

optionalnullable

sso_url string

optionalnullable

signup_enabled boolean

optional

smtp object

optional

address string

optional

authentication string

optional

discard-to-noreply-address boolean

optional

domain string

optional

enable_starttls_auto boolean

optional

enabled boolean

optional

noreply_address string

optional

password string

optional

port string

optional

support_address string

optional

support_address_type string

optional

user_name string

optional

username string

optional

snmp object

optional

community string

optional

enabled boolean

optional

subdomain_isolation boolean

optional

syslog object

optional

enabled boolean

optional

protocol_name string

optional

server string

optionalnullable

timezone string

optionalnullable

run_list array[string]

optional

Response Example: 200 application/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": "[email protected]",
      "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": "[email protected]",
      "password": "bar",
      "port": "1234",
      "support_address": "[email protected]",
      "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]"
  ]
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/setup/api/settings