openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Enterprise-Admin API description: Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Enterprise-Admin description: Enterprise Administration paths: /admin/hooks: get: summary: APIs.io Engineering Platform List global webhooks description: '' operationId: enterprise-admin/list-global-webhooks tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#list-global-webhooks parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/global-hook' examples: default: $ref: '#/components/examples/global-hook-items' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: global-webhooks post: summary: APIs.io Engineering Platform Create a global webhook description: '' operationId: enterprise-admin/create-global-webhook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#create-a-global-webhook responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/global-hook' examples: default: $ref: '#/components/examples/global-hook' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Must be passed as "web". config: type: object description: Key/value pairs to provide settings for this webhook. properties: url: type: string description: The URL to which the payloads will be delivered. content_type: type: string description: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. secret: type: string 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/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers) header. insecure_ssl: type: string 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.** required: - url events: type: array description: 'The [events](https://docs.github.com/enterprise-server@3.9/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 active: type: boolean description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. default: true required: - name - config examples: default: value: name: web events: - organization - user config: url: https://example.com/webhook content_type: json secret: secret x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: global-webhooks /admin/hooks/{hook_id}: get: summary: APIs.io Engineering Platform Get a global webhook description: '' operationId: enterprise-admin/get-global-webhook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#get-a-global-webhook parameters: - $ref: '#/components/parameters/hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/global-hook' examples: default: $ref: '#/components/examples/global-hook' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: global-webhooks patch: summary: APIs.io Engineering Platform Update a global webhook description: Parameters that are not provided will be overwritten with the default value or removed if no default exists. operationId: enterprise-admin/update-global-webhook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#update-a-global-webhook parameters: - $ref: '#/components/parameters/hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/global-hook-2' examples: default: $ref: '#/components/examples/global-hook-2' requestBody: required: true content: application/json: schema: type: object properties: config: type: object description: Key/value pairs to provide settings for this webhook. properties: url: type: string description: The URL to which the payloads will be delivered. content_type: type: string description: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. secret: type: string 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/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers) header. insecure_ssl: type: string 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.** required: - url events: type: array description: 'The [events](https://docs.github.com/enterprise-server@3.9/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 active: type: boolean description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. default: true examples: default: value: events: - organization config: url: https://example.com/webhook x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: global-webhooks delete: summary: APIs.io Engineering Platform Delete a global webhook description: '' operationId: enterprise-admin/delete-global-webhook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#delete-a-global-webhook parameters: - $ref: '#/components/parameters/hook-id' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: global-webhooks /admin/hooks/{hook_id}/pings: post: summary: APIs.io Engineering Platform Ping a global webhook description: This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the webhook. operationId: enterprise-admin/ping-global-webhook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#ping-a-global-webhook parameters: - $ref: '#/components/parameters/hook-id' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: global-webhooks /admin/keys: get: summary: APIs.io Engineering Platform List public keys description: '' operationId: enterprise-admin/list-public-keys tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#list-public-keys parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/direction' - name: sort in: query required: false schema: type: string enum: - created - updated - accessed default: created - name: since description: Only show public keys accessed after the given time. in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/public-key-full' examples: default: $ref: '#/components/examples/enterprise-public-key-items' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users /admin/keys/{key_ids}: delete: summary: APIs.io Engineering Platform Delete a public key description: '' operationId: enterprise-admin/delete-public-key tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#delete-a-public-key parameters: - $ref: '#/components/parameters/key-ids' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users /admin/ldap/teams/{team_id}/mapping: patch: summary: APIs.io Engineering Platform Update LDAP mapping for a team description: Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. operationId: enterprise-admin/update-ldap-mapping-for-team tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team parameters: - $ref: '#/components/parameters/team-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ldap-mapping-team' examples: default: $ref: '#/components/examples/ldap-mapping-team' requestBody: required: true content: application/json: schema: type: object properties: ldap_dn: type: string description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. required: - ldap_dn examples: default: value: ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: ldap /admin/ldap/teams/{team_id}/sync: post: summary: APIs.io Engineering Platform Sync LDAP mapping for a team description: Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. operationId: enterprise-admin/sync-ldap-mapping-for-team tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team parameters: - $ref: '#/components/parameters/team-id' responses: '201': description: Response content: application/json: schema: type: object properties: status: type: string examples: default: value: status: queued x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: ldap /admin/ldap/users/{username}/mapping: patch: summary: APIs.io Engineering Platform Update LDAP mapping for a user description: '' operationId: enterprise-admin/update-ldap-mapping-for-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user parameters: - $ref: '#/components/parameters/username' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ldap-mapping-user' examples: default: $ref: '#/components/examples/ldap-mapping-user' requestBody: required: true content: application/json: schema: type: object properties: ldap_dn: type: string description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. required: - ldap_dn examples: default: value: ldap_dn: uid=asdf,ou=users,dc=github,dc=com x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: ldap /admin/ldap/users/{username}/sync: post: summary: APIs.io Engineering Platform Sync LDAP mapping for a user description: Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. operationId: enterprise-admin/sync-ldap-mapping-for-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user parameters: - $ref: '#/components/parameters/username' responses: '201': description: Response content: application/json: schema: type: object properties: status: type: string examples: default: value: status: queued x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: ldap /admin/organizations: post: summary: APIs.io Engineering Platform Create an organization description: '' operationId: enterprise-admin/create-org tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/orgs#create-an-organization responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/organization-simple' examples: default: $ref: '#/components/examples/organization-simple' requestBody: required: true content: application/json: schema: type: object properties: login: type: string description: The organization's username. admin: type: string description: The login of the user who will manage this organization. profile_name: type: string description: The organization's display name. required: - login - admin examples: default: value: login: github profile_name: GitHub, Inc. admin: monalisaoctocat x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: orgs /admin/organizations/{org}: patch: summary: APIs.io Engineering Platform Update an organization name description: '' operationId: enterprise-admin/update-org-name tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/orgs#update-an-organization-name parameters: - $ref: '#/components/parameters/org' responses: '202': description: Response content: application/json: schema: type: object properties: message: type: string url: type: string examples: default: value: message: Job queued to rename organization. It may take a few minutes to complete. url: https:///api/v3/organizations/1 requestBody: required: true content: application/json: schema: type: object properties: login: type: string description: The organization's new name. required: - login examples: default: value: login: the-new-octocats x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: orgs /admin/pre-receive-environments: get: summary: APIs.io Engineering Platform List pre-receive environments description: '' operationId: enterprise-admin/list-pre-receive-environments tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/direction' - name: sort in: query required: false schema: type: string enum: - created - updated - name default: created responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/pre-receive-environment' examples: default: $ref: '#/components/examples/pre-receive-environment-items' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-environments post: summary: APIs.io Engineering Platform Create a pre-receive environment description: '' operationId: enterprise-admin/create-pre-receive-environment tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/pre-receive-environment' examples: default: $ref: '#/components/examples/pre-receive-environment' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The new pre-receive environment's name. image_url: type: string description: URL from which to download a tarball of this environment. required: - name - image_url examples: default: value: name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-environments /admin/pre-receive-environments/{pre_receive_environment_id}: get: summary: APIs.io Engineering Platform Get a pre-receive environment description: '' operationId: enterprise-admin/get-pre-receive-environment tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment parameters: - $ref: '#/components/parameters/pre-receive-environment-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/pre-receive-environment' examples: default: $ref: '#/components/examples/pre-receive-environment' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-environments patch: summary: APIs.io Engineering Platform Update a pre-receive environment description: You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. operationId: enterprise-admin/update-pre-receive-environment tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment parameters: - $ref: '#/components/parameters/pre-receive-environment-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/pre-receive-environment' examples: default-response: $ref: '#/components/examples/pre-receive-environment-default-response' '422': description: Client Errors content: application/json: schema: type: object properties: message: type: string errors: type: array items: type: object properties: resource: type: string code: type: string message: type: string examples: client-errors: value: message: Validation Failed errors: - resource: PreReceiveEnvironment code: custom message: Cannot modify or delete the default environment requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: This pre-receive environment's new name. image_url: type: string description: URL from which to download a tarball of this environment. examples: default: value: name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-environments delete: summary: APIs.io Engineering Platform Delete a pre-receive environment description: 'If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. The possible error messages are: * _Cannot modify or delete the default environment_ * _Cannot delete environment that has hooks_ * _Cannot delete environment when download is in progress_' operationId: enterprise-admin/delete-pre-receive-environment tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment parameters: - $ref: '#/components/parameters/pre-receive-environment-id' responses: '204': description: Response '422': description: Client Errors content: application/json: schema: type: object properties: message: type: string errors: type: array items: type: object properties: resource: type: string code: type: string message: type: string examples: client-errors: value: message: Validation Failed errors: - resource: PreReceiveEnvironment code: custom message: Cannot modify or delete the default environment x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-environments /admin/pre-receive-environments/{pre_receive_environment_id}/downloads: post: summary: APIs.io Engineering Platform Start a pre-receive environment download 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. If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. The possible error messages are: * _Cannot modify or delete the default environment_ * _Can not start a new download when a download is in progress_' operationId: enterprise-admin/start-pre-receive-environment-download tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download parameters: - $ref: '#/components/parameters/pre-receive-environment-id' responses: '202': description: Response content: application/json: schema: $ref: '#/components/schemas/pre-receive-environment-download-status' examples: default-response: $ref: '#/components/examples/pre-receive-environment-download-status-default-response' '422': description: Client Errors content: application/json: schema: type: object properties: message: type: string errors: type: array items: type: object properties: resource: type: string code: type: string message: type: string examples: client-errors: value: message: Validation Failed errors: - resource: PreReceiveEnvironment code: custom message: Can not start a new download when a download is in progress x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-environments /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest: get: summary: APIs.io Engineering Platform Get the download status for a pre-receive environment 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. operationId: enterprise-admin/get-download-status-for-pre-receive-environment tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment parameters: - $ref: '#/components/parameters/pre-receive-environment-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/pre-receive-environment-download-status' examples: default: $ref: '#/components/examples/pre-receive-environment-download-status' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-environments /admin/pre-receive-hooks: get: summary: APIs.io Engineering Platform List pre-receive hooks description: '' operationId: enterprise-admin/list-pre-receive-hooks tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/direction' - name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - created - updated - name default: created responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/pre-receive-hook' examples: default: $ref: '#/components/examples/pre-receive-hook-items' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-hooks post: summary: APIs.io Engineering Platform Create a pre-receive hook description: '' operationId: enterprise-admin/create-pre-receive-hook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/pre-receive-hook' examples: default: $ref: '#/components/examples/pre-receive-hook' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the hook. script: type: string description: The script that the hook runs. script_repository: type: object description: The GitHub repository where the script is kept. properties: {} additionalProperties: true environment: type: object description: The pre-receive environment where the script is executed. properties: {} additionalProperties: true enforcement: type: string description: 'The state of enforcement for this hook. default: `disabled`' allow_downstream_configuration: type: boolean description: 'Whether enforcement can be overridden at the org or repo level. default: `false`' required: - name - script - script_repository - environment examples: default: value: name: Check Commits script: scripts/commit_check.sh enforcement: disabled allow_downstream_configuration: false script_repository: full_name: DevIT/hooks environment: id: 2 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-hooks /admin/pre-receive-hooks/{pre_receive_hook_id}: get: summary: APIs.io Engineering Platform Get a pre-receive hook description: '' operationId: enterprise-admin/get-pre-receive-hook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook parameters: - $ref: '#/components/parameters/pre-receive-hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/pre-receive-hook' examples: default: $ref: '#/components/examples/pre-receive-hook' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-hooks patch: summary: APIs.io Engineering Platform Update a pre-receive hook description: '' operationId: enterprise-admin/update-pre-receive-hook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook parameters: - $ref: '#/components/parameters/pre-receive-hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/pre-receive-hook' examples: default: $ref: '#/components/examples/pre-receive-hook-2' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: The name of the hook. script: type: string description: The script that the hook runs. script_repository: type: object description: The GitHub repository where the script is kept. properties: {} additionalProperties: true environment: type: object description: The pre-receive environment where the script is executed. properties: {} additionalProperties: true enforcement: type: string description: The state of enforcement for this hook. allow_downstream_configuration: type: boolean description: Whether enforcement can be overridden at the org or repo level. examples: default: value: name: Check Commits environment: id: 1 allow_downstream_configuration: true x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-hooks delete: summary: APIs.io Engineering Platform Delete a pre-receive hook description: '' operationId: enterprise-admin/delete-pre-receive-hook tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook parameters: - $ref: '#/components/parameters/pre-receive-hook-id' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: pre-receive-hooks /admin/tokens: get: summary: APIs.io Engineering Platform List personal access tokens description: Lists personal access tokens for all users, including admin users. operationId: enterprise-admin/list-personal-access-tokens tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#list-personal-access-tokens parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/authorization' examples: default: $ref: '#/components/examples/authorization-items' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users /admin/tokens/{token_id}: delete: summary: APIs.io Engineering Platform Delete a personal access token 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. operationId: enterprise-admin/delete-personal-access-token tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#delete-a-personal-access-token parameters: - $ref: '#/components/parameters/token-id' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users /admin/users: post: summary: APIs.io Engineering Platform Create a user description: 'If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. If the login name or email address is already associated with an account, the server will return a `422` response.' operationId: enterprise-admin/create-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#create-a-user responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/simple-user' examples: default: $ref: '#/components/examples/simple-user' requestBody: required: true content: application/json: schema: type: object properties: login: type: string description: The user's username. email: type: string description: '**Required for built-in authentication.** The user''s email address. This parameter can be omitted when using CAS, LDAP, or SAML. For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)."' suspended: type: boolean description: Whether to set the user as suspended when the user is created. default: false required: - login examples: default: value: login: monalisa email: octocat@github.com x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users /admin/users/{username}: patch: summary: APIs.io Engineering Platform Update the username for a user description: '' operationId: enterprise-admin/update-username-for-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#update-the-username-for-a-user parameters: - $ref: '#/components/parameters/username' responses: '202': description: Response content: application/json: schema: type: object properties: message: type: string url: type: string examples: default: value: message: Job queued to rename user. It may take a few minutes to complete. url: https://api.github.com/user/1 requestBody: required: true content: application/json: schema: type: object properties: login: type: string description: The user's new username. required: - login examples: default: value: login: thenewmonalisa x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users delete: summary: APIs.io Engineering Platform Delete a user description: 'Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user) is often a better option. You can delete any user account except your own.' operationId: enterprise-admin/delete-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#delete-a-user parameters: - $ref: '#/components/parameters/username' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users /admin/users/{username}/authorizations: post: summary: APIs.io Engineering Platform Create an impersonation OAuth token description: '' operationId: enterprise-admin/create-impersonation-o-auth-token tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#create-an-impersonation-oauth-token parameters: - $ref: '#/components/parameters/username' responses: '201': description: Response when creating a new impersonation OAuth token content: application/json: schema: $ref: '#/components/schemas/authorization' examples: default: $ref: '#/components/examples/authorization' '200': description: Response when getting an existing impersonation OAuth token content: application/json: schema: $ref: '#/components/schemas/authorization' examples: default: $ref: '#/components/examples/authorization' requestBody: required: true content: application/json: schema: type: object properties: scopes: type: array description: A list of [scopes](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). items: type: string required: - scopes examples: default: value: scopes: - public_repo x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users delete: summary: APIs.io Engineering Platform Delete an impersonation OAuth token description: '' operationId: enterprise-admin/delete-impersonation-o-auth-token tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#delete-an-impersonation-oauth-token parameters: - $ref: '#/components/parameters/username' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users /enterprise/announcement: get: summary: APIs.io Engineering Platform Get the global announcement banner description: Gets the current message and expiration date of the global announcement banner in your enterprise. tags: - Enterprise-Admin operationId: enterprise-admin/get-announcement externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/announcement#get-the-global-announcement-banner responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/announcement' examples: default: $ref: '#/components/examples/announcement' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: announcement patch: summary: APIs.io Engineering Platform Set the global announcement banner description: Sets the message and expiration time for the global announcement banner in your enterprise. tags: - Enterprise-Admin operationId: enterprise-admin/set-announcement externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/announcement#set-the-global-announcement-banner requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/announcement' examples: default: value: announcement: Very **important** announcement about _something_. expires_at: '2021-01-01T00:00:00.000+00:00' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/announcement' examples: default: $ref: '#/components/examples/announcement' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: announcement delete: summary: APIs.io Engineering Platform Remove the global announcement banner description: Removes the global announcement banner in your enterprise. tags: - Enterprise-Admin operationId: enterprise-admin/remove-announcement externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/announcement#remove-the-global-announcement-banner responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: announcement /enterprise/settings/license: get: summary: APIs.io Engineering Platform Get license information description: '' operationId: enterprise-admin/get-license-information tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/license#get-license-information responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/license-info' examples: default: $ref: '#/components/examples/license-info' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: license /enterprise/stats/all: get: summary: APIs.io Engineering Platform Get all statistics description: '' operationId: enterprise-admin/get-all-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-all-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-overview' examples: default: $ref: '#/components/examples/enterprise-overview' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/comments: get: summary: APIs.io Engineering Platform Get comment statistics description: '' operationId: enterprise-admin/get-comment-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-comment-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-comment-overview' examples: default: value: total_commit_comments: 5000 total_gist_comments: 400 total_issue_comments: 10900 total_pull_request_comments: 9900 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/gists: get: summary: APIs.io Engineering Platform Get gist statistics description: '' operationId: enterprise-admin/get-gist-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-gist-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-gist-overview' examples: default: value: total_gists: 500 private_gists: 30 public_gists: 470 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/hooks: get: summary: APIs.io Engineering Platform Get hooks statistics operationId: enterprise-admin/get-hooks-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-hooks-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-hook-overview' examples: default: value: total_hooks: 50 active_hooks: 47 inactive_hooks: 3 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/issues: get: summary: APIs.io Engineering Platform Get issue statistics description: '' operationId: enterprise-admin/get-issue-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-issue-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-issue-overview' examples: default: value: total_issues: 5000 open_issues: 300 closed_issues: 4700 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/milestones: get: summary: APIs.io Engineering Platform Get milestone statistics description: '' operationId: enterprise-admin/get-milestone-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-milestone-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-milestone-overview' examples: default: value: total_milestones: 90 open_milestones: 10 closed_milestones: 80 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/orgs: get: summary: APIs.io Engineering Platform Get organization statistics description: '' operationId: enterprise-admin/get-org-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-organization-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-organization-overview' examples: default: value: total_orgs: 50 disabled_orgs: 1 total_teams: 70 total_team_members: 700 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/pages: get: summary: APIs.io Engineering Platform Get pages statistics description: '' operationId: enterprise-admin/get-pages-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-pages-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-page-overview' examples: default: value: total_pages: 20 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/pulls: get: summary: APIs.io Engineering Platform Get pull request statistics description: '' operationId: enterprise-admin/get-pull-request-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-pull-request-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-pull-request-overview' examples: default: value: total_pulls: 1200 merged_pulls: 1100 mergeable_pulls: 90 unmergeable_pulls: 10 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/repos: get: summary: APIs.io Engineering Platform Get repository statistics operationId: enterprise-admin/get-repo-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-repository-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-repository-overview' examples: default: value: total_repos: 200 root_repos: 1 fork_repos: 10 org_repos: 150 total_pushes: 39000 total_wikis: 5 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprise/stats/users: get: summary: APIs.io Engineering Platform Get users statistics description: '' operationId: enterprise-admin/get-user-stats tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-users-statistics responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-user-overview' examples: default: value: total_users: 100 admin_users: 3 suspended_users: 1 x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats /enterprises/{enterprise}/actions/permissions: get: summary: APIs.io Engineering Platform Get GitHub Actions permissions for an enterprise description: 'Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' operationId: enterprise-admin/get-github-actions-permissions-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/actions-enterprise-permissions' examples: default: $ref: '#/components/examples/actions-enterprise-permissions' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions put: summary: APIs.io Engineering Platform Set GitHub Actions permissions for an enterprise description: 'Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' operationId: enterprise-admin/set-github-actions-permissions-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: enabled_organizations: $ref: '#/components/schemas/enabled-organizations' allowed_actions: $ref: '#/components/schemas/allowed-actions' required: - enabled_organizations examples: default: value: enabled_organizations: all allowed_actions: selected x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions /enterprises/{enterprise}/actions/permissions/organizations: get: summary: APIs.io Engineering Platform List selected organizations enabled for GitHub Actions in an enterprise description: 'Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' operationId: enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number organizations: type: array items: $ref: '#/components/schemas/organization-simple' required: - total_count - organizations examples: default: $ref: '#/components/examples/organization-targets' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions put: summary: APIs.io Engineering Platform Set selected organizations enabled for GitHub Actions in an enterprise description: 'Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' operationId: enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: selected_organization_ids: description: List of organization IDs to enable for GitHub Actions. type: array items: type: integer description: Unique identifier of the organization. required: - selected_organization_ids examples: default: value: selected_organization_ids: - 32 - 91 x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions /enterprises/{enterprise}/actions/permissions/organizations/{org_id}: put: summary: APIs.io Engineering Platform Enable a selected organization for GitHub Actions in an enterprise description: 'Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' operationId: enterprise-admin/enable-selected-organization-github-actions-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/org-id' responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions delete: summary: APIs.io Engineering Platform Disable a selected organization for GitHub Actions in an enterprise description: 'Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' operationId: enterprise-admin/disable-selected-organization-github-actions-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/org-id' responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions /enterprises/{enterprise}/actions/permissions/selected-actions: get: summary: APIs.io Engineering Platform Get allowed actions for an enterprise description: 'Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' operationId: enterprise-admin/get-allowed-actions-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/selected-actions' examples: default: $ref: '#/components/examples/selected-actions' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions put: summary: APIs.io Engineering Platform Set allowed actions for an enterprise description: 'Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' operationId: enterprise-admin/set-allowed-actions-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '204': description: Response requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/selected-actions' examples: selected_actions: $ref: '#/components/examples/selected-actions' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions /enterprises/{enterprise}/actions/runner-groups: get: summary: APIs.io Engineering Platform List self-hosted runner groups for an enterprise description: 'Lists all self-hosted runner groups for an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/list-self-hosted-runner-groups-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/visible-to-organization' responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number runner_groups: type: array items: $ref: '#/components/schemas/runner-groups-enterprise' required: - total_count - runner_groups examples: default: $ref: '#/components/examples/runner-groups-enterprise' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups post: summary: APIs.io Engineering Platform Create a self-hosted runner group for an enterprise description: 'Creates a new self-hosted runner group for an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/create-self-hosted-runner-group-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the runner group. type: string visibility: description: Visibility of a runner group. You can select all organizations or select individual organization. type: string enum: - selected - all selected_organization_ids: description: List of organization IDs that can access the runner group. type: array items: type: integer description: Unique identifier of the organization. runners: description: List of runner IDs to add to the runner group. type: array items: type: integer description: Unique identifier of the runner. allows_public_repositories: description: Whether the runner group can be used by `public` repositories. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main required: - name examples: default: value: name: Expensive hardware runners visibility: selected selected_organization_ids: - 32 - 91 runners: - 9 - 2 responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/runner-groups-enterprise' examples: default: $ref: '#/components/examples/runner-group-enterprise' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}: get: summary: APIs.io Engineering Platform Get a self-hosted runner group for an enterprise description: 'Gets a specific self-hosted runner group for an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/get-self-hosted-runner-group-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/runner-groups-enterprise' examples: default: $ref: '#/components/examples/runner-group-enterprise' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups patch: summary: APIs.io Engineering Platform Update a self-hosted runner group for an enterprise description: 'Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/update-self-hosted-runner-group-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' requestBody: required: false content: application/json: schema: type: object properties: name: description: Name of the runner group. type: string visibility: description: Visibility of a runner group. You can select all organizations or select individual organizations. type: string enum: - selected - all default: all allows_public_repositories: description: Whether the runner group can be used by `public` repositories. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main examples: default: value: name: Expensive hardware runners visibility: selected responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/runner-groups-enterprise' examples: default: $ref: '#/components/examples/runner-group-update-enterprise' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups delete: summary: APIs.io Engineering Platform Delete a self-hosted runner group from an enterprise description: 'Deletes a self-hosted runner group for an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/delete-self-hosted-runner-group-from-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations: get: summary: APIs.io Engineering Platform List organization access to a self-hosted runner group in an enterprise description: 'Lists the organizations with access to a self-hosted runner group. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number organizations: type: array items: $ref: '#/components/schemas/organization-simple' required: - total_count - organizations examples: default: $ref: '#/components/examples/organization-targets' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups put: summary: APIs.io Engineering Platform Set organization access for a self-hosted runner group in an enterprise description: 'Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' requestBody: required: true content: application/json: schema: type: object properties: selected_organization_ids: description: List of organization IDs that can access the runner group. type: array items: type: integer description: Unique identifier of the organization. required: - selected_organization_ids examples: default: value: selected_organization_ids: - 32 - 91 responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}: put: summary: APIs.io Engineering Platform Add organization access to a self-hosted runner group in an enterprise description: 'Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' - $ref: '#/components/parameters/org-id' responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups delete: summary: APIs.io Engineering Platform Remove organization access to a self-hosted runner group in an enterprise description: 'Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' - $ref: '#/components/parameters/org-id' responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners: get: summary: APIs.io Engineering Platform List self-hosted runners in a group for an enterprise description: 'Lists the self-hosted runners that are in a specific enterprise group. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/list-self-hosted-runners-in-group-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number runners: type: array items: $ref: '#/components/schemas/runner' required: - total_count - runners examples: default: $ref: '#/components/examples/runner-paginated' headers: Link: $ref: '#/components/headers/link' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups put: summary: APIs.io Engineering Platform Set self-hosted runners in a group for an enterprise description: 'Replaces the list of self-hosted runners that are part of an enterprise runner group. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/set-self-hosted-runners-in-group-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' requestBody: required: true content: application/json: schema: type: object properties: runners: description: List of runner IDs to add to the runner group. type: array items: type: integer description: Unique identifier of the runner. required: - runners examples: default: value: runners: - 9 - 2 responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}: put: summary: APIs.io Engineering Platform Add a self-hosted runner to a group for an enterprise description: 'Adds a self-hosted runner to a runner group configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/add-self-hosted-runner-to-group-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' - $ref: '#/components/parameters/runner-id' responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups delete: summary: APIs.io Engineering Platform Remove a self-hosted runner from a group for an enterprise description: 'Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-group-id' - $ref: '#/components/parameters/runner-id' responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups /enterprises/{enterprise}/actions/runners: get: summary: APIs.io Engineering Platform List self-hosted runners for an enterprise description: 'Lists all self-hosted runners configured for an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/list-self-hosted-runners-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number runners: type: array items: $ref: '#/components/schemas/runner' examples: default: $ref: '#/components/examples/runner-paginated' headers: Link: $ref: '#/components/headers/link' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners /enterprises/{enterprise}/actions/runners/downloads: get: summary: APIs.io Engineering Platform List runner applications for an enterprise description: 'Lists binaries for the runner application that you can download and run. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/list-runner-applications-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/runner-application' examples: default: $ref: '#/components/examples/runner-application-items-airgap' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners /enterprises/{enterprise}/actions/runners/registration-token: post: summary: APIs.io Engineering Platform Create a registration token for an enterprise description: 'Returns a token that you can pass to the `config` script. The token expires after one hour. Example using registration token: Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. ``` ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN ``` OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/create-registration-token-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/authentication-token' examples: default: $ref: '#/components/examples/authentication-token' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners /enterprises/{enterprise}/actions/runners/remove-token: post: summary: APIs.io Engineering Platform Create a remove token for an enterprise description: 'Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. Example using remove token: To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this endpoint. ``` ./config.sh remove --token TOKEN ``` OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/create-remove-token-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/authentication-token' examples: default: $ref: '#/components/examples/authentication-token-2' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners /enterprises/{enterprise}/actions/runners/{runner_id}: get: summary: APIs.io Engineering Platform Get a self-hosted runner for an enterprise description: 'Gets a specific self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/get-self-hosted-runner-for-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/runner' examples: default: $ref: '#/components/examples/runner' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners delete: summary: APIs.io Engineering Platform Delete a self-hosted runner from an enterprise description: 'Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' operationId: enterprise-admin/delete-self-hosted-runner-from-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-id' responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners /enterprises/{enterprise}/actions/runners/{runner_id}/labels: get: summary: APIs.io Engineering Platform List labels for a self-hosted runner for an enterprise description: 'Lists all labels for a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin operationId: enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-id' responses: '200': $ref: '#/components/responses/actions_runner_labels' '404': $ref: '#/components/responses/not_found' x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners post: summary: APIs.io Engineering Platform Add custom labels to a self-hosted runner for an enterprise description: 'Add custom labels to a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin operationId: enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-id' requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 1 maxItems: 100 description: The names of the custom labels to add to the runner. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': $ref: '#/components/responses/actions_runner_labels' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners put: summary: APIs.io Engineering Platform Set custom labels for a self-hosted runner for an enterprise description: 'Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin operationId: enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-id' requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 0 maxItems: 100 description: The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': $ref: '#/components/responses/actions_runner_labels' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners delete: summary: APIs.io Engineering Platform Remove all custom labels from a self-hosted runner for an enterprise description: 'Remove all custom labels from a self-hosted runner configured in an enterprise. Returns the remaining read-only labels from the runner. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin operationId: enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-id' responses: '200': $ref: '#/components/responses/actions_runner_labels_readonly' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}: delete: summary: APIs.io Engineering Platform Remove a custom label from a self-hosted runner for an enterprise description: 'Remove a custom label from a self-hosted runner configured in an enterprise. Returns the remaining labels from the runner. This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin operationId: enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/runner-id' - $ref: '#/components/parameters/runner-label-name' responses: '200': $ref: '#/components/responses/actions_runner_labels' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners /enterprises/{enterprise}/audit-log: get: summary: APIs.io Engineering Platform Get the audit log for an enterprise operationId: enterprise-admin/get-audit-log description: 'Gets the audit log for an enterprise. The authenticated user must be an enterprise admin to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/audit-log-enterprise-phrase' - $ref: '#/components/parameters/audit-log-include' - $ref: '#/components/parameters/audit-log-after' - $ref: '#/components/parameters/audit-log-before' - $ref: '#/components/parameters/audit-log-order' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/audit-log-event' examples: default: $ref: '#/components/examples/audit-log' x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: audit-log /enterprises/{enterprise}/code_security_and_analysis: get: summary: APIs.io Engineering Platform Get code security and analysis features for an enterprise description: 'Gets code security and analysis settings for the specified enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin operationId: secret-scanning/get-security-analysis-settings-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-security-analysis-settings' examples: default: $ref: '#/components/examples/enterprise-security-analysis-settings' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis patch: summary: APIs.io Engineering Platform Update code security and analysis features for an enterprise description: 'Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin operationId: secret-scanning/patch-security-analysis-settings-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise parameters: - $ref: '#/components/parameters/enterprise' requestBody: required: false content: application/json: schema: type: object properties: advanced_security_enabled_for_new_repositories: type: boolean description: Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.9/get-started/learning-about-github/about-github-advanced-security)." dependabot_alerts_enabled_for_new_repositories: type: boolean description: Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." secret_scanning_enabled_for_new_repositories: type: boolean description: Whether secret scanning is automatically enabled for new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." secret_scanning_push_protection_custom_link: type: string nullable: true description: 'The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." To disable this functionality, set this field to `null`.' examples: default: value: advanced_security_enabled_for_new_repositories: true dependabot_alerts_enabled_for_new_repositories: true secret_scanning_enabled_for_new_repositories: true secret_scanning_push_protection_enabled_for_new_repositories: true secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md responses: '204': description: Action started '422': description: The action could not be taken due to an in progress enablement, or a policy is preventing enablement '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis /enterprises/{enterprise}/{security_product}/{enablement}: post: summary: APIs.io Engineering Platform Enable or disable a security feature description: 'Enables or disables the specified security feature for all repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.' tags: - Enterprise-Admin operationId: secret-scanning/post-security-product-enablement-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature parameters: - $ref: '#/components/parameters/enterprise' - $ref: '#/components/parameters/enterprise-security-product' - $ref: '#/components/parameters/enterprise-security-product-enablement' responses: '204': description: Action started '422': description: The action could not be taken due to an in progress enablement, or a policy is preventing enablement '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis /manage/v1/config/nodes: get: summary: APIs.io Engineering Platform Get GHES node metadata for all nodes description: Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering)." operationId: enterprise-admin/get-config-nodes tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol parameters: - $ref: '#/components/parameters/uuid' - $ref: '#/components/parameters/cluster-roles' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ghes-config-nodes' examples: default: $ref: '#/components/examples/ghes-config-nodes' '401': description: Unauthorized '500': description: Internal error x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: manage-ghes /manage/v1/replication/status: get: summary: APIs.io Engineering Platform Get the status of services running on all replica nodes description: 'Gets the status of all services running on each replica node. This endpoint may take several seconds to reply.' operationId: enterprise-admin/get-replication-status tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol parameters: - $ref: '#/components/parameters/uuid' - $ref: '#/components/parameters/cluster-roles' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ghes-replication-status' examples: default: $ref: '#/components/examples/ghes-replication-status' '401': description: Unauthorized '500': description: Internal error x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: manage-ghes /manage/v1/version: get: summary: APIs.io Engineering Platform Get all GHES release versions for all nodes description: Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.9/admin/all-releases)." operationId: enterprise-admin/get-version tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol parameters: - $ref: '#/components/parameters/uuid' - $ref: '#/components/parameters/cluster-roles' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ghes-version' examples: default: $ref: '#/components/examples/ghes-version' '401': description: Unauthorized '500': description: Internal error x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: manage-ghes /orgs/{org}/pre-receive-hooks: get: summary: APIs.io Engineering Platform List pre-receive hooks for an organization description: List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed. operationId: enterprise-admin/list-pre-receive-hooks-for-org tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/direction' - name: sort description: The sort order for the response collection. in: query required: false schema: type: string enum: - created - updated - name default: created responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/org-pre-receive-hook' examples: default: $ref: '#/components/examples/org-pre-receive-hook-items' x-github: githubCloudOnly: false enabledForGitHubApps: true category: enterprise-admin subcategory: org-pre-receive-hooks /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}: get: summary: APIs.io Engineering Platform Get a pre-receive hook for an organization description: '' operationId: enterprise-admin/get-pre-receive-hook-for-org tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/pre-receive-hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/org-pre-receive-hook' examples: default: $ref: '#/components/examples/org-pre-receive-hook' x-github: githubCloudOnly: false enabledForGitHubApps: true category: enterprise-admin subcategory: org-pre-receive-hooks patch: summary: APIs.io Engineering Platform Update pre-receive hook enforcement for an organization description: For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration` operationId: enterprise-admin/update-pre-receive-hook-enforcement-for-org tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/pre-receive-hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/org-pre-receive-hook' examples: default: $ref: '#/components/examples/org-pre-receive-hook-2' requestBody: required: false content: application/json: schema: type: object properties: enforcement: description: The state of enforcement for the hook on this repository. type: string allow_downstream_configuration: description: Whether repositories can override enforcement. type: boolean examples: default: value: enforcement: enabled allow_downstream_configuration: false x-github: githubCloudOnly: false enabledForGitHubApps: true category: enterprise-admin subcategory: org-pre-receive-hooks delete: summary: APIs.io Engineering Platform Remove pre-receive hook enforcement for an organization description: Removes any overrides for this hook at the org level for this org. operationId: enterprise-admin/remove-pre-receive-hook-enforcement-for-org tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/pre-receive-hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/org-pre-receive-hook' examples: default: $ref: '#/components/examples/org-pre-receive-hook' x-github: githubCloudOnly: false enabledForGitHubApps: true category: enterprise-admin subcategory: org-pre-receive-hooks /repos/{owner}/{repo}/pre-receive-hooks: get: summary: APIs.io Engineering Platform List pre-receive hooks for a repository description: List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. operationId: enterprise-admin/list-pre-receive-hooks-for-repo tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/direction' - name: sort in: query required: false schema: type: string enum: - created - updated - name default: created responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/repository-pre-receive-hook' examples: default: $ref: '#/components/examples/repository-pre-receive-hook-items' x-github: githubCloudOnly: false enabledForGitHubApps: true category: enterprise-admin subcategory: repo-pre-receive-hooks /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}: get: summary: APIs.io Engineering Platform Get a pre-receive hook for a repository description: '' operationId: enterprise-admin/get-pre-receive-hook-for-repo tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/pre-receive-hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/repository-pre-receive-hook' examples: default: $ref: '#/components/examples/repository-pre-receive-hook' x-github: githubCloudOnly: false enabledForGitHubApps: true category: enterprise-admin subcategory: repo-pre-receive-hooks patch: summary: APIs.io Engineering Platform Update pre-receive hook enforcement for a repository description: For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement` operationId: enterprise-admin/update-pre-receive-hook-enforcement-for-repo tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/pre-receive-hook-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/repository-pre-receive-hook' examples: default: $ref: '#/components/examples/repository-pre-receive-hook-2' requestBody: required: false content: application/json: schema: type: object properties: enforcement: description: The state of enforcement for the hook on this repository. type: string enum: - enabled - disabled - testing examples: default: value: enforcement: enabled x-github: githubCloudOnly: false enabledForGitHubApps: true category: enterprise-admin subcategory: repo-pre-receive-hooks delete: summary: APIs.io Engineering Platform Remove pre-receive hook enforcement for a repository description: 'Deletes any overridden enforcement on this repository for the specified hook. Responds with effective values inherited from owner and/or global level.' operationId: enterprise-admin/remove-pre-receive-hook-enforcement-for-repo tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/pre-receive-hook-id' responses: '200': description: Responds with effective values inherited from owner and/or global level. content: application/json: schema: $ref: '#/components/schemas/repository-pre-receive-hook' examples: default: $ref: '#/components/examples/repository-pre-receive-hook' x-github: githubCloudOnly: false enabledForGitHubApps: true category: enterprise-admin subcategory: repo-pre-receive-hooks /scim/v2/enterprises/{enterprise}/Groups: get: summary: APIs.io Engineering Platform List provisioned SCIM groups for an enterprise description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Lists provisioned SCIM groups in an enterprise. You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.' operationId: enterprise-admin/list-provisioned-groups-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise parameters: - name: filter description: If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. in: query required: false schema: type: string examples: displayName: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - $ref: '#/components/parameters/excluded-attributes' - $ref: '#/components/parameters/start-index' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/enterprise' responses: '200': description: Success, either groups were found or not found content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-group-list' examples: default: $ref: '#/components/examples/scim-enterprise-group-list' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim post: summary: APIs.io Engineering Platform Provision a SCIM enterprise group description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Creates a SCIM group for an enterprise. If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.' operationId: enterprise-admin/provision-enterprise-group tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-group parameters: - $ref: '#/components/parameters/enterprise' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/group' examples: group: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: Engineering responses: '201': description: Group has been created content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-group-response' examples: group: $ref: '#/components/examples/scim-enterprise-group' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '409': $ref: '#/components/responses/duplicate_record_detected' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}: get: summary: APIs.io Engineering Platform Get SCIM provisioning information for an enterprise group description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Gets information about a SCIM group.' operationId: enterprise-admin/get-provisioning-information-for-enterprise-group tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - $ref: '#/components/parameters/scim-group-id' - $ref: '#/components/parameters/excluded-attributes' - $ref: '#/components/parameters/enterprise' responses: '200': description: Success, a group was found content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-group-response' examples: default: $ref: '#/components/examples/scim-enterprise-group' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '404': $ref: '#/components/responses/not_found' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim put: summary: APIs.io Engineering Platform Set SCIM information for a provisioned enterprise group description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don''t provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.' operationId: enterprise-admin/set-information-for-provisioned-enterprise-group tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - $ref: '#/components/parameters/scim-group-id' - $ref: '#/components/parameters/enterprise' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/group' examples: group: summary: Group value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: Engineering groupWithMembers: summary: Group with member value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: Engineering members: - value: 879db59-3bdf-4490-ad68-ab880a2694745 displayName: User 1 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 responses: '200': description: Group was updated content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-group-response' examples: group: $ref: '#/components/examples/scim-enterprise-group' groupWithMembers: $ref: '#/components/examples/scim-enterprise-group' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '404': $ref: '#/components/responses/not_found' '409': $ref: '#/components/responses/duplicate_record_detected' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim patch: summary: APIs.io Engineering Platform Update an attribute for a SCIM enterprise group description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Update a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.' operationId: enterprise-admin/update-attribute-for-enterprise-group tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - $ref: '#/components/parameters/scim-group-id' - $ref: '#/components/parameters/enterprise' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/patch-schema' examples: updateGroup: summary: Update Group value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: displayName value: Employees addMembers: summary: Add Members value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: add path: members value: - value: 879db59-3bdf-4490-ad68-ab880a2694745 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 responses: '204': description: Response '200': description: Success, group was updated content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-group-response' examples: updateGroup: $ref: '#/components/examples/scim-enterprise-group' addMembers: $ref: '#/components/examples/scim-enterprise-group' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '404': $ref: '#/components/responses/not_found' '409': $ref: '#/components/responses/duplicate_record_detected' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim delete: summary: APIs.io Engineering Platform Delete a SCIM group from an enterprise description: "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise." operationId: enterprise-admin/delete-scim-group-from-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - $ref: '#/components/parameters/scim-group-id' - $ref: '#/components/parameters/enterprise' responses: '204': description: Group was deleted, no content '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '404': $ref: '#/components/responses/not_found' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim /scim/v2/enterprises/{enterprise}/Users: get: summary: APIs.io Engineering Platform List SCIM provisioned identities for an enterprise description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Lists provisioned SCIM enterprise members. When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account''s metadata is preserved to allow the user to re-join the enterprise in the future. However, the user''s account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.' operationId: enterprise-admin/list-provisioned-identities-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise parameters: - name: filter description: If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. in: query required: false schema: type: string examples: userName: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - $ref: '#/components/parameters/start-index' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/enterprise' responses: '200': description: Success, either users were found or not found content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-user-list' examples: default: $ref: '#/components/examples/scim-enterprise-user-list' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim post: summary: APIs.io Engineering Platform Provision a SCIM enterprise user description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Creates an external identity for a new SCIM enterprise user. SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user''s handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.' operationId: enterprise-admin/provision-enterprise-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-user parameters: - $ref: '#/components/parameters/enterprise' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/user' examples: user: $ref: '#/components/examples/in-user' enterpriseOwner: $ref: '#/components/examples/in-user-owner' responses: '201': description: User has been created content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-user-response' examples: user: $ref: '#/components/examples/scim-enterprise-user' enterpriseOwner: $ref: '#/components/examples/scim-enterprise-user' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '409': $ref: '#/components/responses/duplicate_record_detected' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}: get: summary: APIs.io Engineering Platform Get SCIM provisioning information for an enterprise user description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Gets information about a SCIM user.' operationId: enterprise-admin/get-provisioning-information-for-enterprise-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - $ref: '#/components/parameters/scim-user-id' - $ref: '#/components/parameters/enterprise' responses: '200': description: Success, a user was found content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-user-response' examples: default: $ref: '#/components/examples/scim-enterprise-user' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '404': $ref: '#/components/responses/not_found' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim put: summary: APIs.io Engineering Platform Set SCIM information for a provisioned enterprise user description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Replaces an existing provisioned user''s information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don''t provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.' operationId: enterprise-admin/set-information-for-provisioned-enterprise-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - $ref: '#/components/parameters/scim-user-id' - $ref: '#/components/parameters/enterprise' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/user' examples: user: $ref: '#/components/examples/in-user' responses: '200': description: User was updated content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-user-response' examples: user: $ref: '#/components/examples/scim-enterprise-user' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '404': $ref: '#/components/responses/not_found' '409': $ref: '#/components/responses/duplicate_record_detected' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim patch: summary: APIs.io Engineering Platform Update an attribute for a SCIM enterprise user description: "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```" operationId: enterprise-admin/update-attribute-for-enterprise-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - $ref: '#/components/parameters/scim-user-id' - $ref: '#/components/parameters/enterprise' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/patch-schema' examples: userMultiValuedProperties: summary: Multi Valued Property value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: emails[type eq 'work'].value value: updatedEmail@microsoft.com - op: replace path: name.familyName value: updatedFamilyName userSingleValuedProperties: summary: Single Valued Property value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: userName value: 5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com - op: replace path: displayName value: Monalisa Octocat disableUser: summary: Disable User value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: active value: false responses: '200': description: Success, user was updated content: application/scim+json: schema: $ref: '#/components/schemas/scim-enterprise-user-response' examples: userMultiValuedProperties: $ref: '#/components/examples/scim-enterprise-user' userSingleValuedProperties: $ref: '#/components/examples/scim-enterprise-user' disableUser: $ref: '#/components/examples/scim-enterprise-user' '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '404': $ref: '#/components/responses/not_found' '409': $ref: '#/components/responses/duplicate_record_detected' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim delete: summary: APIs.io Engineering Platform Delete a SCIM user from an enterprise description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.' operationId: enterprise-admin/delete-user-from-enterprise tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - $ref: '#/components/parameters/scim-user-id' - $ref: '#/components/parameters/enterprise' responses: '204': description: User was deleted, no content '400': $ref: '#/components/responses/scim_bad_request' '401': $ref: '#/components/responses/authorization_failure' '403': $ref: '#/components/responses/permission_denied' '404': $ref: '#/components/responses/not_found' '429': $ref: '#/components/responses/scim_too_many_requests' '500': $ref: '#/components/responses/scim_internal_error' x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim /setup/api/configcheck: get: summary: APIs.io Engineering Platform Get the configuration status description: 'This endpoint allows you to check the status of the most recent configuration process: Note that you may need to wait several seconds after you start a process before you can check its status. The different statuses are: | Status | Description | | ------------- | --------------------------------- | | `PENDING` | The job has not started yet | | `CONFIGURING` | The job is running | | `DONE` | The job has finished correctly | | `FAILED` | The job has finished unexpectedly |' operationId: enterprise-admin/get-configuration-status tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-the-configuration-status servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/configuration-status' examples: default: $ref: '#/components/examples/configuration-status' '401': description: Unauthorized x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console /setup/api/configure: post: summary: APIs.io Engineering Platform Start a configuration process description: 'This endpoint allows you to start a configuration process at any time for your updated settings to take effect:' operationId: enterprise-admin/start-configuration-process tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '202': description: Response '401': description: Unauthorized x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console /setup/api/maintenance: get: summary: APIs.io Engineering Platform Get the maintenance status description: 'Check your installation''s maintenance status:' operationId: enterprise-admin/get-maintenance-status tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-the-maintenance-status servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/maintenance-status' examples: default: $ref: '#/components/examples/maintenance-status' '401': description: Unauthorized x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console post: summary: APIs.io Engineering Platform Enable or disable maintenance mode description: '**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).' operationId: enterprise-admin/enable-or-disable-maintenance-mode tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/maintenance-status' examples: default: $ref: '#/components/examples/maintenance-status' '401': description: Unauthorized requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: maintenance: type: string description: 'A JSON string with the attributes `enabled` and `when`. The possible values for `enabled` are `true` and `false`. When it''s `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).' required: - maintenance examples: default: value: maintenance: '{"enabled":true, "when":"now"}' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console /setup/api/settings: get: summary: APIs.io Engineering Platform Get settings description: 'Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings). **Note:** You cannot retrieve the management console password with the Enterprise administration API.' operationId: enterprise-admin/get-settings tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/enterprise-settings' examples: default: $ref: '#/components/examples/enterprise-settings' '401': description: Unauthorized x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console put: summary: APIs.io Engineering Platform Set settings description: 'Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). **Notes:** - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)."' operationId: enterprise-admin/set-settings tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '204': description: Response '401': description: Unauthorized requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: settings: type: string description: A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). required: - settings examples: '204': value: settings: '{ "enterprise": { "public_pages": true }}' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console /setup/api/settings/authorized-keys: get: summary: APIs.io Engineering Platform Get all authorized SSH keys description: '' operationId: enterprise-admin/get-all-authorized-ssh-keys tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ssh-key' examples: default: $ref: '#/components/examples/ssh-key-items' '401': description: Unauthorized x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console post: summary: APIs.io Engineering Platform Add an authorized SSH key description: '**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).' operationId: enterprise-admin/add-authorized-ssh-key tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#add-an-authorized-ssh-key servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '201': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ssh-key' examples: default: $ref: '#/components/examples/ssh-key-items' '401': description: Unauthorized requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: authorized_key: type: string description: The public SSH key. required: - authorized_key examples: default: value: authorized_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw== x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console delete: summary: APIs.io Engineering Platform Remove an authorized SSH key description: '**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).' operationId: enterprise-admin/remove-authorized-ssh-key tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ssh-key' examples: default: $ref: '#/components/examples/ssh-key-items' '401': description: Unauthorized requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: authorized_key: type: string description: The public SSH key. required: - authorized_key examples: default: value: authorized_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw== x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console /setup/api/start: post: summary: APIs.io Engineering Platform Create a GitHub license description: 'When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: 1. If you''re working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).' operationId: enterprise-admin/create-enterprise-server-license tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#create-a-github-license servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '202': description: Response '401': description: Unauthorized requestBody: required: true content: multipart/form-data: schema: type: object properties: license: type: string description: The content of your _.ghl_ license file. password: type: string description: You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. settings: type: string description: An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). required: - license examples: default: value: license: '@enterprise.ghl' password: secret x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console /setup/api/upgrade: post: summary: APIs.io Engineering Platform Upgrade a license description: 'This API upgrades your license and also triggers the configuration process. **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).' operationId: enterprise-admin/upgrade-license tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#upgrade-a-license servers: - url: '{protocol}://{hostname}' variables: hostname: default: HOSTNAME description: Self-hosted Enterprise Server hostname protocol: default: http description: Self-hosted Enterprise Server protocol responses: '202': description: Response '401': description: Unauthorized requestBody: required: false content: multipart/form-data: schema: type: object properties: license: type: string description: The content of your new _.ghl_ license file. examples: default: value: license: '@enterprise.ghl' x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: management-console /users/{username}/site_admin: put: summary: APIs.io Engineering Platform Promote a user to be a site administrator description: Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." operationId: enterprise-admin/promote-user-to-be-site-administrator tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator parameters: - $ref: '#/components/parameters/username' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users delete: summary: APIs.io Engineering Platform Demote a site administrator description: You can demote any user account except your own. operationId: enterprise-admin/demote-site-administrator tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#demote-a-site-administrator parameters: - $ref: '#/components/parameters/username' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users /users/{username}/suspended: put: summary: APIs.io Engineering Platform Suspend a user description: 'If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. You can suspend any user account except your own. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)."' operationId: enterprise-admin/suspend-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user parameters: - $ref: '#/components/parameters/username' responses: '204': description: Response requestBody: required: false content: application/json: schema: type: object nullable: true properties: reason: type: string description: The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Suspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. examples: reason: value: reason: Suspended during leave of absence. x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users delete: summary: APIs.io Engineering Platform Unsuspend a user description: If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. operationId: enterprise-admin/unsuspend-user tags: - Enterprise-Admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#unsuspend-a-user parameters: - $ref: '#/components/parameters/username' responses: '204': description: Response requestBody: content: application/json: schema: type: object nullable: true properties: reason: type: string description: The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Unsuspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. examples: reason: value: reason: Unsuspended after leave of absence. x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-admin subcategory: users components: schemas: nullable-simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url nullable: true repository-pre-receive-hook: type: object properties: id: type: integer name: type: string enforcement: type: string configuration_url: type: string scim-enterprise-group-response: allOf: - $ref: '#/components/schemas/group-response' - type: object properties: id: type: string description: The internally generated id for the group object. example: 7fce0092-d52e-4f76-b727-3955bd72c939 members: type: array items: type: object properties: value: type: string $ref: type: string display: type: string description: The security group members. example: - value: 879db59-3bdf-4490-ad68-ab880a2694745 $+ref: https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 displayName: User 1 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 $+ref: https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 meta: $ref: '#/components/schemas/meta' repository: title: Repository description: A repository on GitHub. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: $ref: '#/components/schemas/nullable-license-simple' forks: type: integer permissions: type: object properties: admin: type: boolean pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean required: - admin - pull - push owner: $ref: '#/components/schemas/simple-user' private: description: Whether the repository is private or public. default: false type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true deprecated: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: true archived: description: Whether the repository is archived. default: false type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' default: public type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false allow_update_branch: description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. default: false type: boolean example: false use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: 'The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request''s title. - `COMMIT_OR_PR_TITLE` - default to the commit''s title (if only one commit) or the pull request''s title (when more than one commit).' squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: 'The default value for a squash merge commit message: - `PR_BODY` - default to the pull request''s body. - `COMMIT_MESSAGES` - default to the branch''s commit messages. - `BLANK` - default to a blank commit message.' merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: 'The default value for a merge commit title. - `PR_TITLE` - default to the pull request''s title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).' merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: 'The default value for a merge commit message. - `PR_TITLE` - default to the pull request''s title. - `PR_BODY` - default to the pull request''s body. - `BLANK` - default to a blank commit message.' allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_forking: description: Whether to allow forking this repo type: boolean web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean open_issues: type: integer watchers: type: integer master_branch: type: string starred_at: type: string example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at announcement-expiration: type: string format: date-time description: 'The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true announcement-message: type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.9/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true global-hook-2: type: object properties: type: type: string id: type: integer name: type: string active: type: boolean events: type: array items: type: string config: type: object properties: url: type: string content_type: type: string insecure_ssl: type: string updated_at: type: string created_at: type: string url: type: string ping_url: type: string ghes-cluster-topology: type: string enum: - SingleNode - Ha - Cluster enterprise-overview: type: object properties: repos: $ref: '#/components/schemas/enterprise-repository-overview' hooks: $ref: '#/components/schemas/enterprise-hook-overview' pages: $ref: '#/components/schemas/enterprise-page-overview' orgs: $ref: '#/components/schemas/enterprise-organization-overview' users: $ref: '#/components/schemas/enterprise-user-overview' pulls: $ref: '#/components/schemas/enterprise-pull-request-overview' issues: $ref: '#/components/schemas/enterprise-issue-overview' milestones: $ref: '#/components/schemas/enterprise-milestone-overview' gists: $ref: '#/components/schemas/enterprise-gist-overview' comments: $ref: '#/components/schemas/enterprise-comment-overview' runner-label: title: Self hosted runner label description: A label for a self hosted runner type: object properties: id: type: integer description: Unique identifier of the label. name: type: string description: Name of the label. type: type: string description: The type of label. Read-only labels are applied automatically when the runner is configured. enum: - read-only - custom required: - name user: type: object required: - schemas - externalId - userName - active - displayName - emails properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the SCIM schemas. items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:User example: - urn:ietf:params:scim:schemas:core:2.0:User externalId: type: string description: A unique identifier for the resource as defined by the provisioning client. example: E012345 active: type: boolean description: Whether the user active in the IdP. example: true userName: type: string description: The username for the user. example: E012345 name: $ref: '#/components/schemas/user-name' displayName: type: string description: A human-readable name for the user. example: Mona Lisa emails: $ref: '#/components/schemas/user-emails' roles: $ref: '#/components/schemas/user-role' license-info: type: object properties: seats: oneOf: - type: string - type: integer seats_used: type: integer seats_available: oneOf: - type: string - type: integer kind: type: string days_until_expiration: type: integer expire_at: type: string scim-enterprise-user-list: type: object required: - schemas - totalResults - Resources - startIndex - itemsPerPage properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the list SCIM schemas. items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:ListResponse example: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: type: integer description: Number of results found example: 1 Resources: type: array description: Information about each provisioned account. items: $ref: '#/components/schemas/scim-enterprise-user-response' startIndex: type: integer description: A starting index for the returned page example: 1 itemsPerPage: type: integer description: Number of objects per page example: 20 pre-receive-environment: type: object properties: id: type: integer format: int64 name: type: string image_url: type: string url: type: string html_url: type: string default_environment: type: boolean created_at: type: string hooks_count: type: integer download: type: object properties: url: type: string state: type: string downloaded_at: nullable: true type: string message: nullable: true type: string runner-application: title: Runner Application description: Runner Application type: object properties: os: type: string architecture: type: string download_url: type: string filename: type: string temp_download_token: description: A short lived bearer token used to download the runner, if needed. type: string sha256_checksum: type: string required: - os - architecture - download_url - filename enterprise-hook-overview: title: Hooks Enterprise Stats type: object properties: total_hooks: type: integer active_hooks: type: integer inactive_hooks: type: integer required: - total_hooks - active_hooks - inactive_hooks org-pre-receive-hook: type: object properties: id: type: integer name: type: string enforcement: type: string configuration_url: type: string allow_downstream_configuration: type: boolean patch-schema: type: object required: - Operations - schemas properties: Operations: type: array description: patch operations list items: type: object required: - op properties: op: type: string enum: - add - replace - remove path: type: string value: type: string description: Corresponding 'value' of that field specified by 'path' schemas: type: array items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:PatchOp announcement: title: Enterprise Announcement description: Enterprise global announcement type: object properties: announcement: $ref: '#/components/schemas/announcement-message' expires_at: $ref: '#/components/schemas/announcement-expiration' required: - announcement authorization: title: Authorization description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object properties: id: type: integer format: int64 url: type: string format: uri scopes: description: A list of scopes that this authorization is in. type: array items: type: string nullable: true token: type: string token_last_eight: type: string nullable: true hashed_token: type: string nullable: true app: type: object properties: client_id: type: string name: type: string url: type: string format: uri required: - client_id - name - url note: type: string nullable: true note_url: type: string format: uri nullable: true updated_at: type: string format: date-time created_at: type: string format: date-time fingerprint: type: string nullable: true user: $ref: '#/components/schemas/nullable-simple-user' installation: $ref: '#/components/schemas/nullable-scoped-installation' expires_at: type: string format: date-time nullable: true required: - app - id - note - note_url - scopes - token - hashed_token - token_last_eight - fingerprint - url - created_at - updated_at - expires_at ssh-key: type: object properties: key: type: string pretty-print: type: string group-response: type: object required: - schemas properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the SCIM schemas. items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:Group - urn:ietf:params:scim:api:messages:2.0:ListResponse example: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: type: string description: A unique identifier for the resource as defined by the provisioning client. example: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 nullable: true displayName: type: string description: A human-readable name for a security group. example: Engineering nullable: true members: type: array description: The group members. items: type: object required: - value - $ref properties: value: type: string description: The local unique identifier for the member example: 23a35c27-23d3-4c03-b4c5-6443c09e7173 $ref: type: string display: type: string description: The display name associated with the member example: Monalisa Octocat ghes-config-nodes: type: object properties: topology: $ref: '#/components/schemas/ghes-cluster-topology' nodes: type: array items: type: object properties: hostname: type: string uuid: type: string replica: type: boolean cluster_roles: type: array items: $ref: '#/components/schemas/ghes-cluster-roles' user-emails-response: type: array description: The emails for the user. items: type: object required: - value properties: value: type: string description: The email address. example: mlisa@example.com type: type: string description: The type of email address. example: work primary: type: boolean description: Whether this email address is the primary address. example: true enterprise-milestone-overview: title: Enterprise Milestone Stats type: object properties: total_milestones: type: integer open_milestones: type: integer closed_milestones: type: integer required: - total_milestones - open_milestones - closed_milestones configuration-status: type: object properties: status: type: string progress: type: array items: type: object properties: status: type: string key: type: string required: - status - key basic-error: title: Basic Error description: Basic Error type: object properties: message: type: string documentation_url: type: string url: type: string status: type: string authentication-token: title: Authentication Token description: Authentication Token type: object properties: token: description: The token used for authentication type: string example: v1.1f699f1069f60xxx expires_at: description: The time this token expires type: string format: date-time example: '2016-07-11T22:14:10Z' permissions: type: object example: issues: read deployments: write repositories: description: The repositories this token has access to type: array items: $ref: '#/components/schemas/repository' single_file: type: string example: config.yaml nullable: true repository_selection: description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected required: - token - expires_at scim-enterprise-user-response: allOf: - $ref: '#/components/schemas/user-response' - type: object required: - id - meta properties: id: type: string description: The internally generated id for the user object. example: 7fce0092-d52e-4f76-b727-3955bd72c939 groups: type: array items: type: object properties: value: type: string $ref: type: string display: type: string description: Provisioned SCIM groups that the user is a member of. meta: $ref: '#/components/schemas/meta' app-permissions: title: App Permissions type: object description: The permissions granted to the user access token. properties: actions: type: string description: The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. enum: - read - write administration: type: string description: The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. enum: - read - write checks: type: string description: The level of permission to grant the access token for checks on code. enum: - read - write codespaces: type: string description: The level of permission to grant the access token to create, edit, delete, and list Codespaces. enum: - read - write contents: type: string description: The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. enum: - read - write dependabot_secrets: type: string description: The leve of permission to grant the access token to manage Dependabot secrets. enum: - read - write deployments: type: string description: The level of permission to grant the access token for deployments and deployment statuses. enum: - read - write environments: type: string description: The level of permission to grant the access token for managing repository environments. enum: - read - write issues: type: string description: The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. enum: - read - write metadata: type: string description: The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. enum: - read - write packages: type: string description: The level of permission to grant the access token for packages published to GitHub Packages. enum: - read - write pages: type: string description: The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. enum: - read - write pull_requests: type: string description: The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. enum: - read - write repository_hooks: type: string description: The level of permission to grant the access token to manage the post-receive hooks for a repository. enum: - read - write repository_projects: type: string description: The level of permission to grant the access token to manage repository projects, columns, and cards. enum: - read - write - admin secret_scanning_alerts: type: string description: The level of permission to grant the access token to view and manage secret scanning alerts. enum: - read - write secrets: type: string description: The level of permission to grant the access token to manage repository secrets. enum: - read - write security_events: type: string description: The level of permission to grant the access token to view and manage security events like code scanning alerts. enum: - read - write single_file: type: string description: The level of permission to grant the access token to manage just a single file. enum: - read - write statuses: type: string description: The level of permission to grant the access token for commit statuses. enum: - read - write vulnerability_alerts: type: string description: The level of permission to grant the access token to manage Dependabot alerts. enum: - read - write workflows: type: string description: The level of permission to grant the access token to update GitHub Actions workflow files. enum: - write members: type: string description: The level of permission to grant the access token for organization teams and members. enum: - read - write organization_administration: type: string description: The level of permission to grant the access token to manage access to an organization. enum: - read - write organization_custom_roles: type: string description: The level of permission to grant the access token for custom repository roles management. enum: - read - write organization_copilot_seat_management: type: string description: The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. enum: - write organization_announcement_banners: type: string description: The level of permission to grant the access token to view and manage announcement banners for an organization. enum: - read - write organization_events: type: string description: The level of permission to grant the access token to view events triggered by an activity in an organization. enum: - read organization_hooks: type: string description: The level of permission to grant the access token to manage the post-receive hooks for an organization. enum: - read - write organization_personal_access_tokens: type: string description: The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. enum: - read - write organization_personal_access_token_requests: type: string description: The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. enum: - read - write organization_plan: type: string description: The level of permission to grant the access token for viewing an organization's plan. enum: - read organization_projects: type: string description: The level of permission to grant the access token to manage organization projects and projects beta (where available). enum: - read - write - admin organization_packages: type: string description: The level of permission to grant the access token for organization packages published to GitHub Packages. enum: - read - write organization_secrets: type: string description: The level of permission to grant the access token to manage organization secrets. enum: - read - write organization_self_hosted_runners: type: string description: The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. enum: - read - write organization_user_blocking: type: string description: The level of permission to grant the access token to view and manage users blocked by the organization. enum: - read - write team_discussions: type: string description: The level of permission to grant the access token to manage team discussions and related comments. enum: - read - write email_addresses: type: string description: The level of permission to grant the access token to manage the email addresses belonging to a user. enum: - read - write followers: type: string description: The level of permission to grant the access token to manage the followers belonging to a user. enum: - read - write git_ssh_keys: type: string description: The level of permission to grant the access token to manage git SSH keys. enum: - read - write gpg_keys: type: string description: The level of permission to grant the access token to view and manage GPG keys belonging to a user. enum: - read - write interaction_limits: type: string description: The level of permission to grant the access token to view and manage interaction limits on a repository. enum: - read - write profile: type: string description: The level of permission to grant the access token to manage the profile settings belonging to a user. enum: - write starring: type: string description: The level of permission to grant the access token to list and manage repositories a user is starring. enum: - read - write example: contents: read issues: read deployments: write single_file: read enterprise-security-analysis-settings: title: Enterprise Security Analysis Settings type: object properties: advanced_security_enabled_for_new_repositories: type: boolean example: false description: 'Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to this enterprise.' dependabot_alerts_enabled_for_new_repositories: type: boolean example: false description: 'Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this enterprise.' secret_scanning_enabled_for_new_repositories: type: boolean example: false description: 'Whether secret scanning is automatically enabled for new repositories and repositories transferred to this enterprise.' secret_scanning_push_protection_enabled_for_new_repositories: type: boolean example: false description: 'Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this enterprise.' secret_scanning_push_protection_custom_link: type: string nullable: true example: https://github.com/test-org/test-repo/blob/main/README.md description: An optional URL string to display to contributors who are blocked from pushing a secret. required: - advanced_security_enabled_for_new_repositories - dependabot_alerts_enabled_for_new_repositories - secret_scanning_enabled_for_new_repositories - secret_scanning_push_protection_enabled_for_new_repositories scim-error: title: Scim Error description: Scim Error type: object properties: message: type: string nullable: true documentation_url: type: string nullable: true detail: type: string nullable: true status: type: integer scimType: type: string nullable: true schemas: type: array items: type: string global-hook: type: object properties: type: type: string id: type: integer name: type: string active: type: boolean events: type: array items: type: string config: type: object properties: url: type: string content_type: type: string insecure_ssl: type: string secret: type: string updated_at: type: string created_at: type: string url: type: string ping_url: type: string public-key-full: type: object properties: id: type: integer format: int64 key: type: string user_id: nullable: true type: integer repository_id: nullable: true type: integer format: int64 url: type: string title: type: string read_only: type: boolean verified: type: boolean created_at: type: string format: date-time added_by: type: string nullable: true last_used: nullable: true type: string format: date-time required: - id - key - url - title - verified - created_at - read_only - last_used - user_id - repository_id actions-enterprise-permissions: type: object properties: enabled_organizations: $ref: '#/components/schemas/enabled-organizations' selected_organizations_url: type: string description: The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. allowed_actions: $ref: '#/components/schemas/allowed-actions' selected_actions_url: $ref: '#/components/schemas/selected-actions-url' required: - enabled_organizations ghes-version: type: array items: type: object properties: hostname: type: string format: hostname version: type: object properties: version: type: string pattern: '[0-9]\.[0-9]{2}\.[0-9]' platform: type: string enum: - ami - azure - esx - gce - hyperv - kvm build_id: type: string pattern: '[0-9a-f]{8}' build_date: type: string format: date enterprise-comment-overview: title: Enterprise Comment Stats type: object properties: total_commit_comments: type: integer total_gist_comments: type: integer total_issue_comments: type: integer total_pull_request_comments: type: integer required: - total_commit_comments - total_gist_comments - total_issue_comments - total_pull_request_comments ldap-mapping-user: title: Ldap Private User description: Ldap Private User type: object properties: ldap_dn: type: string login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean name: type: string example: monalisa octocat nullable: true company: type: string example: GitHub nullable: true blog: type: string example: https://github.com/blog nullable: true location: type: string example: San Francisco nullable: true email: type: string format: email example: octocat@github.com nullable: true hireable: type: boolean nullable: true bio: type: string example: There once was... nullable: true twitter_username: type: string example: monalisa nullable: true public_repos: type: integer example: 2 public_gists: type: integer example: 1 followers: type: integer example: 20 following: type: integer example: 0 created_at: type: string format: date-time example: '2008-01-14T04:33:35Z' updated_at: type: string format: date-time example: '2008-01-14T04:33:35Z' private_gists: type: integer example: 81 total_private_repos: type: integer example: 100 owned_private_repos: type: integer example: 100 disk_usage: type: integer example: 10000 collaborators: type: integer example: 8 two_factor_authentication: type: boolean example: true plan: type: object properties: collaborators: type: integer name: type: string space: type: integer private_repos: type: integer required: - collaborators - name - space - private_repos suspended_at: type: string format: date-time nullable: true business_plus: type: boolean required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url - bio - blog - company - email - followers - following - hireable - location - name - public_gists - public_repos - created_at - updated_at - collaborators - disk_usage - owned_private_repos - private_gists - total_private_repos - two_factor_authentication user-name: type: object required: - familyName - givenName properties: formatted: type: string description: The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. example: Ms. Mona Lisa Octocat familyName: type: string description: The family name of the user. example: Octocat givenName: type: string description: The given name of the user. example: Mona middleName: type: string description: The middle name(s) of the user. example: Lisa enterprise-gist-overview: title: Enterprise Gist Stats type: object properties: total_gists: type: integer private_gists: type: integer public_gists: type: integer required: - total_gists - private_gists - public_gists selected-actions-url: type: string description: The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. user-response: type: object required: - schemas - active - emails properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the SCIM schemas. items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:User example: - urn:ietf:params:scim:schemas:core:2.0:User externalId: type: string description: A unique identifier for the resource as defined by the provisioning client. example: E012345 nullable: true active: type: boolean description: Whether the user active in the IdP. example: true userName: type: string description: The username for the user. example: E012345 name: $ref: '#/components/schemas/user-name-response' displayName: type: string description: A human-readable name for the user. example: Mona Lisa nullable: true emails: $ref: '#/components/schemas/user-emails-response' roles: $ref: '#/components/schemas/user-role' nullable-scoped-installation: title: Scoped Installation type: object properties: permissions: $ref: '#/components/schemas/app-permissions' repository_selection: description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected single_file_name: type: string example: config.yaml nullable: true has_multiple_single_files: type: boolean example: true single_file_paths: type: array items: type: string example: - config.yml - .github/issue_TEMPLATE.md repositories_url: type: string format: uri example: https://api.github.com/users/octocat/repos account: $ref: '#/components/schemas/simple-user' required: - permissions - repository_selection - single_file_name - repositories_url - account nullable: true enterprise-pull-request-overview: title: Enterprise Pull Request Stats type: object properties: total_pulls: type: integer merged_pulls: type: integer mergeable_pulls: type: integer unmergeable_pulls: type: integer required: - total_pulls - merged_pulls - mergeable_pulls - unmergeable_pulls enterprise-issue-overview: title: Enterprise Issue Stats type: object properties: total_issues: type: integer open_issues: type: integer closed_issues: type: integer required: - total_issues - open_issues - closed_issues validation-error-simple: title: Validation Error Simple description: Validation Error Simple type: object required: - message - documentation_url properties: message: type: string documentation_url: type: string errors: type: array items: type: string meta: type: object description: The metadata associated with the creation/updates to the user. required: - resourceType properties: resourceType: type: string description: A type of a resource enum: - User - Group example: User created: type: string description: A date and time when the user was created. example: '2022-03-27T19:59:26.000Z' lastModified: type: string description: A data and time when the user was last modified. example: '2022-03-27T19:59:26.000Z' location: type: string description: A URL location of an object user-emails: type: array description: The emails for the user. items: type: object required: - value - type - primary properties: value: type: string description: The email address. example: mlisa@example.com type: type: string description: The type of email address. example: work primary: type: boolean description: Whether this email address is the primary address. example: true allowed-actions: type: string description: The permissions policy that controls the actions that are allowed to run. enum: - all - local_only - selected pre-receive-environment-download-status: type: object properties: url: type: string state: type: string downloaded_at: nullable: true type: string message: nullable: true type: string enabled-organizations: type: string description: The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. enum: - all - none - selected pre-receive-hook: type: object properties: id: type: integer name: type: string enforcement: type: string script: type: string script_repository: type: object properties: id: type: integer full_name: type: string url: type: string html_url: type: string environment: type: object properties: id: type: integer format: int64 name: type: string image_url: type: string url: type: string html_url: type: string default_environment: type: boolean created_at: type: string hooks_count: type: integer download: type: object properties: url: type: string state: type: string downloaded_at: nullable: true type: string message: nullable: true type: string allow_downstream_configuration: type: boolean group: type: object required: - schemas - externalId - displayName - members properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the SCIM schemas. items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:Group example: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: type: string description: A unique identifier for the resource as defined by the provisioning client. example: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: type: string description: A human-readable name for a security group. example: Engineering members: type: array description: The group members. items: type: object required: - value - displayName properties: value: type: string description: The local unique identifier for the member example: 23a35c27-23d3-4c03-b4c5-6443c09e7173 displayName: type: string description: The display name associated with the member example: Monalisa Octocat enterprise-page-overview: title: Enterprise Pages Stats type: object properties: total_pages: type: integer required: - total_pages enterprise-settings: type: object properties: enterprise: type: object properties: private_mode: type: boolean public_pages: type: boolean subdomain_isolation: type: boolean signup_enabled: type: boolean github_hostname: type: string identicons_host: type: string http_proxy: nullable: true type: string auth_mode: type: string expire_sessions: type: boolean admin_password: nullable: true type: string configuration_id: type: integer configuration_run_count: type: integer avatar: type: object properties: enabled: type: boolean uri: type: string customer: type: object properties: name: type: string email: type: string uuid: type: string secret_key_data: type: string public_key_data: type: string license: type: object properties: seats: type: integer evaluation: type: boolean perpetual: type: boolean unlimited_seating: type: boolean support_key: type: string ssh_allowed: type: boolean cluster_support: type: boolean expire_at: type: string github_ssl: type: object properties: enabled: type: boolean cert: nullable: true type: string key: nullable: true type: string ldap: type: object properties: host: nullable: true type: string port: type: integer base: type: array items: {} uid: nullable: true type: string bind_dn: nullable: true type: string password: nullable: true type: string method: type: string search_strategy: type: string user_groups: type: array items: {} admin_group: nullable: true type: string virtual_attribute_enabled: type: boolean recursive_group_search: type: boolean posix_support: type: boolean user_sync_emails: type: boolean user_sync_keys: type: boolean user_sync_interval: type: integer team_sync_interval: type: integer sync_enabled: type: boolean reconciliation: type: object properties: user: nullable: true type: string org: nullable: true type: string profile: type: object properties: uid: type: string name: nullable: true type: string mail: nullable: true type: string key: nullable: true type: string cas: type: object properties: url: nullable: true type: string saml: type: object properties: sso_url: nullable: true type: string certificate: nullable: true type: string certificate_path: nullable: true type: string issuer: nullable: true type: string idp_initiated_sso: type: boolean disable_admin_demote: type: boolean github_oauth: type: object properties: client_id: type: string client_secret: type: string organization_name: type: string organization_team: type: string smtp: type: object properties: enabled: type: boolean address: type: string authentication: type: string port: type: string domain: type: string username: type: string user_name: type: string enable_starttls_auto: type: boolean password: type: string discard-to-noreply-address: type: boolean support_address: type: string support_address_type: type: string noreply_address: type: string ntp: type: object properties: primary_server: type: string secondary_server: type: string timezone: nullable: true type: string snmp: type: object properties: enabled: type: boolean community: type: string syslog: type: object properties: enabled: type: boolean server: nullable: true type: string protocol_name: type: string assets: nullable: true type: string pages: type: object properties: enabled: type: boolean collectd: type: object properties: enabled: type: boolean server: nullable: true type: string port: type: integer encryption: nullable: true type: string username: nullable: true type: string password: nullable: true type: string mapping: type: object properties: enabled: type: boolean tileserver: nullable: true type: string basemap: type: string token: nullable: true type: string load_balancer: nullable: true type: string run_list: type: array items: type: string enterprise-user-overview: title: Enterprise User Stats type: object properties: total_users: type: integer admin_users: type: integer suspended_users: type: integer required: - total_users - admin_users - suspended_users organization-simple: title: Organization Simple description: A GitHub organization. type: object properties: login: type: string example: github id: type: integer example: 1 node_id: type: string example: MDEyOk9yZ2FuaXphdGlvbjE= url: type: string format: uri example: https://api.github.com/orgs/github repos_url: type: string format: uri example: https://api.github.com/orgs/github/repos events_url: type: string format: uri example: https://api.github.com/orgs/github/events hooks_url: type: string example: https://api.github.com/orgs/github/hooks issues_url: type: string example: https://api.github.com/orgs/github/issues members_url: type: string example: https://api.github.com/orgs/github/members{/member} public_members_url: type: string example: https://api.github.com/orgs/github/public_members{/member} avatar_url: type: string example: https://github.com/images/error/octocat_happy.gif description: type: string example: A great organization nullable: true required: - login - url - id - node_id - repos_url - events_url - hooks_url - issues_url - members_url - public_members_url - avatar_url - description maintenance-status: type: object properties: status: type: string scheduled_time: type: string connection_services: type: array items: type: object properties: name: type: string number: type: integer required: - name - number enterprise-organization-overview: title: Enterprise Organization Stats type: object properties: total_orgs: type: integer disabled_orgs: type: integer total_teams: type: integer total_team_members: type: integer required: - total_orgs - disabled_orgs - total_teams - total_team_members runner: title: Self hosted runners description: A self hosted runner type: object properties: id: description: The id of the runner. type: integer example: 5 runner_group_id: description: The id of the runner group. type: integer example: 1 name: description: The name of the runner. type: string example: iMac os: description: The Operating System of the runner. type: string example: macos status: description: The status of the runner. type: string example: online busy: type: boolean labels: type: array items: $ref: '#/components/schemas/runner-label' required: - id - name - os - status - busy - labels ghes-replication-status-indicator: type: string enum: - UNKNOWN - OK - WARNING - CRITICAL ghes-replication-status: type: object properties: status: $ref: '#/components/schemas/ghes-replication-status-indicator' nodes: type: array items: type: object properties: hostname: type: string status: $ref: '#/components/schemas/ghes-replication-status-indicator' services: type: array items: type: object properties: status: $ref: '#/components/schemas/ghes-replication-status-indicator' name: type: string details: type: string simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url user-name-response: type: object properties: formatted: type: string description: The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. example: Ms. Mona Lisa Octocat familyName: type: string description: The family name of the user. example: Octocat givenName: type: string description: The given name of the user. example: Mona middleName: type: string description: The middle name(s) of the user. example: Lisa scim-enterprise-group-list: type: object required: - schemas - totalResults - Resources - startIndex - itemsPerPage properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the list SCIM schemas. items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:ListResponse example: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: type: integer description: Number of results found example: 1 Resources: type: array description: Information about each provisioned group. items: $ref: '#/components/schemas/scim-enterprise-group-response' startIndex: type: integer description: A starting index for the returned page example: 1 itemsPerPage: type: integer description: Number of objects per page example: 20 nullable-license-simple: title: License Simple description: License Simple type: object properties: key: type: string example: mit name: type: string example: MIT License url: type: string nullable: true format: uri example: https://api.github.com/licenses/mit spdx_id: type: string nullable: true example: MIT node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri required: - key - name - url - spdx_id - node_id nullable: true audit-log-event: type: object properties: '@timestamp': type: integer description: The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). action: type: string description: The name of the action that was performed, for example `user.login` or `repo.create`. active: type: boolean active_was: type: boolean actor: type: string description: The actor who performed the action. actor_id: type: integer description: The id of the actor who performed the action. actor_location: type: object properties: country_name: type: string data: type: object additionalProperties: true org_id: type: integer user_id: type: integer business_id: type: integer blocked_user: type: string description: The username of the account being blocked. business: type: string config: type: array items: type: object config_was: type: array items: type: object content_type: type: string operation_type: type: string created_at: type: integer description: The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). deploy_key_fingerprint: type: string _document_id: type: string description: A unique identifier for an audit event. emoji: type: string events: type: array items: type: object events_were: type: array items: type: object explanation: type: string fingerprint: type: string hook_id: type: integer limited_availability: type: boolean message: type: string name: type: string old_user: type: string openssh_public_key: type: string org: type: string previous_visibility: type: string read_only: type: boolean repo: type: string description: The name of the repository. repository: type: string description: The name of the repository. repository_public: type: boolean target_login: type: string team: type: string transport_protocol: type: integer description: The type of protocol (for example, HTTP or SSH) used to transfer Git data. transport_protocol_name: type: string description: A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. user: type: string description: The user that was affected by the action performed (if available). visibility: type: string description: The repository visibility, for example `public` or `private`. runner-groups-enterprise: type: object properties: id: type: number name: type: string visibility: type: string default: type: boolean selected_organizations_url: type: string runners_url: type: string allows_public_repositories: type: boolean workflow_restrictions_read_only: description: If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main required: - id - name - visibility - allows_public_repositories - default - runners_url user-role: type: array description: The roles assigned to the user. items: type: object required: - value properties: display: type: string type: type: string value: type: string description: The role value representing a user role in GitHub. enum: - user - 27d9891d-2c17-4f45-a262-781a0e55c80a - guest_collaborator - 1ebc4a02-e56c-43a6-92a5-02ee09b90824 - enterprise_owner - 981df190-8801-4618-a08a-d91f6206c954 - ba4987ab-a1c3-412a-b58c-360fc407cb10 - billing_manager - 0e338b8c-cc7f-498a-928d-ea3470d7e7e3 - e6be2762-e4ad-4108-b72d-1bbe884a0f91 example: user primary: type: boolean description: Is the role a primary role for the user. example: false ghes-cluster-roles: type: string enum: - Blank - ActionsServer - ConsulServer - ElasticsearchServer - GitServer - JobServer - LaunchServer - MemcacheServer - MetricsServer - MssqlServer - MysqlServer - PagesServer - RedisServer - StorageServer - WebServer enterprise-repository-overview: title: Repository Enterprise Stats type: object properties: total_repos: type: integer root_repos: type: integer fork_repos: type: integer org_repos: type: integer total_pushes: type: integer total_wikis: type: integer required: - total_repos - root_repos - fork_repos - org_repos - total_pushes - total_wikis selected-actions: type: object properties: github_owned_allowed: type: boolean description: Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. patterns_allowed: type: array description: Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. items: type: string required: - github_owned_allowed - patterns_allowed ldap-mapping-team: type: object properties: ldap_dn: type: string id: type: integer node_id: type: string url: type: string html_url: type: string name: type: string slug: type: string description: type: string nullable: true privacy: type: string permission: type: string members_url: type: string repositories_url: type: string parent: nullable: true parameters: scim-user-id: name: scim_user_id description: The unique identifier of the SCIM user. in: path required: true schema: type: string username: name: username description: The handle for the GitHub user account. in: path required: true schema: type: string runner-group-id: name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true schema: type: integer audit-log-before: name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. in: query required: false schema: type: string visible-to-organization: name: visible_to_organization description: Only return runner groups that are allowed to be used by this organization. in: query required: false schema: type: string org-id: name: org_id description: The unique identifier of the organization. in: path required: true schema: type: integer excluded-attributes: name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. in: query required: false schema: type: string example: members hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. in: path required: true schema: type: integer audit-log-include: name: include description: 'The event types to include: - `web` - returns web (non-Git) events. - `git` - returns Git events. - `all` - returns both web and Git events. The default is `web`.' in: query required: false schema: type: string enum: - web - git - all runner-label-name: name: name description: The name of a self-hosted runner's custom label. in: path required: true schema: type: string repo: name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. in: path required: true schema: type: string per-page: name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 scim-group-id: name: scim_group_id description: A unique identifier of the SCIM group. in: path required: true schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 key-ids: name: key_ids description: The unique identifier of the key. in: path required: true schema: type: string pre-receive-environment-id: name: pre_receive_environment_id description: The unique identifier of the pre-receive environment. in: path required: true schema: type: integer team-id: name: team_id description: The unique identifier of the team. in: path required: true schema: type: integer count: name: count description: 'Used for pagination: the number of results to return per page.' in: query required: false schema: type: integer default: 30 format: int32 example: 1 enterprise-security-product-enablement: name: enablement in: path description: 'The action to take. `enable_all` means to enable the specified security feature for all repositories in the enterprise. `disable_all` means to disable the specified security feature for all repositories in the enterprise.' required: true schema: type: string enum: - enable_all - disable_all enterprise: name: enterprise description: The slug version of the enterprise name. You can also substitute this value with the enterprise id. in: path required: true schema: type: string audit-log-order: name: order description: 'The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. The default is `desc`.' in: query required: false schema: type: string enum: - desc - asc cluster-roles: name: cluster_roles description: The cluster roles from the cluster configuration file. in: query required: false schema: type: string pre-receive-hook-id: name: pre_receive_hook_id description: The unique identifier of the pre-receive hook. in: path required: true schema: type: integer org: name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string audit-log-after: name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. in: query required: false schema: type: string token-id: name: token_id description: The unique identifier of the token. in: path required: true schema: type: integer runner-id: name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true schema: type: integer audit-log-enterprise-phrase: name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). in: query required: false schema: type: string uuid: name: uuid description: The UUID which identifies a node. in: query required: false schema: type: string owner: name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string direction: name: direction description: The direction to sort the results by. in: query required: false schema: type: string enum: - asc - desc default: desc enterprise-security-product: name: security_product in: path description: The security feature to enable or disable. required: true schema: type: string enum: - advanced_security - dependabot_alerts - secret_scanning - secret_scanning_push_protection start-index: name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' in: query required: false schema: type: integer default: 1 format: int32 example: 1 page: name: page description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 responses: scim_bad_request: description: Bad request content: application/json: schema: $ref: '#/components/schemas/scim-error' application/scim+json: schema: $ref: '#/components/schemas/scim-error' permission_denied: description: Permission denied actions_runner_labels: description: Response content: application/json: schema: type: object required: - total_count - labels properties: total_count: type: integer labels: type: array items: $ref: '#/components/schemas/runner-label' examples: default: $ref: '#/components/examples/runner-labels' duplicate_record_detected: description: Duplicate record detected actions_runner_labels_readonly: description: Response content: application/json: schema: type: object required: - total_count - labels properties: total_count: type: integer labels: type: array items: $ref: '#/components/schemas/runner-label' examples: default: $ref: '#/components/examples/runner-labels-readonly' scim_internal_error: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/scim-error' application/scim+json: schema: $ref: '#/components/schemas/scim-error' validation_failed_simple: description: Validation failed, or the endpoint has been spammed. content: application/json: schema: $ref: '#/components/schemas/validation-error-simple' authorization_failure: description: Authorization failure not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' scim_too_many_requests: description: Too many requests content: application/json: schema: $ref: '#/components/schemas/scim-error' application/scim+json: schema: $ref: '#/components/schemas/scim-error' examples: ldap-mapping-team: value: ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com id: 1 node_id: MDQ6VGVhbTE= url: https://api.github.com/teams/1 html_url: https://github.com/orgs/github/teams/justice-league name: Justice League slug: justice-league description: A great team. privacy: closed notification_setting: notifications_enabled permission: admin members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: null org-pre-receive-hook-2: value: id: 42 name: Check Commits enforcement: enabled configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 allow_downstream_configuration: false repository-pre-receive-hook: value: id: 42 name: Check Commits enforcement: disabled configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 enterprise-overview: value: repos: total_repos: 212 root_repos: 194 fork_repos: 18 org_repos: 51 total_pushes: 3082 total_wikis: 15 hooks: total_hooks: 27 active_hooks: 23 inactive_hooks: 4 pages: total_pages: 36 orgs: total_orgs: 33 disabled_orgs: 0 total_teams: 60 total_team_members: 314 users: total_users: 254 admin_users: 45 suspended_users: 21 pulls: total_pulls: 86 merged_pulls: 60 mergeable_pulls: 21 unmergeable_pulls: 3 issues: total_issues: 179 open_issues: 83 closed_issues: 96 milestones: total_milestones: 7 open_milestones: 6 closed_milestones: 1 gists: total_gists: 178 private_gists: 151 public_gists: 25 comments: total_commit_comments: 6 total_gist_comments: 28 total_issue_comments: 366 total_pull_request_comments: 30 in-user: summary: User value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User externalId: E012345 active: true userName: E012345 name: formatted: Ms. Mona Lisa Octocat familyName: Octocat givenName: Mona middleName: Lisa displayName: Mona Lisa emails: - value: mlisa@example.com type: work primary: true roles: - value: User primary: false license-info: value: seats: 1400 seats_used: 1316 seats_available: 84 kind: standard days_until_expiration: 365 expire_at: 2016/02/06 12:41:52 -0600 authentication-token-2: value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' selected-actions: value: github_owned_allowed: true verified_allowed: false patterns_allowed: - monalisa/octocat@* - docker/* announcement: summary: Announcement banner value: announcement: Very **important** announcement about _something_. expires_at: '2021-01-01T00:00:00.000+00:00' user_dismissible: false repository-pre-receive-hook-2: value: id: 42 name: Check Commits enforcement: enabled configuration_url: https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 enterprise-security-analysis-settings: value: advanced_security_enabled_for_new_repositories: true dependabot_alerts_enabled_for_new_repositories: true secret_scanning_enabled_for_new_repositories: true secret_scanning_push_protection_enabled_for_new_repositories: true secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md in-user-owner: summary: Enterprise Owner value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User externalId: E012345 active: true userName: E012345 name: formatted: Ms. Mona Lisa Octocat familyName: Octocat givenName: Mona middleName: Lisa displayName: Mona Lisa emails: - value: mlisa@example.com type: work primary: true roles: - value: Enterprise Owner primary: false configuration-status: value: status: running progress: - status: DONE key: Appliance core components - status: DONE key: GitHub utilities - status: DONE key: GitHub applications - status: CONFIGURING key: GitHub services - status: PENDING key: Reloading appliance services runner-groups-enterprise: value: total_count: 3 runner_groups: - id: 1 name: Default visibility: all default: true runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners allows_public_repositories: false restricted_to_workflows: false selected_workflows: [] workflow_restrictions_read_only: false - id: 2 name: octo-runner-group visibility: selected default: false selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners allows_public_repositories: true restricted_to_workflows: true selected_workflows: - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main workflow_restrictions_read_only: false - id: 3 name: expensive-hardware visibility: private default: false runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners allows_public_repositories: true restricted_to_workflows: false selected_workflows: - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main workflow_restrictions_read_only: false scim-enterprise-group: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: Engineering members: - value: 879db59-3bdf-4490-ad68-ab880a2694745 $+ref: https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 displayName: User 1 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 $+ref: https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 meta: resourceType: Group created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e audit-log: value: - actor_ip: 88.123.45.123 from: pull_requests#merge device_cookie: null actor: mona-admin actor_id: 7 repo: octo-org/octo-repo repo_id: 17 business: github business_id: 1 org: octo-org org_id: 8 action: pull_request.merge '@timestamp': 1635940599755 created_at: 1635940599755 operation_type: modify actor_location: country_code: GB country_name: United Kingdom region: ENG region_name: England city: Louth postal_code: LN11 location: lat: 53.4457 lon: 0.141 data: user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... method: POST request_id: e4dabc4d-ba16-4bca-1234-649be7ae1188 server_id: 5d17aab5-fd9f-abcd-a820-16bed246441b request_category: other controller_action: merge url: https://example.com/octo-org/octo-repo/pull/1/merge client_id: 322299977.1635936 referrer: https://example.com/octo-org/octo-repo/pull/1 actor_session: 1 pull_request_id: 1 category_type: Resource Management - actor_ip: 88.123.45.123 from: pull_request_review_events#create device_cookie: null actor: mona-admin actor_id: 7 business_id: 1 org_id: 8 action: pull_request_review.submit '@timestamp': 1635940593079 created_at: 1635940593079 operation_type: modify actor_location: country_code: GB country_name: United Kingdom region: ENG region_name: England city: Louth postal_code: LN11 location: lat: 53.4457 lon: 0.141 data: user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... method: PUT request_id: c0f63bb7-17b6-4796-940c-12345c5a581b server_id: 2abc1234-f651-43e3-9696-e942ad5f8c89 request_category: other controller_action: create url: https://example.com/octo-org/octo-repo/pull/1/reviews client_id: 322299977.1635936 referrer: https://example.com/octo-org/octo-repo/pull/1/files actor_session: 1 spammy: false pull_request_id: 1 body: null allowed: true id: 1 state: 40 issue_id: 1 review_id: 1 category_type: Resource Management - actor_ip: 88.123.45.123 from: pull_requests#create device_cookie: null actor: mona actor_id: 9 user_id: 9 repo: octo-org/octo-repo repo_id: 17 business: github business_id: 1 org: octo-org org_id: 8 action: pull_request.create '@timestamp': 1635940554161 created_at: 1635940554161 operation_type: create actor_location: country_code: GB country_name: United Kingdom region: ENG region_name: England city: Louth postal_code: LN11 location: lat: 53.4457 lon: 0.141 data: user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... method: POST request_id: 2773abeb-477f-4ebf-a017-f8e8a206c305 server_id: 796e3115-4ce8-4606-8fd0-99ea57a2e12b request_category: other controller_action: create url: https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1 client_id: 386351111.163594 referrer: https://example.com/octo-org/octo-repo/compare/main...mona:patch-1 actor_session: 2 pull_request_id: 1 category_type: Resource Management runner: value: id: 23 name: MBP os: macos status: online busy: true labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 20 name: macOS type: read-only - id: 21 name: no-gpu type: custom pre-receive-environment-download-status: value: url: https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest state: success downloaded_at: '2016-05-26T07:42:53-05:00' message: null pre-receive-hook: value: id: 1 name: Check Commits enforcement: disabled script: scripts/commmit_check.sh script_repository: id: 595 full_name: DevIT/hooks url: https://github.example.com/api/v3/repos/DevIT/hooks html_url: https://github.example.com/DevIT/hooks environment: id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz url: https://github.example.com/api/v3/admin/pre-receive-environments/2 html_url: https://github.example.com/admin/pre-receive-environments/2 default_environment: false created_at: '2016-05-20T11:35:45-05:00' hooks_count: 1 download: url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest state: success downloaded_at: '2016-05-26T07:42:53-05:00' message: null allow_downstream_configuration: false organization-simple: value: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= url: https://api.github.com/orgs/github repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events hooks_url: https://api.github.com/orgs/github/hooks issues_url: https://api.github.com/orgs/github/issues members_url: https://api.github.com/orgs/github/members{/member} public_members_url: https://api.github.com/orgs/github/public_members{/member} avatar_url: https://github.com/images/error/octocat_happy.gif description: A great organization pre-receive-environment-download-status-default-response: value: url: https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest state: not_started downloaded_at: null message: null authorization: value: id: 1 url: https://api.github.com/authorizations/1 scopes: - public_repo token: ghu_16C7e42F292c6912E7710c838347Ae178B4a token_last_eight: Ae178B4a hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 app: url: http://my-github-app.com name: my github app client_id: abcde12345fghij67890 note: optional note note_url: http://optional/note/url updated_at: '2011-09-06T20:39:23Z' created_at: '2011-09-06T17:26:27Z' expires_at: '2011-10-06T17:26:27Z' fingerprint: jklmnop12345678 pre-receive-environment-default-response: value: id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz url: https://github.example.com/api/v3/admin/pre-receive-environments/2 html_url: https://github.example.com/admin/pre-receive-environments/2 default_environment: false created_at: '2016-05-20T11:35:45-05:00' hooks_count: 1 download: url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest state: success downloaded_at: '2016-05-26T07:42:53-05:00' message: null global-hook-2: value: type: Global id: 1 name: web active: true events: - organization config: url: https://example.com content_type: form insecure_ssl: '0' updated_at: '2017-12-07T00:14:59Z' created_at: '2017-12-07T00:14:59Z' url: https://api.github.com/admin/hooks/1 ping_url: https://api.github.com/admin/hooks/1/pings repository-pre-receive-hook-items: value: - id: 42 name: Check Commits enforcement: disabled configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 enterprise-settings: value: enterprise: private_mode: false public_pages: false subdomain_isolation: true signup_enabled: false github_hostname: ghe.local identicons_host: dotcom http_proxy: null auth_mode: default expire_sessions: false admin_password: null configuration_id: 1401777404 configuration_run_count: 4 avatar: enabled: false uri: '' customer: name: GitHub email: stannis@themannis.biz uuid: af6cac80-e4e1-012e-d822-1231380e52e9 secret_key_data: '-----BEGIN PGP PRIVATE KEY BLOCK----- Version: GnuPG v1.4.10 (GNU/Linux) lQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx... -----END PGP PRIVATE KEY BLOCK----- ' public_key_data: '-----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1.4.10 (GNU/Linux) mI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7.... -----END PGP PUBLIC KEY BLOCK----- ' license: seats: 0 evaluation: false perpetual: false unlimited_seating: true support_key: ssh-rsa AAAAB3N.... ssh_allowed: true cluster_support: false expire_at: '2016-04-27T00:00:00-07:00' github_ssl: enabled: false cert: null key: null ldap: host: null port: 0 base: [] uid: null bind_dn: null password: null method: Plain search_strategy: detect user_groups: [] admin_group: null virtual_attribute_enabled: false recursive_group_search: false posix_support: true user_sync_emails: false user_sync_keys: false user_sync_interval: 4 team_sync_interval: 4 sync_enabled: false reconciliation: user: null org: null profile: uid: uid name: null mail: null key: null cas: url: null saml: sso_url: null certificate: null certificate_path: null issuer: null idp_initiated_sso: false disable_admin_demote: false github_oauth: client_id: '12313412' client_secret: kj123131132 organization_name: Homestar Runners organization_team: homestarrunners/characters smtp: enabled: true address: smtp.example.com authentication: plain port: '1234' domain: blah username: foo user_name: mr_foo enable_starttls_auto: true password: bar discard-to-noreply-address: true support_address: enterprise@github.com support_address_type: email noreply_address: noreply@github.com ntp: primary_server: 0.pool.ntp.org secondary_server: 1.pool.ntp.org timezone: null snmp: enabled: false community: '' syslog: enabled: false server: null protocol_name: udp assets: null pages: enabled: true collectd: enabled: false server: null port: 0 encryption: null username: null password: null mapping: enabled: true tileserver: null basemap: company.map-qsz2zrvs token: null load_balancer: null run_list: - recipe[enterprise-configure] pre-receive-hook-items: value: - id: 1 name: Check Commits enforcement: disabled script: scripts/commmit_check.sh script_repository: id: 595 full_name: DevIT/hooks url: https://github.example.com/api/v3/repos/DevIT/hooks html_url: https://github.example.com/DevIT/hooks environment: id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz url: https://github.example.com/api/v3/admin/pre-receive-environments/2 html_url: https://github.example.com/admin/pre-receive-environments/2 default_environment: false created_at: '2016-05-20T11:35:45-05:00' hooks_count: 1 download: url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest state: success downloaded_at: '2016-05-26T07:42:53-05:00' message: null allow_downstream_configuration: false runner-application-items-airgap: value: - os: osx architecture: x64 download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz filename: actions-runner-osx-x64-2.277.1.tar.gz temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA sha256_checksum: f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b - os: linux architecture: x64 download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz filename: actions-runner-linux-x64-2.277.1.tar.gz temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA sha256_checksum: 02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98 - os: linux architecture: arm download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz filename: actions-runner-linux-arm-2.277.1.tar.gz temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw sha256_checksum: 2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85 - os: win architecture: x64 download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip filename: actions-runner-win-x64-2.277.1.zip temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA sha256_checksum: 7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30 - os: linux architecture: arm64 download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz filename: actions-runner-linux-arm64-2.277.1.tar.gz temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA sha256_checksum: a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64 simple-user: value: 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 org-pre-receive-hook-items: value: - id: 42 name: Check Commits enforcement: disabled configuration_url: https://github.example.com/api/v3/admin/pre-receive-hooks/42 allow_downstream_configuration: true ghes-config-nodes: value: topology: Cluster nodes: - hostname: data1 uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb cluster_roles: - ConsulServer - ElasticsearchServer - GitServer - StorageServer - hostname: data2 uuid: 228406d4-f97c-11ed-ab01-062281bbcf03 cluster_roles: - ElasticsearchServer - StorageServer - PagesServer scim-enterprise-group-list: value: schemas: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: 1 Resources: - schemas: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 id: 927fa2c08dcb4a7fae9e displayName: Engineering members: - value: 879db59-3bdf-4490-ad68-ab880a2694745 $+ref: https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 displayName: User 1 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 $+ref: https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 meta: resourceType: Group created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e startIndex: 1 itemsPerPage: 20 ldap-mapping-user: value: ldap_dn: uid=asdf,ou=users,dc=github,dc=com 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 name: monalisa octocat company: GitHub blog: https://github.com/blog location: San Francisco email: octocat@github.com hireable: false bio: There once was... twitter_username: monatheoctocat public_repos: 2 public_gists: 1 followers: 20 following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' private_gists: 81 total_private_repos: 100 owned_private_repos: 100 disk_usage: 10000 collaborators: 8 two_factor_authentication: true plan: name: Medium space: 400 private_repos: 20 collaborators: 0 runner-labels: value: total_count: 4 labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 20 name: macOS type: read-only - id: 21 name: no-gpu type: custom global-hook: value: type: Global id: 1 name: web active: true events: - organization - user config: url: https://example.com content_type: json insecure_ssl: '0' secret: '********' updated_at: '2017-12-07T00:14:59Z' created_at: '2017-12-07T00:14:59Z' url: https://api.github.com/admin/hooks/1 ping_url: https://api.github.com/admin/hooks/1/pings runner-group-update-enterprise: value: id: 2 name: Expensive hardware runners visibility: selected default: false selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners allows_public_repositories: true restricted_to_workflows: false selected_workflows: - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main workflow_restrictions_read_only: false pre-receive-environment-items: value: - id: 1 name: Default image_url: githubenterprise://internal url: https://github.example.com/api/v3/admin/pre-receive-environments/1 html_url: https://github.example.com/admin/pre-receive-environments/1 default_environment: true created_at: '2016-05-20T11:35:45-05:00' hooks_count: 14 download: url: https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest state: not_started downloaded_at: '2016-05-26T07:42:53-05:00' message: null - id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz url: https://github.example.com/api/v3/admin/pre-receive-environments/2 html_url: https://github.example.com/admin/pre-receive-environments/2 default_environment: false created_at: '2016-05-20T11:35:45-05:00' hooks_count: 1 download: url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest state: success downloaded_at: '2016-05-26T07:42:53-05:00' message: null ssh-key-items: value: - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 scim-enterprise-user: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User id: 7fce0092-d52e-4f76-b727-3955bd72c939 externalId: E012345 active: true userName: E012345 name: formatted: Ms. Mona Lisa Octocat familyName: Octocat givenName: Mona middleName: Lisa displayName: Mona Lisa emails: - value: mlisa@example.com type: work primary: true roles: - value: User primary: false meta: resourceType: User created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 authorization-items: value: - id: 2 url: https://enterprise.octocat.com/api/v3/authorizations/2 app: name: My personal access token url: https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens client_id: '00000000000000000000' token: ghp_16C7e42F292c6912E7710c838347Ae178B4a hashed_token: 23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45 token_last_eight: Ae178B4a note: My personal access token note_url: null created_at: '2019-04-24T21:49:02Z' updated_at: '2019-04-24T21:49:02Z' scopes: - admin:business - admin:gpg_key - admin:org - admin:org_hook - admin:pre_receive_hook - admin:public_key - admin:repo_hook - delete_repo - gist - notifications - repo - user - write:discussion fingerprint: null runner-paginated: value: total_count: 2 runners: - id: 23 name: linux_runner os: linux status: online busy: true labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 11 name: Linux type: read-only - id: 24 name: mac_runner os: macos status: offline busy: false labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 20 name: macOS type: read-only - id: 21 name: no-gpu type: custom maintenance-status: value: status: scheduled scheduled_time: Tuesday, January 22 at 15:34 -0800 connection_services: - name: git operations number: 0 - name: mysql queries number: 233 - name: aqueduct jobs number: 34 - name: resque jobs number: 54 ghes-version: value: - hostname: ghe-local-primary version: version: 3.9.0 platform: azure build_id: fc542058b5 build_date: '2023-05-02' enterprise-public-key-items: value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 url: https://api.github.com/user/keys/2 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' verified: false read_only: false last_used: '2020-06-11T22:31:57Z' user_id: 1 repository_id: 2 - key: 9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234 id: 3 url: https://api.github.com/user/keys/2 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' verified: false read_only: false last_used: '2020-06-11T22:31:57Z' user_id: 1 repository_id: 2 pre-receive-hook-2: value: id: 1 name: Check Commits enforcement: disabled script: scripts/commmit_check.sh script_repository: id: 595 full_name: DevIT/hooks url: https://github.example.com/api/v3/repos/DevIT/hooks html_url: https://github.example.com/DevIT/hooks environment: id: 1 name: Default image_url: githubenterprise://internal url: https://github.example.com/api/v3/admin/pre-receive-environments/1 html_url: https://github.example.com/admin/pre-receive-environments/1 default_environment: true created_at: '2016-05-20T11:35:45-05:00' hooks_count: 1 download: url: https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest state: success downloaded_at: '2016-05-26T07:42:53-05:00' message: null allow_downstream_configuration: true actions-enterprise-permissions: value: enabled_organizations: all allowed_actions: selected selected_actions_url: https://api.github.com/enterprises/2/actions/permissions/selected-actions authentication-token: value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' runner-group-enterprise: value: id: 2 name: octo-runner-group visibility: selected default: false selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners allows_public_repositories: false restricted_to_workflows: true selected_workflows: - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main workflow_restrictions_read_only: false org-pre-receive-hook: value: id: 42 name: Check Commits enforcement: disabled configuration_url: https://github.example.com/api/v3/admin/pre-receive-hooks/42 allow_downstream_configuration: true ghes-replication-status: value: status: OK nodes: - hostname: ghe-local-primary status: OK services: [] - hostname: ghe-local-replica status: OK services: - status: OK name: redis details: replication is in sync - status: OK name: elasticsearch details: cluster is in sync (0 shards initializing, 0 shards unassigned) - status: OK name: git details: replication is in sync - status: OK name: pages details: replication is in sync - status: OK name: alambic details: replication is in sync - status: OK name: git-hooks details: replication is in sync - status: OK name: consul details: replication is in sync - status: OK name: mysql details: replication is in sync pre-receive-environment: value: id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz url: https://github.example.com/api/v3/admin/pre-receive-environments/2 html_url: https://github.example.com/admin/pre-receive-environments/2 default_environment: false created_at: '2016-05-20T11:35:45-05:00' hooks_count: 1 download: url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest state: not_started downloaded_at: null message: null scim-enterprise-user-list: value: schemas: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: 1 Resources: - schemas: - urn:ietf:params:scim:schemas:core:2.0:User externalId: E012345 id: 7fce0092-d52e-4f76-b727-3955bd72c939 active: true userName: E012345 name: formatted: Ms. Mona Lisa Octocat familyName: Octocat givenName: Mona middleName: Lisa displayName: Mona Lisa emails: - value: mlisa@example.com type: work primary: true roles: - value: User primary: false startIndex: 1 itemsPerPage: 20 global-hook-items: value: - type: Global id: 1 name: web active: true events: - organization - user config: url: https://example.com content_type: json insecure_ssl: '0' secret: '********' updated_at: '2017-12-07T00:14:59Z' created_at: '2017-12-07T00:14:59Z' url: https://api.github.com/admin/hooks/1 ping_url: https://api.github.com/admin/hooks/1/pings runner-labels-readonly: value: total_count: 3 labels: - id: 5 name: self-hosted type: read-only - id: 7 name: X64 type: read-only - id: 20 name: macOS type: read-only organization-targets: value: total_count: 1 organizations: - login: octocat id: 161335 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 url: https://api.github.com/orgs/octo-org repos_url: https://api.github.com/orgs/octo-org/repos events_url: https://api.github.com/orgs/octo-org/events hooks_url: https://api.github.com/orgs/octo-org/hooks issues_url: https://api.github.com/orgs/octo-org/issues members_url: https://api.github.com/orgs/octo-org/members{/member} public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} avatar_url: https://github.com/images/error/octocat_happy.gif description: A great organization headers: link: example: ; rel="next", ; rel="last" schema: type: string securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true