{
  "opencollection": "1.0.0",
  "info": {
    "name": "Github Configuration API",
    "version": "1.1.4"
  },
  "items": [
    {
      "info": {
        "name": "Configuration",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GitHub Getwebhook Configuration for an App",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/app/hook/config"
          },
          "docs": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint."
        },
        {
          "info": {
            "name": "GitHub Updatewebhook Configuration for an App",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/api/v3/app/hook/config",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get Webhook Configuration for an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/config",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "hook_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
              }
            ]
          },
          "docs": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Update Webhook Configuration for an Organization",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/config",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "hook_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get Code Scanning Default Setup Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/default-setup",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              }
            ]
          },
          "docs": "Gets a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories."
        },
        {
          "info": {
            "name": "GitHub Update Code Scanning Default Setup Configuration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/default-setup",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories."
        },
        {
          "info": {
            "name": "GitHub Get Webhook Configuration for Repository",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/config",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "hook_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
              }
            ]
          },
          "docs": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Update Webhook Configuration for Repository",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/config",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "hook_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get the Configuration Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/setup/api/configcheck"
          },
          "docs": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status        | Description                       |\n| - |  |\n| `PENDING`     | The job has not started yet       |\n| `CONFIGURING` | The job is running                |\n| `DONE`        | The job has finished correctly    |\n| `FAILED`      | The job has finished unexpectedly"
        },
        {
          "info": {
            "name": "GitHub Start Configuration Process",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/api/v3/setup/api/configure"
          },
          "docs": "The GitHub Setup API's `/setup/api/configure` endpoint accepts POST requests to initiate the configuration process for a new GitHub Enterprise Server instance. This endpoint is typically called during the initial setup phase when administrators need to establish basic system settings such as management console password, hostname, and other foundational configurations. The API operation triggers the configuration workflow that prepares the instance for use, and it returns a response indicating wh"
        }
      ]
    }
  ],
  "bundled": true
}