| + +Browsers + + | + +`@octokit/app` is not meant for browser usage. + + |
|---|---|
| + +Node + + | + +Install with `npm install @octokit/app` + +```js +const { App, createNodeMiddleware } = require("@octokit/app"); +``` + + |
| + name + | ++ type + | ++ description + | +
|---|---|---|
+ appId
+ |
+
+ number
+ |
+ + Required. Find the App ID on the app’s about page in settings. + | +
+ privateKey
+ |
+
+ string
+ |
+
+ Required. Content of the *.pem file you downloaded from the app’s about page. You can generate a new private key if needed.
+ |
+
+ Octokit
+ |
+
+ Constructor
+ |
+ + +You can pass in your own Octokit constructor with custom defaults and plugins. Note that `authStrategy` will be always be set to `createAppAuth` from [`@octokit/auth-app`](https://github.com/octokit/auth-app.js). + +For usage with enterprise, set `baseUrl` to the hostname + `/api/v3`. Example: + +```js +const { Octokit } = require("@octokit/core"); +new App({ + appId: 123, + privateKey: "-----BEGIN PRIVATE KEY-----\n...", + oauth: { + clientId: 123, + clientSecret: "secret", + }, + webhooks: { + secret: "secret", + }, + Octokit: Octokit.defaults({ + baseUrl: "https://ghe.my-company.com/api/v3", + }), +}); +``` + +Defaults to [`@octokit/core`](https://github.com/octokit/core.js). + + |
+ log
+ |
+
+ object
+ |
+
+ Used for internal logging. Defaults to console.
+ |
+
+ webhooks.secret
+ |
+
+ string
+ |
+ + Required. Secret as configured in the GitHub App's settings. + | +
+ webhooks.transform
+ |
+
+ function
+ |
+ + Only relevant for `app.webhooks.on`. Transform emitted event before calling handlers. Can be asynchronous. + | +
+ oauth.clientId
+ |
+
+ number
+ |
+ + Find the OAuth Client ID on the app’s about page in settings. + | +
+ oauth.clientSecret
+ |
+
+ number
+ |
+ + Find the OAuth Client Secret on the app’s about page in settings. + | +
+ oauth.allowSignup
+ |
+
+ boolean
+ |
+
+ Sets the default value for app.oauth.getAuthorizationUrl(options).
+ |
+
| + name + | ++ type + | ++ description + | +
|---|---|---|
+ app
+ |
+
+ App instance
+ |
+ + Required. + | +
+ options.pathPrefix
+ |
+
+ string
+ |
+ + +All exposed paths will be prefixed with the provided prefix. Defaults to `"/api/github"` + + | +
+ log
+
+ object
+
+ |
+ + +Used for internal logging. Defaults to [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) with `debug` and `info` doing nothing. + + | +
| +Browsers + | + +Load `@octokit/auth-token` directly from [esm.sh](https://esm.sh) + +```html + +``` + + |
|---|---|
| +Node + |
+
+Install with npm install @octokit/auth-token
+
+```js
+import { createTokenAuth } from "@octokit/auth-token";
+```
+
+ |
| + name + | ++ type + | ++ description + | +
|---|---|---|
+ type
+ |
+
+ string
+ |
+
+ "token"
+ |
+
+ token
+ |
+
+ string
+ |
+ + The provided token. + | +
+ tokenType
+ |
+
+ string
+ |
+
+ Can be either "oauth" for personal access tokens and OAuth tokens, "installation" for installation access tokens (includes GITHUB_TOKEN provided to GitHub Actions), "app" for a GitHub App JSON Web Token, or "user-to-server" for a user authentication token through an app installation.
+ |
+
| +Browsers + |
+Load @octokit/core directly from esm.sh
+
+```html
+
+```
+
+ |
|---|---|
| +Node + |
+
+Install with npm install @octokit/core
+
+```js
+import { Octokit } from "@octokit/core";
+```
+
+ |
| + name + | ++ type + | ++ description + | +
|---|---|---|
+ options.authStrategy
+ |
+
+ Function |
+
+ Defaults to @octokit/auth-token. See Authentication below for examples.
+ |
+
+ options.auth
+ |
+
+ String or Object
+ |
+ + See Authentication below for examples. + | +
+ options.baseUrl
+ |
+
+ String
+ |
+ + +When using with GitHub Enterprise Server, set `options.baseUrl` to the root URL of the API. For example, if your GitHub Enterprise Server's hostname is `github.acme-inc.com`, then set `options.baseUrl` to `https://github.acme-inc.com/api/v3`. Example + +```js +const octokit = new Octokit({ + baseUrl: "https://github.acme-inc.com/api/v3", +}); +``` + + |
+ options.previews
+ |
+
+ Array of Strings
+ |
+ + +Some REST API endpoints require preview headers to be set, or enable +additional features. Preview headers can be set on a per-request basis, e.g. + +```js +octokit.request("POST /repos/{owner}/{repo}/pulls", { + mediaType: { + previews: ["shadow-cat"], + }, + owner, + repo, + title: "My pull request", + base: "main", + head: "my-feature", + draft: true, +}); +``` + +You can also set previews globally, by setting the `options.previews` option on the constructor. Example: + +```js +const octokit = new Octokit({ + previews: ["shadow-cat"], +}); +``` + + |
+ options.request
+ |
+
+ Object
+ |
+ + +Set a default request timeout (`options.request.timeout`) or an [`http(s).Agent`](https://nodejs.org/api/http.html#http_class_http_agent) e.g. for proxy usage (Node only, `options.request.agent`). + +There are more `options.request.*` options, see [`@octokit/request` options](https://github.com/octokit/request.js#request). `options.request` can also be set on a per-request basis. + + |
+ options.timeZone
+ |
+
+ String
+ |
+ + +Sets the `Time-Zone` header which defines a timezone according to the [list of names from the Olson database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + +```js +const octokit = new Octokit({ + timeZone: "America/Los_Angeles", +}); +``` + +The time zone header will determine the timezone used for generating the timestamp when creating commits. See [GitHub's Timezones documentation](https://developer.github.com/v3/#timezones). + + |
+ options.userAgent
+ |
+
+ String
+ |
+ + +A custom user agent string for your app or library. Example + +```js +const octokit = new Octokit({ + userAgent: "my-app/v1.2.3", +}); +``` + + |
| +Browsers + |
+Load @octokit/endpoint directly from esm.sh
+
+```html
+
+```
+
+ |
|---|---|
| +Node + |
+
+Install with npm install @octokit/endpoint
+
+```js
+import { endpoint } from "@octokit/endpoint";
+```
+
+ |
| + name + | ++ type + | ++ description + | +
|---|---|---|
+ route
+ |
+ + String + | +
+ If set, it has to be a string consisting of URL and the request method, e.g., GET /orgs/{org}. If it’s set to a URL, only the method defaults to GET.
+ |
+
+ options.method
+ |
+ + String + | +
+ Required unless route is set. Any supported http verb. Defaults to GET.
+ |
+
+ options.url
+ |
+ + String + | +
+ Required unless route is set. A path or full URL which may contain :variable or {variable} placeholders,
+ e.g., /orgs/{org}/repos. The url is parsed using url-template.
+ |
+
+ options.baseUrl
+ |
+ + String + | +
+ Defaults to https://api.github.com.
+ |
+
+ options.headers
+ |
+ + Object + | +
+ Custom headers. Passed headers are merged with defaults: + headers['user-agent'] defaults to octokit-endpoint.js/1.2.3 (where 1.2.3 is the released version).+ headers['accept'] defaults to application/vnd.github.v3+json.+ |
+
+ options.mediaType.format
+ |
+ + String + | +
+ Media type param, such as raw, diff, or text+json. See Media Types. Setting options.mediaType.format will amend the headers.accept value.
+ |
+
+ options.data
+ |
+ + Any + | +
+ Set request body directly instead of setting it to JSON based on additional parameters. See "The data parameter" below.
+ |
+
+ options.request
+ |
+ + Object + | +
+ Pass custom meta information for the request. The request object will be returned as is.
+ |
+
| + key + | ++ type + | ++ description + | +
|---|---|---|
method |
+ String | +The http method. Always lowercase. | +
url |
+ String | +The url with placeholders replaced with passed parameters. | +
headers |
+ Object | +All header names are lowercased. | +
body |
+ Any | +The request body if one is present. Only for PATCH, POST, PUT, DELETE requests. |
+
request |
+ Object | +Request meta option, it will be returned as it was passed into endpoint() |
+