{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Enterprise-Admin API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Enterprise-Admin", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform List global webhooks", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/hooks", "params": [ { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" } ] }, "docs": "APIs.io Engineering Platform List global webhooks" }, { "info": { "name": "APIs.io Engineering Platform Create a global webhook", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/hooks", "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Create a global webhook" }, { "info": { "name": "APIs.io Engineering Platform Get a global webhook", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "APIs.io Engineering Platform Get a global webhook" }, { "info": { "name": "APIs.io Engineering Platform Update a global webhook", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/admin/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Parameters that are not provided will be overwritten with the default value or removed if no default exists." }, { "info": { "name": "APIs.io Engineering Platform Delete a global webhook", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/admin/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "APIs.io Engineering Platform Delete a global webhook" }, { "info": { "name": "APIs.io Engineering Platform Ping a global webhook", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/hooks/:hook_id/pings", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the webhook." }, { "info": { "name": "APIs.io Engineering Platform List public keys", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/keys", "params": [ { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query", "description": "Only show public keys accessed after the given time." } ] }, "docs": "APIs.io Engineering Platform List public keys" }, { "info": { "name": "APIs.io Engineering Platform Delete a public key", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/admin/keys/:key_ids", "params": [ { "name": "key_ids", "value": "", "type": "path", "description": "The unique identifier of the key." } ] }, "docs": "APIs.io Engineering Platform Delete a public key" }, { "info": { "name": "APIs.io Engineering Platform Update LDAP mapping for a team", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/admin/ldap/teams/:team_id/mapping", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Sync LDAP mapping for a team", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/ldap/teams/:team_id/sync", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." } ] }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Update LDAP mapping for a user", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/admin/ldap/users/:username/mapping", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Update LDAP mapping for a user" }, { "info": { "name": "APIs.io Engineering Platform Sync LDAP mapping for a user", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/ldap/users/:username/sync", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Create an organization", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/organizations", "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Create an organization" }, { "info": { "name": "APIs.io Engineering Platform Update an organization name", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/admin/organizations/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Update an organization name" }, { "info": { "name": "APIs.io Engineering Platform List pre-receive environments", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-environments", "params": [ { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "", "type": "query" } ] }, "docs": "APIs.io Engineering Platform List pre-receive environments" }, { "info": { "name": "APIs.io Engineering Platform Create a pre-receive environment", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-environments", "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Create a pre-receive environment" }, { "info": { "name": "APIs.io Engineering Platform Get a pre-receive environment", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-environments/:pre_receive_environment_id", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ] }, "docs": "APIs.io Engineering Platform Get a pre-receive environment" }, { "info": { "name": "APIs.io Engineering Platform Update a pre-receive environment", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-environments/:pre_receive_environment_id", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response." }, { "info": { "name": "APIs.io Engineering Platform Delete a pre-receive environment", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-environments/:pre_receive_environment_id", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ] }, "docs": "If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_" }, { "info": { "name": "APIs.io Engineering Platform Start a pre-receive environment download", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-environments/:pre_receive_environment_id/downloads", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ] }, "docs": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_" }, { "info": { "name": "APIs.io Engineering Platform Get the download status for a pre-receive environment", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ] }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform List pre-receive hooks", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-hooks", "params": [ { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by." } ] }, "docs": "APIs.io Engineering Platform List pre-receive hooks" }, { "info": { "name": "APIs.io Engineering Platform Create a pre-receive hook", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-hooks", "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Create a pre-receive hook" }, { "info": { "name": "APIs.io Engineering Platform Get a pre-receive hook", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "APIs.io Engineering Platform Get a pre-receive hook" }, { "info": { "name": "APIs.io Engineering Platform Update a pre-receive hook", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Update a pre-receive hook" }, { "info": { "name": "APIs.io Engineering Platform Delete a pre-receive hook", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/admin/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "APIs.io Engineering Platform Delete a pre-receive hook" }, { "info": { "name": "APIs.io Engineering Platform List personal access tokens", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/admin/tokens", "params": [ { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" } ] }, "docs": "Lists personal access tokens for all users, including admin users." }, { "info": { "name": "APIs.io Engineering Platform Delete a personal access token", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/admin/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path", "description": "The unique identifier of the token." } ] }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Create a user", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/users", "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nThe 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 creat" }, { "info": { "name": "APIs.io Engineering Platform Update the username for a user", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/admin/users/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Update the username for a user" }, { "info": { "name": "APIs.io Engineering Platform Delete a user", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/admin/users/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "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.\n\nYou can delete any user account except your own." }, { "info": { "name": "APIs.io Engineering Platform Create an impersonation OAuth token", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/admin/users/:username/authorizations", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Create an impersonation OAuth token" }, { "info": { "name": "APIs.io Engineering Platform Delete an impersonation OAuth token", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/admin/users/:username/authorizations", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "APIs.io Engineering Platform Delete an impersonation OAuth token" }, { "info": { "name": "APIs.io Engineering Platform Get the global announcement banner", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/announcement" }, "docs": "Gets the current message and expiration date of the global announcement banner in your enterprise." }, { "info": { "name": "APIs.io Engineering Platform Set the global announcement banner", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/enterprise/announcement", "body": { "type": "json", "data": "{}" } }, "docs": "Sets the message and expiration time for the global announcement banner in your enterprise." }, { "info": { "name": "APIs.io Engineering Platform Remove the global announcement banner", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/enterprise/announcement" }, "docs": "Removes the global announcement banner in your enterprise." }, { "info": { "name": "APIs.io Engineering Platform Get license information", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/settings/license" }, "docs": "APIs.io Engineering Platform Get license information" }, { "info": { "name": "APIs.io Engineering Platform Get all statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/all" }, "docs": "APIs.io Engineering Platform Get all statistics" }, { "info": { "name": "APIs.io Engineering Platform Get comment statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/comments" }, "docs": "APIs.io Engineering Platform Get comment statistics" }, { "info": { "name": "APIs.io Engineering Platform Get gist statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/gists" }, "docs": "APIs.io Engineering Platform Get gist statistics" }, { "info": { "name": "APIs.io Engineering Platform Get hooks statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/hooks" }, "docs": "APIs.io Engineering Platform Get hooks statistics" }, { "info": { "name": "APIs.io Engineering Platform Get issue statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/issues" }, "docs": "APIs.io Engineering Platform Get issue statistics" }, { "info": { "name": "APIs.io Engineering Platform Get milestone statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/milestones" }, "docs": "APIs.io Engineering Platform Get milestone statistics" }, { "info": { "name": "APIs.io Engineering Platform Get organization statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/orgs" }, "docs": "APIs.io Engineering Platform Get organization statistics" }, { "info": { "name": "APIs.io Engineering Platform Get pages statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/pages" }, "docs": "APIs.io Engineering Platform Get pages statistics" }, { "info": { "name": "APIs.io Engineering Platform Get pull request statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/pulls" }, "docs": "APIs.io Engineering Platform Get pull request statistics" }, { "info": { "name": "APIs.io Engineering Platform Get repository statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/repos" }, "docs": "APIs.io Engineering Platform Get repository statistics" }, { "info": { "name": "APIs.io Engineering Platform Get users statistics", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprise/stats/users" }, "docs": "APIs.io Engineering Platform Get users statistics" }, { "info": { "name": "APIs.io Engineering Platform Get GitHub Actions permissions for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/permissions", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Set GitHub Actions permissions for an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/permissions", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List selected organizations enabled for GitHub Actions in an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/permissions/organizations", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" } ] }, "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Set selected organizations enabled for GitHub Actions in an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/permissions/organizations", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Enable a selected organization for GitHub Actions in an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/permissions/organizations/:org_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "org_id", "value": "", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Disable a selected organization for GitHub Actions in an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/permissions/organizations/:org_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "org_id", "value": "", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get allowed actions for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/permissions/selected-actions", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Set allowed actions for an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/permissions/selected-actions", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List self-hosted runner groups for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" }, { "name": "visible_to_organization", "value": "", "type": "query", "description": "Only return runner groups that are allowed to be used by this organization." } ] }, "docs": "Lists all self-hosted runner groups for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Create a self-hosted runner group for an enterprise", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new self-hosted runner group for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get a self-hosted runner group for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ] }, "docs": "Gets a specific self-hosted runner group for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Update a self-hosted runner group for an enterprise", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Delete a self-hosted runner group from an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ] }, "docs": "Deletes a self-hosted runner group for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List organization access to a self-hosted runner group in an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id/organizations", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" } ] }, "docs": "Lists the organizations with access to a self-hosted runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Set organization access for a self-hosted runner group in an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id/organizations", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Add organization access to a self-hosted runner group in an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id/organizations/:org_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "org_id", "value": "", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Remove organization access to a self-hosted runner group in an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id/organizations/:org_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "org_id", "value": "", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List self-hosted runners in a group for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id/runners", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" } ] }, "docs": "Lists the self-hosted runners that are in a specific enterprise group.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Set self-hosted runners in a group for an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id/runners", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Add a self-hosted runner to a group for an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id/runners/:runner_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Remove a self-hosted runner from a group for an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runner-groups/:runner_group_id/runners/:runner_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List self-hosted runners for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" } ] }, "docs": "Lists all self-hosted runners configured for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List runner applications for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/downloads", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Lists binaries for the runner application that you can download and run.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Create a registration token for an enterprise", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/registration-token", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Create a remove token for an enterprise", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/remove-token", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "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.\n\nExample using remove token:\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get a self-hosted runner for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/:runner_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Gets a specific self-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Delete a self-hosted runner from an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/:runner_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "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.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform List labels for a self-hosted runner for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/:runner_id/labels", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Lists all labels for a self-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Add custom labels to a self-hosted runner for an enterprise", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/:runner_id/labels", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add custom labels to a self-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Set custom labels for a self-hosted runner for an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/:runner_id/labels", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Remove all custom labels from a self-hosted runner for an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/:runner_id/labels", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Remove a custom label from a self-hosted runner for an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/actions/runners/:runner_id/labels/:name", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." }, { "name": "name", "value": "", "type": "path", "description": "The name of a self-hosted runner's custom label." } ] }, "docs": "Remove a custom label from a self-hosted runner configured\nin an enterprise. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get the audit log for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/audit-log", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "phrase", "value": "", "type": "query", "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)." }, { "name": "include", "value": "", "type": "query", "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`." }, { "name": "after", "value": "", "type": "query", "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." }, { "name": "before", "value": "", "type": "query", "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." }, { "name": "order", "value": "", "type": "query", "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`." }, { "name": "page", "value": "", "type": "query", "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).\"" }, { "name": "per_page", "value": "", "type": "query", "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).\"" } ] }, "docs": "Gets the audit log for an enterprise.\n\nThe authenticated user must be an enterprise admin to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get code security and analysis features for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/code_security_and_analysis", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Update code security and analysis features for an enterprise", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/code_security_and_analysis", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Enable or disable a security feature", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/enterprises/:enterprise/:security_product/:enablement", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "security_product", "value": "", "type": "path", "description": "The security feature to enable or disable." }, { "name": "enablement", "value": "", "type": "path", "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the enterprise.\n`disable_all` means to disable the specified security feature for all repositories in the enterprise." } ] }, "docs": "Enables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get GHES node metadata for all nodes", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/manage/v1/config/nodes", "params": [ { "name": "uuid", "value": "", "type": "query", "description": "The UUID which identifies a node." }, { "name": "cluster_roles", "value": "", "type": "query", "description": "The cluster roles from the cluster configuration file." } ] }, "docs": "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).\"" }, { "info": { "name": "APIs.io Engineering Platform Get the status of services running on all replica nodes", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/manage/v1/replication/status", "params": [ { "name": "uuid", "value": "", "type": "query", "description": "The UUID which identifies a node." }, { "name": "cluster_roles", "value": "", "type": "query", "description": "The cluster roles from the cluster configuration file." } ] }, "docs": "Gets the status of all services running on each replica node.\nThis endpoint may take several seconds to reply." }, { "info": { "name": "APIs.io Engineering Platform Get all GHES release versions for all nodes", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/manage/v1/version", "params": [ { "name": "uuid", "value": "", "type": "query", "description": "The UUID which identifies a node." }, { "name": "cluster_roles", "value": "", "type": "query", "description": "The cluster roles from the cluster configuration file." } ] }, "docs": "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).\"" }, { "info": { "name": "APIs.io Engineering Platform List pre-receive hooks for an organization", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/orgs/:org/pre-receive-hooks", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "", "type": "query", "description": "The sort order for the response collection." } ] }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Get a pre-receive hook for an organization", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/orgs/:org/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "APIs.io Engineering Platform Get a pre-receive hook for an organization" }, { "info": { "name": "APIs.io Engineering Platform Update pre-receive hook enforcement for an organization", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/orgs/:org/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`" }, { "info": { "name": "APIs.io Engineering Platform Remove pre-receive hook enforcement for an organization", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/orgs/:org/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "Removes any overrides for this hook at the org level for this org." }, { "info": { "name": "APIs.io Engineering Platform List pre-receive hooks for a repository", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/pre-receive-hooks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "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).\"" }, { "name": "page", "value": "", "type": "query", "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).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "APIs.io Engineering Platform Get a pre-receive hook for a repository", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "APIs.io Engineering Platform Get a pre-receive hook for a repository" }, { "info": { "name": "APIs.io Engineering Platform Update pre-receive hook enforcement for a repository", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`" }, { "info": { "name": "APIs.io Engineering Platform Remove pre-receive hook enforcement for a repository", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level." }, { "info": { "name": "APIs.io Engineering Platform List provisioned SCIM groups for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Groups", "params": [ { "name": "filter", "value": "", "type": "query", "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'\"`." }, { "name": "excludedAttributes", "value": "", "type": "query", "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time." }, { "name": "startIndex", "value": "", "type": "query", "description": "Used for pagination: the starting index of the first result to return when paginating through values." }, { "name": "count", "value": "", "type": "query", "description": "Used for pagination: the number of results to return per page." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response." }, { "info": { "name": "APIs.io Engineering Platform Provision a SCIM enterprise group", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Groups", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf 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." }, { "info": { "name": "APIs.io Engineering Platform Get SCIM provisioning information for an enterprise group", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." }, { "name": "excludedAttributes", "value": "", "type": "query", "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group." }, { "info": { "name": "APIs.io Engineering Platform Set SCIM information for a provisioned enterprise group", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou 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-" }, { "info": { "name": "APIs.io Engineering Platform Update an attribute for a SCIM enterprise group", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo 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 gro" }, { "info": { "name": "APIs.io Engineering Platform Delete a SCIM group from an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "**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." }, { "info": { "name": "APIs.io Engineering Platform List SCIM provisioned identities for an enterprise", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Users", "params": [ { "name": "filter", "value": "", "type": "query", "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'\"`." }, { "name": "startIndex", "value": "", "type": "query", "description": "Used for pagination: the starting index of the first result to return when paginating through values." }, { "name": "count", "value": "", "type": "query", "description": "Used for pagination: the number of results to return per page." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen 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 permane" }, { "info": { "name": "APIs.io Engineering Platform Provision a SCIM enterprise user", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Users", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM 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 u" }, { "info": { "name": "APIs.io Engineering Platform Get SCIM provisioning information for an enterprise user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user." }, { "info": { "name": "APIs.io Engineering Platform Set SCIM information for a provisioned enterprise user", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou 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) end" }, { "info": { "name": "APIs.io Engineering Platform Update an attribute for a SCIM enterprise user", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**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 `" }, { "info": { "name": "APIs.io Engineering Platform Delete a SCIM user from an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/scim/v2/enterprises/:enterprise/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." }, { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nPermanently 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." }, { "info": { "name": "APIs.io Engineering Platform Get the configuration status", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/setup/api/configcheck" }, "docs": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAI" }, { "info": { "name": "APIs.io Engineering Platform Start a configuration process", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/setup/api/configure" }, "docs": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:" }, { "info": { "name": "APIs.io Engineering Platform Get the maintenance status", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/setup/api/maintenance" }, "docs": "Check your installation's maintenance status:" }, { "info": { "name": "APIs.io Engineering Platform Enable or disable maintenance mode", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/setup/api/maintenance", "body": { "type": "form-urlencoded", "data": [ { "name": "maintenance", "value": "" } ] } }, "docs": "**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)." }, { "info": { "name": "APIs.io Engineering Platform Get settings", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/setup/api/settings" }, "docs": "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).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API." }, { "info": { "name": "APIs.io Engineering Platform Set settings", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/setup/api/settings", "body": { "type": "form-urlencoded", "data": [ { "name": "settings", "value": "" } ] } }, "docs": "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).\n\n**Notes:**\n\n- 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" }, { "info": { "name": "APIs.io Engineering Platform Get all authorized SSH keys", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/setup/api/settings/authorized-keys" }, "docs": "APIs.io Engineering Platform Get all authorized SSH keys" }, { "info": { "name": "APIs.io Engineering Platform Add an authorized SSH key", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/setup/api/settings/authorized-keys", "body": { "type": "form-urlencoded", "data": [ { "name": "authorized_key", "value": "" } ] } }, "docs": "**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)." }, { "info": { "name": "APIs.io Engineering Platform Remove an authorized SSH key", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/setup/api/settings/authorized-keys", "body": { "type": "form-urlencoded", "data": [ { "name": "authorized_key", "value": "" } ] } }, "docs": "**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)." }, { "info": { "name": "APIs.io Engineering Platform Create a GitHub license", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/setup/api/start", "body": { "type": "multipart-form", "data": [ { "name": "license", "type": "text", "value": "" }, { "name": "password", "type": "text", "value": "" }, { "name": "settings", "type": "text", "value": "" } ] } }, "docs": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote 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.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing th" }, { "info": { "name": "APIs.io Engineering Platform Upgrade a license", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/setup/api/upgrade", "body": { "type": "multipart-form", "data": [ { "name": "license", "type": "text", "value": "" } ] } }, "docs": "This API upgrades your license and also triggers the configuration process.\n\n**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)." }, { "info": { "name": "APIs.io Engineering Platform Promote a user to be a site administrator", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/users/:username/site_admin", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "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).\"" }, { "info": { "name": "APIs.io Engineering Platform Demote a site administrator", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/users/:username/site_admin", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "You can demote any user account except your own." }, { "info": { "name": "APIs.io Engineering Platform Suspend a user", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/users/:username/suspended", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any para" }, { "info": { "name": "APIs.io Engineering Platform Unsuspend a user", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/users/:username/suspended", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] } ], "bundled": true }