GitHub Enterprise Cloud

https://docs.github.com/en/enterprise-cloud@latest/
Admin
GitHub Enterprise Cloud is a comprehensive platform providing tools for collaborative software...
Tokens:7,245,895
Snippets:50,318
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example response for getting an installation

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/apps/apps

Shows the 200 OK response body returned by the endpoint. The response includes installation details such as account, permissions, events, and repository selection.

```json
Status: 200
{
  "id": 1,
  "account": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
  "repositories_url": "https://api.github.com/installation/repositories",
  "html_url": "https://github.com/organizations/github/settings/installations/1",
  "app_id": 1,
  "target_id": 1,
  "target_type": "Organization",
  "permissions": {
    "checks": "write",
    "metadata": "read",
    "contents": "read"
  },
  "events": [
    "push",
    "pull_request"
  ],
  "single_file_name": "config.yaml",
  "has_multiple_single_files": true,
  "single_file_paths": [
    "config.yml",
    ".github/issue_TEMPLATE.md"
  ],
  "repository_selection": "selected",
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "app_slug": "github-actions",
  "suspended_at": null,
  "suspended_by": null
}
```

--------------------------------

### Install a specific plugin example

Source: https://docs.github.com/en/enterprise-cloud%40latest/copilot/how-tos/copilot-cli/customize-copilot/plugins-finding-installing

Example command to install the database-data-management plugin from the awesome-copilot marketplace.

```shell
copilot plugin install database-data-management@awesome-copilot
```

--------------------------------

### Example response for Get an organization installation

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/apps/apps

The successful response returns a 200 status code and a JSON object containing the installation details.

```json
Status: 200
{
  "id": 1,
  "account": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "avatar_url": "https://github.com/images/error/hubot_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/orgs/github",
    "html_url": "https://github.com/github",
    "followers_url": "https://api.github.com/users/github/followers",
    "following_url": "https://api.github.com/users/github/following{/other_user}",
    "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/github/subscriptions",
    "organizations_url": "https://api.github.com/users/github/orgs",
    "repos_url": "https://api.github.com/orgs/github/repos",
    "events_url": "https://api.github.com/orgs/github/events",
    "received_events_url": "https://api.github.com/users/github/received_events",
    "type": "Organization",
    "site_admin": false
  },
  "repository_selection": "all",
  "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
  "repositories_url": "https://api.github.com/installation/repositories",
  "html_url": "https://github.com/organizations/github/settings/installations/1",
  "app_id": 1,
  "client_id": "Iv1.ab1112223334445c",
  "target_id": 1,
  "target_type": "Organization",
  "permissions": {
    "checks": "write",
    "metadata": "read",
    "contents": "read"
  },
  "events": [
    "push",
    "pull_request"
  ],
  "created_at": "2018-02-09T20:51:14Z",
  "updated_at": "2018-02-09T20:51:14Z",
  "single_file_name": "config.yml",
  "has_multiple_single_files": true,
  "single_file_paths": [
    "config.yml",
    ".github/issue_TEMPLATE.md"
  ],
  "app_slug": "github-actions",
  "suspended_at": null,
  "suspended_by": null
}
```

--------------------------------

### Example response for listing user installations

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/apps/installations

Example response with status 200. The permissions for each installation are under the 'permissions' key. Shows the structure of the installations array.

```json
{
  "total_count": 2,
  "installations": [
    {
      "id": 1,
      "account": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
      "repositories_url": "https://api.github.com/installation/repositories",
      "html_url": "https://github.com/organizations/github/settings/installations/1",
      "app_id": 1,
      "target_id": 1,
      "target_type": "Organization",
      "permissions": {
        "checks": "write",
        "metadata": "read",
        "contents": "read"
      },
      "events": [
        "push",
        "pull_request"
      ],
      "single_file_name": "config.yaml",
      "has_multiple_single_files": true,
      "single_file_paths": [
        "config.yml",
        ".github/issue_TEMPLATE.md"
      ],
      "repository_selection": "all",
      "created_at": "2017-07-08T16:18:44-04:00",
      "updated_at": "2017-07-08T16:18:44-04:00",
      "app_slug": "github-actions",
      "suspended_at": null,
      "suspended_by": null
    },
    {
      "id": 3,
      "account": {
        "login": "octocat",
        "id": 2,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
      "repositories_url": "https://api.github.com/installation/repositories",
      "html_url": "https://github.com/organizations/github/settings/installations/1",
      "app_id": 1,
      "target_id": 1,
      "target_type": "Organization",
      "permissions": {
        "checks": "write",
        "metadata": "read",
        "contents": "read"
      },
      "events": [
        "push",
        "pull_request"
      ],
      "single_file_name": "config.yaml",
      "has_multiple_single_files": true,
      "single_file_paths": [
        "config.yml",
        ".github/issue_TEMPLATE.md"
      ],
      "repository_selection": "all",
      "created_at": "2017-07-08T16:18:44-04:00",
      "updated_at": "2017-07-08T16:18:44-04:00",
      "app_slug": "github-actions",
      "suspended_at": null,
      "suspended_by": null
    }
  ]
}
```

