openapi-directory/api/github.com/github.ae.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.3","servers":[{"url":"https://github.com/"},{"url":"https://{hostname}/api/v3","variables":{"hostname":{"default":"HOSTNAME","description":"Self-hosted GitHub AE hostname"}}}],"info":{"contact":{"name":"Support","url":"https://support.github.com/contact?tags=dotcom-rest-api"},"description":"GitHub's v3 REST API.","license":{"name":"MIT","url":"https://spdx.org/licenses/MIT"},"termsOfService":"https://docs.github.com/articles/github-terms-of-service","title":"GitHub v3 REST API","version":"1.1.4","x-apisguru-categories":["collaboration","developer_tools"],"x-github-plan":"github.ae","x-logo":{"url":"https://twitter.com/github/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/github.ae/github.ae.json","version":"3.0"}],"x-providerName":"github.com","x-serviceName":"github.ae"},"externalDocs":{"description":"GitHub AE Developer Docs","url":"https://docs.github.com/github-ae@latest/rest/"},"tags":[{"description":"Endpoints to manage GitHub Actions using the REST API.","name":"actions"},{"description":"Activity APIs provide access to notifications, subscriptions, and timelines.","name":"activity"},{"description":"Information for integrations and installations.","name":"apps"},{"description":"Monitor charges and usage from Actions and Packages.","name":"billing"},{"description":"Rich interactions with checks run by your integrations.","name":"checks"},{"description":"Retrieve code scanning alerts from a repository.","name":"code-scanning"},{"description":"Insight into codes of conduct for your communities.","name":"codes-of-conduct"},{"description":"Endpoints to manage Codespaces using the REST API.","name":"codespaces"},{"description":"List emojis available to use on GitHub.","name":"emojis"},{"description":"Endpoints to manage Dependabot.","name":"dependabot"},{"description":"Endpoints to access Dependency Graph features.","name":"dependency-graph"},{"description":"View, modify your gists.","name":"gists"},{"description":"Raw Git functionality.","name":"git"},{"description":"View gitignore templates","name":"gitignore"},{"description":"Owner or admin management of users interactions.","name":"interactions"},{"description":"Interact with GitHub Issues.","name":"issues"},{"description":"View various OSS licenses.","name":"licenses"},{"description":"Render GitHub flavored markdown","name":"markdown"},{"description":"Interact with GitHub Merge Queues.","name":"merge-queue"},{"description":"Endpoints that give information about the API.","name":"meta"},{"description":"Move projects to or from GitHub.","name":"migrations"},{"description":"Endpoints to manage GitHub OIDC configuration using the REST API.","name":"oidc"},{"description":"Interact with GitHub Orgs.","name":"orgs"},{"description":"Manage packages for authenticated users and organizations.","name":"packages"},{"description":"Interact with GitHub Projects.","name":"projects"},{"description":"Interact with GitHub Pull Requests.","name":"pulls"},{"description":"Check your current rate limit status","name":"rate-limit"},{"description":"Interact with reactions to various GitHub entities.","name":"reactions"},{"description":"Interact with GitHub Repos.","name":"repos"},{"description":"Look for stuff on GitHub.","name":"search"},{"description":"Retrieve secret scanning alerts from a repository.","name":"secret-scanning"},{"description":"Interact with GitHub Teams.","name":"teams"},{"description":"Interact with and view information about users and also current user.","name":"users"},{"description":"Enterprise Administration","name":"enterprise-admin"}],"paths":{"/":{"get":{"description":"Get Hypermedia links to resources accessible in GitHub's REST API","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#root-endpoint"},"operationId":"meta/root","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/root"}},"schema":{"$ref":"#/components/schemas/root"}}},"description":"Response"}},"summary":"GitHub API Root","tags":["meta"],"x-github":{"category":"meta","enabledForGitHubApps":true,"githubCloudOnly":false}}},"/admin/hooks":{"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-global-webhooks"},"operationId":"enterprise-admin/list-global-webhooks","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook-items"}},"schema":{"items":{"$ref":"#/components/schemas/global-hook"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}},"summary":"List global webhooks","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"global-webhooks"}},"post":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-a-global-webhook"},"operationId":"enterprise-admin/create-global-webhook","requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"config":{"content_type":"json","secret":"secret","url":"https://example.com/webhook"},"events":["organization","user"],"name":"web"}}},"schema":{"properties":{"active":{"default":true,"description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","type":"boolean"},"config":{"description":"Key/value pairs to provide settings for this webhook.","properties":{"content_type":{"description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.","type":"string"},"insecure_ssl":{"description":"Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**","type":"string"},"secret":{"description":"If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers) header.","type":"string"},"url":{"description":"The URL to which the payloads will be delivered.","type":"string"}},"required":["url"],"type":"object"},"events":{"description":"The [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.","items":{"type":"string"},"type":"array"},"name":{"description":"Must be passed as \"web\".","type":"string"}},"required":["name","config"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook"}},"schema":{"$ref":"#/components/schemas/global-hook"}}},"description":"Response"}},"summary":"Create a global webhook","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"global-webhooks"}}},"/admin/hooks/{hook_id}":{"delete":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-global-webhook"},"operationId":"enterprise-admin/delete-global-webhook","parameters":[{"$ref":"#/components/parameters/hook-id"}],"responses":{"204":{"description":"Response"}},"summary":"Delete a global webhook","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"global-webhooks"}},"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-global-webhook"},"operationId":"enterprise-admin/get-global-webhook","parameters":[{"$ref":"#/components/parameters/hook-id"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook"}},"schema":{"$ref":"#/components/schemas/global-hook"}}},"description":"Response"}},"summary":"Get a global webhook","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"global-webhooks"}},"patch":{"description":"Parameters that are not provided will be overwritten with the default value or removed if no default exists.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-a-global-webhook"},"operationId":"enterprise-admin/update-global-webhook","parameters":[{"$ref":"#/components/parameters/hook-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"config":{"url":"https://example.com/webhook"},"events":["organization"]}}},"schema":{"properties":{"active":{"default":true,"description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","type":"boolean"},"config":{"description":"Key/value pairs to provide settings for this webhook.","properties":{"content_type":{"description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.","type":"string"},"insecure_ssl":{"description":"Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**","type":"string"},"secret":{"description":"If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers) header.","type":"string"},"url":{"description":"The URL to which the payloads will be delivered.","type":"string"}},"required":["url"],"type":"object"},"events":{"description":"The [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.","items":{"type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/global-hook-2"}},"schema":{"$ref":"#/components/schemas/global-hook-2"}}},"description":"Response"}},"summary":"Update a global webhook","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"global-webhooks"}}},"/admin/hooks/{hook_id}/pings":{"post":{"description":"This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the webhook.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#ping-a-global-webhook"},"operationId":"enterprise-admin/ping-global-webhook","parameters":[{"$ref":"#/components/parameters/hook-id"}],"responses":{"204":{"description":"Response"}},"summary":"Ping a global webhook","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"global-webhooks"}}},"/admin/keys":{"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-public-keys"},"operationId":"enterprise-admin/list-public-keys","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/direction"},{"in":"query","name":"sort","required":false,"schema":{"default":"created","enum":["created","updated","accessed"],"type":"string"}},{"description":"Only show public keys accessed after the given time.","in":"query","name":"since","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/enterprise-public-key-items"}},"schema":{"items":{"$ref":"#/components/schemas/public-key-full"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}},"summary":"List public keys","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"users"}}},"/admin/keys/{key_ids}":{"delete":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-public-key"},"operationId":"enterprise-admin/delete-public-key","parameters":[{"$ref":"#/components/parameters/key-ids"}],"responses":{"204":{"description":"Response"}},"summary":"Delete a public key","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"users"}}},"/admin/organizations":{"post":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-an-organization"},"operationId":"enterprise-admin/create-org","requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"admin":"monalisaoctocat","login":"github","profile_name":"GitHub, Inc."}}},"schema":{"properties":{"admin":{"description":"The login of the user who will manage this organization.","type":"string"},"login":{"description":"The organization's username.","type":"string"},"profile_name":{"description":"The organization's display name.","type":"string"}},"required":["login","admin"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-simple"}},"schema":{"$ref":"#/components/schemas/organization-simple"}}},"description":"Response"}},"summary":"Create an organization","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"orgs"}}},"/admin/organizations/{org}":{"patch":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-an-organization-name"},"operationId":"enterprise-admin/update-org-name","parameters":[{"$ref":"#/components/parameters/org"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"login":"the-new-octocats"}}},"schema":{"properties":{"login":{"description":"The organization's new name.","type":"string"}},"required":["login"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"default":{"value":{"message":"Job queued to rename organization. It may take a few minutes to complete.","url":"https://<hostname>/api/v3/organizations/1"}}},"schema":{"properties":{"message":{"type":"string"},"url":{"type":"string"}},"type":"object"}}},"description":"Response"}},"summary":"Update an organization name","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"orgs"}}},"/admin/pre-receive-environments":{"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-pre-receive-environments"},"operationId":"enterprise-admin/list-pre-receive-environments","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/direction"},{"in":"query","name":"sort","required":false,"schema":{"default":"created","enum":["created","updated","name"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-environment-items"}},"schema":{"items":{"$ref":"#/components/schemas/pre-receive-environment"},"type":"array"}}},"description":"Response"}},"summary":"List pre-receive environments","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"pre-receive-environments"}},"post":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-a-pre-receive-environment"},"operationId":"enterprise-admin/create-pre-receive-environment","requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"image_url":"https://my_file_server/path/to/devtools_env.tar.gz","name":"DevTools Hook Env"}}},"schema":{"properties":{"image_url":{"description":"URL from which to download a tarball of this environment.","type":"string"},"name":{"description":"The new pre-receive environment's name.","type":"string"}},"required":["name","image_url"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-environment"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment"}}},"description":"Response"}},"summary":"Create a pre-receive environment","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"pre-receive-environments"}}},"/admin/pre-receive-environments/{pre_receive_environment_id}":{"delete":{"description":"If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n*   _Cannot modify or delete the default environment_\n*   _Cannot delete environment that has hooks_\n*   _Cannot delete environment when download is in progress_","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-pre-receive-environment"},"operationId":"enterprise-admin/delete-pre-receive-environment","parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"responses":{"204":{"description":"Response"},"422":{"content":{"application/json":{"examples":{"client-errors":{"value":{"errors":[{"code":"custom","message":"Cannot modify or delete the default environment","resource":"PreReceiveEnvironment"}],"message":"Validation Failed"}}},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Client Errors"}},"summary":"Delete a pre-receive environment","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"pre-receive-environments"}},"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-pre-receive-environment"},"operationId":"enterprise-admin/get-pre-receive-environment","parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-environment"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment"}}},"description":"Response"}},"summary":"Get a pre-receive environment","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"pre-receive-environments"}},"patch":{"description":"You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-a-pre-receive-environment"},"operationId":"enterprise-admin/update-pre-receive-environment","parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"image_url":"https://my_file_server/path/to/devtools_env.tar.gz","name":"DevTools Hook Env"}}},"schema":{"properties":{"image_url":{"description":"URL from which to download a tarball of this environment.","type":"string"},"name":{"description":"This pre-receive environment's new name.","type":"string"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/pre-receive-environment-default-response"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment"}}},"description":"Response"},"422":{"content":{"application/json":{"examples":{"client-errors":{"value":{"errors":[{"code":"custom","message":"Cannot modify or delete the default environment","resource":"PreReceiveEnvironment"}],"message":"Validation Failed"}}},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Client Errors"}},"summary":"Update a pre-receive environment","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"pre-receive-environments"}}},"/admin/pre-receive-environments/{pre_receive_environment_id}/downloads":{"post":{"description":"Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#start-a-pre-receive-environment-download"},"operationId":"enterprise-admin/start-pre-receive-environment-download","parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"responses":{"202":{"content":{"application/json":{"examples":{"default-response":{"$ref":"#/components/examples/pre-receive-environment-download-status-default-response"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment-download-status"}}},"description":"Response"},"422":{"content":{"application/json":{"examples":{"client-errors":{"value":{"errors":[{"code":"custom","message":"Can not start a new download when a download is in progress","resource":"PreReceiveEnvironment"}],"message":"Validation Failed"}}},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Client Errors"}},"summary":"Start a pre-receive environment download","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"pre-receive-environments"}}},"/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest":{"get":{"description":"In addition to seeing the download status at the \"[Get a pre-receive environment](#get-a-pre-receive-environment)\" endpoint, there is also this separate endpoint for just the download status.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-the-download-status-for-a-pre-receive-environment"},"operationId":"enterprise-admin/get-download-status-for-pre-receive-environment","parameters":[{"$ref":"#/components/parameters/pre-receive-environment-id"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/pre-receive-environment-download-status"}},"schema":{"$ref":"#/components/schemas/pre-receive-environment-download-status"}}},"description":"Response"}},"summary":"Get the download status for a pre-receive environment","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"pre-receive-environments"}}},"/admin/tokens":{"get":{"description":"Lists personal access tokens for all users, including admin users.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-personal-access-tokens"},"operationId":"enterprise-admin/list-personal-access-tokens","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-items"}},"schema":{"items":{"$ref":"#/components/schemas/authorization"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}}},"summary":"List personal access tokens","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"users"}}},"/admin/tokens/{token_id}":{"delete":{"description":"Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-personal-access-token"},"operationId":"enterprise-admin/delete-personal-access-token","parameters":[{"$ref":"#/components/parameters/token-id"}],"responses":{"204":{"description":"Response"}},"summary":"Delete a personal access token","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"users"}}},"/admin/users/{username}":{"delete":{"description":"Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-user"},"operationId":"enterprise-admin/delete-user","parameters":[{"$ref":"#/components/parameters/username"}],"responses":{"204":{"description":"Response"}},"summary":"Delete a user","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"users"}}},"/admin/users/{username}/authorizations":{"delete":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-an-impersonation-oauth-token"},"operationId":"enterprise-admin/delete-impersonation-o-auth-token","parameters":[{"$ref":"#/components/parameters/username"}],"responses":{"204":{"description":"Response"}},"summary":"Delete an impersonation OAuth token","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"users"}},"post":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-an-impersonation-oauth-token"},"operationId":"enterprise-admin/create-impersonation-o-auth-token","parameters":[{"$ref":"#/components/parameters/username"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"scopes":["public_repo"]}}},"schema":{"properties":{"scopes":{"description":"A list of [scopes](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).","items":{"type":"string"},"type":"array"}},"required":["scopes"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response when getting an existing impersonation OAuth token"},"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response when creating a new impersonation OAuth token"}},"summary":"Create an impersonation OAuth token","tags":["enterprise-admin"],"x-github":{"category":"enterprise-admin","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"users"}}},"/app":{"get":{"description":"Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/github-ae@latest/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#get-the-authenticated-app"},"operationId":"apps/get-authenticated","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration"}},"schema":{"$ref":"#/components/schemas/integration"}}},"description":"Response"}},"summary":"Get the authenticated app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/app-manifests/{code}/conversions":{"post":{"description":"Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/github-ae@latest/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-github-app-from-a-manifest"},"operationId":"apps/create-from-manifest","parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration-from-manifest"}},"schema":{"allOf":[{"$ref":"#/components/schemas/integration"},{"additionalProperties":true,"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"pem":{"type":"string"},"webhook_secret":{"nullable":true,"type":"string"}},"required":["client_id","client_secret","webhook_secret","pem"],"type":"object"}]}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"summary":"Create a GitHub App from a manifest","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/app/hook/config":{"get":{"description":"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/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#get-a-webhook-configuration-for-an-app"},"operationId":"apps/get-webhook-config-for-app","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/webhook-config"}},"schema":{"$ref":"#/components/schemas/webhook-config"}}},"description":"Response"}},"summary":"Get a webhook configuration for an app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}},"patch":{"description":"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/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#update-a-webhook-configuration-for-an-app"},"operationId":"apps/update-webhook-config-for-app","requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"content_type":"json","insecure_ssl":"0","secret":"********","url":"https://example.com/webhook"}}},"schema":{"properties":{"content_type":{"$ref":"#/components/schemas/webhook-config-content-type"},"insecure_ssl":{"$ref":"#/components/schemas/webhook-config-insecure-ssl"},"secret":{"$ref":"#/components/schemas/webhook-config-secret"},"url":{"$ref":"#/components/schemas/webhook-config-url"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/webhook-config"}},"schema":{"$ref":"#/components/schemas/webhook-config"}}},"description":"Response"}},"summary":"Update a webhook configuration for an app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}}},"/app/hook/deliveries":{"get":{"description":"Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#list-deliveries-for-an-app-webhook"},"operationId":"apps/list-webhook-deliveries","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/cursor"},{"in":"query","name":"redelivery","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hook-delivery-items"}},"schema":{"items":{"$ref":"#/components/schemas/hook-delivery-item"},"type":"array"}}},"description":"Response"},"400":{"$ref":"#/components/responses/bad_request"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"List deliveries for an app webhook","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}}},"/app/hook/deliveries/{delivery_id}":{"get":{"description":"Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#get-a-delivery-for-an-app-webhook"},"operationId":"apps/get-webhook-delivery","parameters":[{"$ref":"#/components/parameters/delivery-id"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hook-delivery"}},"schema":{"$ref":"#/components/schemas/hook-delivery"}}},"description":"Response"},"400":{"$ref":"#/components/responses/bad_request"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Get a delivery for an app webhook","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}}},"/app/hook/deliveries/{delivery_id}/attempts":{"post":{"description":"Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook"},"operationId":"apps/redeliver-webhook-delivery","parameters":[{"$ref":"#/components/parameters/delivery-id"}],"responses":{"202":{"$ref":"#/components/responses/accepted"},"400":{"$ref":"#/components/responses/bad_request"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Redeliver a delivery for an app webhook","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}}},"/app/installations":{"get":{"description":"You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#list-installations-for-the-authenticated-app"},"operationId":"apps/list-installations","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/since"},{"in":"query","name":"outdated","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-installation-items"}},"schema":{"items":{"$ref":"#/components/schemas/installation"},"type":"array"}}},"description":"The permissions the installation has are included under the `permissions` key.","headers":{"Link":{"$ref":"#/components/headers/link"}}}},"summary":"List installations for the authenticated app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/app/installations/{installation_id}":{"delete":{"description":"Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/github-ae@latest/rest/reference/apps/#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#delete-an-installation-for-the-authenticated-app"},"operationId":"apps/delete-installation","parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Delete an installation for the authenticated app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}},"get":{"description":"Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#get-an-installation-for-the-authenticated-app"},"operationId":"apps/get-installation","parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-installation"}},"schema":{"$ref":"#/components/schemas/installation"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Get an installation for the authenticated app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/app/installations/{installation_id}/access_tokens":{"post":{"description":"Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps/#create-an-installation-access-token-for-an-app"},"operationId":"apps/create-installation-access-token","parameters":[{"$ref":"#/components/parameters/installation-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"permissions":{"contents":"read","issues":"write"},"repository":"Hello-World"}}},"schema":{"properties":{"permissions":{"$ref":"#/components/schemas/app-permissions"},"repositories":{"description":"List of repository names that the token should have access to","items":{"example":"rails","type":"string"},"type":"array"},"repository_ids":{"description":"List of repository IDs that the token should have access to","example":[1],"items":{"type":"integer"},"type":"array"}},"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/installation-token"}},"schema":{"$ref":"#/components/schemas/installation-token"}}},"description":"Response"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Create an installation access token for an app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/app/installations/{installation_id}/suspended":{"delete":{"description":"Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#unsuspend-an-app-installation"},"operationId":"apps/unsuspend-installation","parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Unsuspend an app installation","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}},"put":{"description":"Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub AE API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#suspend-an-app-installation"},"operationId":"apps/suspend-installation","parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Suspend an app installation","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/applications/{client_id}/grant":{"delete":{"description":"OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#delete-an-app-authorization"},"operationId":"apps/delete-authorization","parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"}}},"schema":{"properties":{"access_token":{"description":"The OAuth access token used to authenticate to the GitHub API.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true},"responses":{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Delete an app authorization","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"oauth-applications"}}},"/applications/{client_id}/token":{"delete":{"description":"OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#delete-an-app-token"},"operationId":"apps/delete-token","parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"}}},"schema":{"properties":{"access_token":{"description":"The OAuth access token used to authenticate to the GitHub API.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true},"responses":{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Delete an app token","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"oauth-applications"}},"patch":{"description":"OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/github-ae@latest/rest/reference/apps#reset-a-token"},"operationId":"apps/reset-token","parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"}}},"schema":{"properties":{"access_token":{"description":"The access_token of the OAuth application.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true},"responses":{"