Skip to main content

This version of GitHub Enterprise Server was discontinued on 2024-09-25. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.

The REST API is now versioned. For more information, see "About API versioning."

REST API endpoints for enterprise licenses

Use the REST API to retrieve information about your Enterprise license.

These endpoints are only available to authenticated site administrators. Normal users will receive a 404 response.

Note

These endpoints only support authentication using a personal access token (classic). For more information, see "Managing your personal access tokens."

Get license information

Fine-grained access tokens for "Get license information"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

HTTP response status codes for "Get license information"

Status codeDescription
200

OK

Code samples for "Get license information"

Request example

get/enterprise/settings/license
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/settings/license

Response

Status: 200
{ "seats": 1400, "seats_used": 1316, "seats_available": 84, "kind": "standard", "days_until_expiration": 365, "expire_at": "2016/02/06 12:41:52 -0600" }