--------------------------------

### JavaScript example: Install dependencies

Source: https://docs.github.com/en/enterprise-cloud%40latest/webhooks/using-webhooks/handling-webhook-deliveries

Defines the port for the server and starts it listening. The port is set to 3000 to match the webhook forwarding port.

```javascript
// This defines the port where your server should listen.
// 3000 matches the port that you specified for webhook forwarding. For more information, see [Forward webhooks](#forward-webhooks).
//
// Once you deploy your code to a server, you should change this to match the port where your server is listening.
const port = 3000;

// This starts the server and tells it to listen at the specified port.
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});
```

--------------------------------

### Example response for listing app installations

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/apps/installations?apiVersion=2022-11-28

Example response showing a 200 status and a JSON object with total_count and installations array. Each installation includes account details, permissions, events, and repository selection.

```http
Status: 200
```

```json
{
  "total_count": 2,
  "installations": [
    {
      "id": 1,
      "account": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
      "repositories_url": "https://api.github.com/installation/repositories",
      "html_url": "https://github.com/organizations/github/settings/installations/1",
      "app_id": 1,
      "target_id": 1,
      "target_type": "Organization",
      "permissions": {
        "checks": "write",
        "metadata": "read",
        "contents": "read"
      },
      "events": [
        "push",
        "pull_request"
      ],
      "single_file_name": "config.yaml",
      "has_multiple_single_files": true,
      "single_file_paths": [
        "config.yml",
        ".github/issue_TEMPLATE.md"
      ],
      "repository_selection": "all",
      "created_at": "2017-07-08T16:18:44-04:00",
      "updated_at": "2017-07-08T16:18:44-04:00",
      "app_slug": "github-actions",
      "suspended_at": null,
      "suspended_by": null
    },
    {
      "id": 3,
      "account": {
        "login": "octocat",
        "id": 2,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
      "repositories_url": "https://api.github.com/installation/repositories",
      "html_url": "https://github.com/organizations/github/settings/installations/1",
      "app_id": 1,
      "target_id": 1,
      "target_type": "Organization",
      "permissions": {
        "checks": "write",
        "metadata": "read",
        "contents": "read"
      },
      "events": [
        "push",
        "pull_request"
      ],
      "single_file_name": "config.yaml",
      "has_multiple_single_files": true,
      "single_file_paths": [
        "config.yml",
        ".github/issue_TEMPLATE.md"
      ],
      "repository_selection": "all",
      "created_at": "2017-07-08T16:18:44-04:00",
      "updated_at": "2017-07-08T16:18:44-04:00",
      "app_slug": "github-actions",
      "suspended_at": null,
      "suspended_by": null
    }
  ]
}
```

--------------------------------

### Example response for Get a code quality setup configuration

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/code-quality/code-quality

Example response with status 200 showing a configured state, languages, runner type, schedule, and AI findings option.

```json
{
  "state": "configured",
  "languages": [
    "javascript-typescript",
    "python"
  ],
  "runner_type": "standard",
  "runner_label": null,
  "updated_at": "2023-01-01T00:00:00Z",
  "schedule": "weekly",
  "ai_findings_option": "on_push"
}
```

--------------------------------

### List installation requests example response

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/apps/apps

Example JSON response body for a successful request to list installation requests.

