Octokit plugin for GitHub Enterprise Server REST APIs
@octokit/rest
and the @octokit/plugin-rest-endpoint-methods
plugin it's using internally do not include methods for Enterprise Administration as they do not exist on https://api.github.com. This plugin adds endpoint methods for very GitHub Enterprise Server version that is currently supported.
Besides the admin-specific endpoints, there are differences between api.github.com
and each GitHub Enterprise Server version. Instead of loading @octokit/plugin-rest-endpoint-methods
you can optionally add all endpoint methods for each GitHub Enterprise Server version, including the admin endpoints.
Browsers |
Load <script type="module">
import { Octokit } from "https://cdn.skypack.dev/@octokit/core";
import { enterpriseServer220Admin } from "https://cdn.skypack.dev/@octokit/plugin-enterprise-server";
</script> |
---|---|
Node |
Install with const { Octokit } = require("@octokit/core");
const {
enterpriseServer32Admin,
} = require("@octokit/plugin-enterprise-server"); |
const OctokitEnterprise32 = Octokit.plugin(enterpriseServer32Admin);
const octokit = new OctokitEnterprise32({
auth: "secret123",
baseUrl: "https://github.acme-inc.com/api/v3",
});
octokit.enterpriseAdmin.createUser({
username: "octocat",
email: "[email protected]",
});
The list of currently exported plugins are
enterpriseServer32Admin
enterpriseServer32
enterpriseServer33Admin
enterpriseServer33
enterpriseServer34Admin
enterpriseServer34
enterpriseServer35Admin
enterpriseServer35
enterpriseServer36Admin
enterpriseServer36
The route definitions for the currently supported GitHub Enterprise versions are build automatically from @octokit/openapi
. Each time there is a new @octokit/openapi
release, the .github/workflows/update.yml
workflow is triggered. If an update is found, a pull request is created.