```json
[
   {
     "id": 25381,
     "node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==",
     "account": {
       "login": "octo-org",
       "id": 6811672,
       "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
       "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
       "gravatar_id": "",
       "url": "https://api.github.com/users/octo-org",
       "html_url": "https://github.com/octo-org",
       "followers_url": "https://api.github.com/users/octo-org/followers",
       "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
       "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
       "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
       "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
       "organizations_url": "https://api.github.com/users/octo-org/orgs",
       "repos_url": "https://api.github.com/users/octo-org/repos",
       "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
       "received_events_url": "https://api.github.com/users/octo-org/received_events",
       "type": "Organization",
       "site_admin": false
     },
     "requester": {
       "id": 1,
       "node_id": "MDQ6VXNlcjE=",
       "avatar_url": "https://github.com/images/error/octocat_happy.gif",
       "gravatar_id": "",
       "url": "https://api.github.com/users/octocat",
       "html_url": "https://github.com/octocat",
       "followers_url": "https://api.github.com/users/octocat/followers",
       "following_url": "https://api.github.com/users/octocat/following{/other_user}",
       "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
       "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
       "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
       "organizations_url": "https://api.github.com/users/octocat/orgs",
       "repos_url": "https://api.github.com/users/octocat/repos",
       "events_url": "https://api.github.com/users/octocat/events{/privacy}",
       "received_events_url": "https://api.github.com/users/octocat/received_events",
       "type": "User",
       "site_admin": false
     },
     "created_at": "2022-07-08T16:18:44-04:00"
   }
 ]
```

--------------------------------

### JavaScript example: Start server

Source: https://docs.github.com/en/enterprise-cloud%40latest/webhooks/using-webhooks/handling-webhook-deliveries

Starts the server and tells it to listen on the specified port.

```javascript
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});
```

--------------------------------

### JavaScript: Install dependencies

Source: https://docs.github.com/en/enterprise-cloud%40latest/webhooks/using-webhooks/handling-webhook-deliveries

Install the `express` library for the JavaScript example.

```shell
npm install express
```

--------------------------------

### Get a package version response example

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/packages/packages

Example JSON response for a successful package version retrieval.

```json
{
  "id": 836,
  "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344",
  "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836",
  "package_html_url": "https://github.com/orgs/github/packages/container/package/hello_docker",
  "created_at": "2020-05-19T22:19:11Z",
  "updated_at": "2020-05-19T22:19:11Z",
  "html_url": "https://github.com/orgs/github/packages/container/hello_docker/836",
  "metadata": {
    "package_type": "container",
    "container": {
      "tags": [
        "latest"
      ]
    }
  }
}
```

--------------------------------

### Example response for Get a repository README

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/repos/contents

Example 200 response showing the README file metadata and content encoded in base64.

```json
{
  "type": "file",
  "encoding": "base64",
  "size": 5362,
  "name": "README.md",
  "path": "README.md",
  "content": "encoded content ...",
  "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
  "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
  "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
  "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
  "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
  "_links": {
    "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
    "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
    "html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
  }
}
```

--------------------------------

### Example response for Get a package version for a user

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/packages/packages

Example response for the 'Get a package version for a user' endpoint. Shows a 200 status and the package version details including id, name, URLs, license, timestamps, description, and metadata.

```JSON
Status: 200
{   "id": 387039,   "name": "0.2.0",   "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039",   "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201",   "license": "MIT",   "created_at": "2019-12-01T20:49:29Z",   "updated_at": "2019-12-01T20:49:30Z",   "description": "Octo-name client for Ruby",   "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0",   "metadata": {     "package_type": "rubygems"   } }
```

--------------------------------

### Example response for Get a package version for the authenticated user

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/packages/packages

Example response for the endpoint. Shows a 200 status and the package version details including metadata with container tags.

```json
Status: 200
{
  "id": 214,
  "name": "sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a",
  "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/214",
  "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker",
  "created_at": "2020-05-15T03:46:45Z",
  "updated_at": "2020-05-15T03:46:45Z",
  "html_url": "https://github.com/users/octocat/packages/container/hello_docker/214",
  "metadata": {
    "package_type": "container",
    "container": {
      "tags": [
        "1.13.6"
      ]
    }
  }
}
```

--------------------------------

### Install dependencies with npm install

Source: https://docs.github.com/en/enterprise-cloud%40latest/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment

Run this command if you get a 'Cannot find module' error while running 'npm start'.

```bash
npm install

```

--------------------------------

### Example response for listing installations

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/apps/apps

Example 200 response showing the installation object with permissions, events, and repository selection. The permissions key is included as described.

```json
Status: 200
[
  {
    "id": 1,
    "account": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
    "repositories_url": "https://api.github.com/installation/repositories",
    "html_url": "https://github.com/organizations/github/settings/installations/1",
    "app_id": 1,
    "target_id": 1,
    "target_type": "Organization",
    "permissions": {
      "checks": "write",
      "metadata": "read",
      "contents": "read"
    },
    "events": [
      "push",
      "pull_request"
    ],
    "single_file_name": "config.yaml",
    "has_multiple_single_files": true,
    "single_file_paths": [
      "config.yml",
      ".github/issue_TEMPLATE.md"
    ],
    "repository_selection": "selected",
    "created_at": "2017-07-08T16:18:44-04:00",
    "updated_at": "2017-07-08T16:18:44-04:00",
    "app_slug": "github-actions",
    "suspended_at": null,
    "suspended_by": null
  }
]
```

--------------------------------

### Get registered app installations for external custom properties - Example response

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/orgs/custom-properties

Example response with status 200 showing the structure of the returned data, including display name and installation ID.

```json
Status: 200
[
  {
    "value": {
      "display_name": "Acme",
      "installation": {
        "id": 1
      }
    }
  }
]
```

--------------------------------

### Run the lsp-setup skill

Source: https://docs.github.com/en/enterprise-cloud%40latest/copilot/how-tos/copilot-cli/set-up-copilot-cli/add-lsp-servers

After installing the lsp-setup skill, use this prompt to begin the interactive setup process.

```text
setup lsp
```

--------------------------------

### Request example for Get the repositories accessible to a given GitHub App installation

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/enterprise-admin/organization-installations

Example requests using cURL, JavaScript, and GitHub CLI to access the repositories endpoint.

```curl
curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/apps/organizations/ORG/installations/1/repositories
```

--------------------------------

### Example configuration output

Source: https://docs.github.com/en/enterprise-cloud%40latest/actions/tutorials/migrate-to-github-actions/automated-migrations/bitbucket-pipelines-migration

This shows the interactive configuration process for setting up Bitbucket and GitHub credentials.

```bash
$ gh actions-importer configure
✔ Which CI providers are you configuring?: Bitbucket
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for Bitbucket: ********************
✔ Base url of the Bitbucket instance: https://bitbucket.example.com
Environment variables successfully updated.
```

--------------------------------

### Example response for Get cluster deployment records job status

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/orgs/artifact-metadata?apiVersion=2022-11-28

Example response with status 200, showing the job ID, status, start time, and total count.

```json
{
  "job_id": 123,
  "status": "completed",
  "started_at": "2026-06-10T12:00:00Z",
  "total_count": 5
}
```

--------------------------------

### Get a user installation cURL request

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/apps/apps

Example cURL request to retrieve user installation information. Replace api.github.com with your enterprise's dedicated subdomain if accessing GitHub at GHE.com.

```shell
curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/users/USERNAME/installation
```

--------------------------------

### Initialize a CodeQL pack with codeql pack init

Source: https://docs.github.com/en/enterprise-cloud%40latest/code-security/tutorials/customize-code-scanning/create-and-work-with-codeql-packs

Run this command from the checkout root of your project to create a new CodeQL pack. Replace `<scope>` with the GitHub organization or user account you will publish to, and `<pack>` with the desired pack name. By default, this creates a query pack; to create a library pack, edit `qlpack.yml` to include the `library:true` property.

```bash
codeql pack init <scope>/<pack>
```

--------------------------------

### cURL request for Get a code scanning default setup configuration

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/code-scanning/code-scanning

Example cURL command to retrieve the default setup configuration. Replace api.github.com with your enterprise's dedicated subdomain if using GHE.com.

```bash
curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/code-scanning/default-setup
```

--------------------------------

### Example response for Get a code scanning default setup configuration

Source: https://docs.github.com/en/enterprise-cloud%40latest/rest/code-scanning/code-scanning

The JSON response body returned when the request is successful (status 200).

```json
{
  "state": "configured",
  "languages": [
    "ruby",
    "python"
  ],
  "query_suite": "default",
  "threat_model": "remote",
  "updated_at": "2023-01-19T11:21:34Z",
  "schedule": "weekly"
}
```

--------------------------------

### Sample .csproj file for NuGet package

Source: https://docs.github.com/en/enterprise-cloud%40latest/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry

Example project file with package metadata and repository URL. Replace placeholders like PROJECT_NAME, 1.0.0, OWNER, and REPOSITORY.

```xml
<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>PROJECT_NAME</PackageId>
    <Version>1.0.0</Version>
    <Authors>AUTHORS</Authors>
    <Company>COMPANY_NAME</Company>
    <PackageDescription>PACKAGE_DESCRIPTION</PackageDescription>
    <RepositoryUrl>https://github.com/OWNER/REPOSITORY</RepositoryUrl>
  </PropertyGroup>

</Project>

```
Tokens:
Raw