{ "opencollection": "1.0.0", "info": { "name": "Github Organizations API", "version": "1.1.4" }, "items": [ { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get an Organization Installation for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/installation", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub List App Installations for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/installations", "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).\"" } ] }, "docs": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint." }, { "info": { "name": "GitHub List Organizations", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/organizations", "params": [ { "name": "since", "value": "", "type": "query", "description": "An organization ID. Only return organizations with an ID greater than this 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).\"" } ] }, "docs": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations." }, { "info": { "name": "GitHub Deprecated - List Custom Repository Roles in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/organizations/:organization_id/custom_roles", "params": [ { "name": "organization_id", "value": "12345678", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "**Note**: This operation is deprecated and will be removed in the future.\nUse the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organ" }, { "info": { "name": "GitHub Get an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need" }, { "info": { "name": "GitHub Update an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see t" }, { "info": { "name": "GitHub Delete an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service" }, { "info": { "name": "GitHub Get Github Actions Cache Usage for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/cache/usage", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Repositories with Github Actions Cache Usage for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/cache/usage-by-repository", "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).\"" } ] }, "docs": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get the Customization Template for an Oidc Subject Claim for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/oidc/customization/sub", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set the Customization Template for an Oidc Subject Claim for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/oidc/customization/sub", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get Github Actions Permissions for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API." }, { "info": { "name": "GitHub Set Github Actions Permissions for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Repositories Enabled for Github Actions in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/repositories", "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).\"" } ] }, "docs": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Selected Repositories Enabled for Github Actions in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Enable Selected Repository for Github Actions in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Disable Selected Repository for Github Actions in an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get Allowed Actions for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/selected-actions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API." }, { "info": { "name": "GitHub Set Allowed Actions for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/selected-actions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `pattern" }, { "info": { "name": "GitHub Get Default Workflow Permissions for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/workflow", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." }, { "info": { "name": "GitHub Set Default Workflow Permissions for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/workflow", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAut" }, { "info": { "name": "GitHub List Self-hosted Runner Groups for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups", "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": "visible_to_repository", "value": "", "type": "query", "description": "Only return runner groups that are allowed to be used by this repository." } ] }, "docs": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Create Self-hosted Runner Group for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get Self-hosted Runner Group for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Update Self-hosted Runner Group for an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Delete Self-hosted Runner Group from an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Repository Access to Self-hosted Runner Group in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "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": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Repository Access for Self-hosted Runner Group in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Add Repository Access to Self-hosted Runner Group in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Adds a repository to the list of repositories 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 organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Remove Repository Access to Self-hosted Runner Group in an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Removes a repository from the list of selected repositories 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 organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Self-hosted Runners in Group for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Self-hosted Runners in Group for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Add Self-hosted Runner to Group for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners/:runner_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Remove Self-hosted Runner from Group for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners/:runner_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Self-hosted Runners for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners", "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).\"" } ] }, "docs": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub List Runner Applications for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/downloads", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Create Registration Token for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/registration-token", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Create Remove Token for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/remove-token", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need" }, { "info": { "name": "GitHub Get Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Delete Self-hosted Runner from an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Labels for Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Add Custom Labels to Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Custom Labels for Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Remove All Custom Labels from Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Remove Custom Label from Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels/:name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization. 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\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub List Organization Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets", "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).\"" } ] }, "docs": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Get an Organization Public Key", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/public-key", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Organization Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create or Update an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:" }, { "info": { "name": "GitHub Delete an Organization Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Repositories for an Organization Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "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": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Set Selected Repositories for an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this en" }, { "info": { "name": "GitHub Add Selected Repository to an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to " }, { "info": { "name": "GitHub Remove Selected Repository from an Organization Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoi" }, { "info": { "name": "GitHub List Organization Variables", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables", "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 30). 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 organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Create an Organization Variable", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Organization Variable", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ] }, "docs": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Update an Organization Variable", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Delete an Organization Variable", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ] }, "docs": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Repositories for an Organization Variable", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." }, { "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": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Set Selected Repositories for an Organization Variable", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Add Selected Repository to an Organization Variable", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `r" }, { "info": { "name": "GitHub Remove Selected Repository from an Organization Variable", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Get Announcement Banner for Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/announcement", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint." }, { "info": { "name": "GitHub Set Announcement Banner for Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/announcement", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the announcement banner to display for the organization." }, { "info": { "name": "GitHub Remove Announcement Banner from Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/announcement", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Removes the announcement banner currently set for the organization." }, { "info": { "name": "GitHub Get the Audit Log for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/audit-log", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#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": "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": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter event" }, { "info": { "name": "GitHub List Code Scanning Alerts for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/code-scanning/alerts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "tool_name", "value": "", "type": "query", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both." }, { "name": "tool_guid", "value": "", "type": "query", "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both." }, { "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 results before this cursor. 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": "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 results after this cursor. 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": "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": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "state", "value": "open", "type": "query", "description": "If specified, only code scanning alerts with this state will be returned." }, { "name": "sort", "value": "created", "type": "query", "description": "The property by which to sort the results." }, { "name": "severity", "value": "example_value", "type": "query", "description": "If specified, only code scanning alerts with this severity will be returned." } ] }, "docs": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be" }, { "info": { "name": "GitHub List Custom Repository Roles in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/custom-repository-roles", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin" }, { "info": { "name": "GitHub List Dependabot Alerts for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/alerts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "state", "value": "", "type": "query", "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`" }, { "name": "severity", "value": "", "type": "query", "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`" }, { "name": "ecosystem", "value": "", "type": "query", "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`" }, { "name": "package", "value": "", "type": "query", "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned." }, { "name": "scope", "value": "", "type": "query", "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned." }, { "name": "sort", "value": "", "type": "query", "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "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 results before this cursor. 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": "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 results after this cursor. 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": "first", "value": "", "type": "query", "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results." }, { "name": "last", "value": "", "type": "query", "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results." }, { "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": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub List Organization Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets", "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).\"" } ] }, "docs": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Organization Public Key", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/public-key", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Organization Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Create or Update an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Delete an Organization Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Repositories for an Organization Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "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": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Selected Repositories for an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Add Selected Repository to an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Remove Selected Repository from an Organization Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get List of Conflicting Packages During Docker Migration for Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/docker/conflicts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint." }, { "info": { "name": "GitHub List Public Organization Events", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/events", "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).\"" } ] }, "docs": "Lists all public events for an organization. This endpoint returns a paginated list of events that have occurred within the organization, including activities like repository creation, issue comments, pull requests, and other public actions performed by organization members. The events are returned in reverse chronological order, with the most recent events appearing first. Authentication is not required to access this endpoint since it only exposes public events, though authenticated requests r" }, { "info": { "name": "GitHub List External Groups in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/external-groups", "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": "42", "type": "query", "description": "Page token" }, { "name": "display_name", "value": "octocat", "type": "query", "description": "Limits the list to groups containing the text in the group name" } ] }, "docs": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](ht" }, { "info": { "name": "GitHub List Organization Webhooks", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/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).\"" } ] }, "docs": "This API endpoint retrieves a list of all webhooks configured for a specified GitHub organization. By making a GET request to /orgs/{org}/hooks with the organization name as a path parameter, authenticated users with appropriate permissions can view all active webhooks including their configurations, events they're subscribed to, delivery URLs, and other metadata. This operation requires the user to have admin access to the organization and is commonly used for auditing webhook configurations, m" }, { "info": { "name": "GitHub Create an Organization Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows you to create a new webhook for a specified GitHub organization by sending a POST request to the /orgs/{org}/hooks endpoint, where {org} is replaced with the organization name. Webhooks enable real-time notifications when specific events occur within the organization, such as repository creation, team modifications, or membership changes. When creating the webhook, you must provide configuration details including the payload URL where GitHub will send HTTP POST payloads" }, { "info": { "name": "GitHub Get an Organization Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\"" }, { "info": { "name": "GitHub Update an Organization Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization).\"" }, { "info": { "name": "GitHub Delete an Organization Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "This API operation removes a webhook from a specified GitHub organization by making a DELETE request to the endpoint with the organization name and webhook ID as path parameters. When executed, it permanently deletes the specified webhook configuration, including its delivery URL, events it was subscribed to, and any associated settings. This operation requires appropriate administrative permissions for the organization and returns a 204 No Content status code upon successful deletion, with no r" }, { "info": { "name": "GitHub Get Webhook Configuration for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/config", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint." }, { "info": { "name": "GitHub Update Webhook Configuration for an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/config", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint." }, { "info": { "name": "GitHub List Deliveries for an Organization Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/deliveries", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "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": "cursor", "value": "", "type": "query", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors." }, { "name": "redelivery", "value": "true", "type": "query" } ] }, "docs": "Returns a list of webhook deliveries for a webhook configured in an organization. This endpoint allows you to retrieve the delivery history for a specific organization webhook, showing details about each time the webhook was triggered and the HTTP request was sent to the configured URL. Each delivery record includes information such as the delivery ID, status, timestamp, and other metadata about the webhook event that was fired. This is useful for debugging webhook integrations, monitoring webho" }, { "info": { "name": "GitHub Get Webhook Delivery for an Organization Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/deliveries/:delivery_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves detailed information about a specific webhook delivery attempt for an organization-level webhook in GitHub. By providing the organization name, webhook ID, and delivery ID as path parameters, you can access comprehensive data about a particular delivery event, including the request and response details, headers, payload, status code, and timestamp. This is useful for debugging webhook issues, monitoring delivery success rates, and understanding how your webhooks are " }, { "info": { "name": "GitHub Redeliver Delivery for an Organization Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/deliveries/:delivery_id/attempts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Redeliver a delivery for a webhook configured in an organization." }, { "info": { "name": "GitHub Ping an Organization Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/pings", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook." }, { "info": { "name": "GitHub List Organization Issues Assigned to the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/issues", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "filter", "value": "assigned", "type": "query", "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the issues to return." }, { "name": "labels", "value": "", "type": "query", "description": "A list of comma separated label names. Example: `bug,ui,@high`" }, { "name": "sort", "value": "created", "type": "query", "description": "What to sort results by." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "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": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.g" }, { "info": { "name": "GitHub List Organization Members", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/members", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "filter", "value": "2fa_disabled", "type": "query", "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners." }, { "name": "role", "value": "all", "type": "query", "description": "Filter members returned by their role." }, { "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": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned." }, { "info": { "name": "GitHub Check Organization Membership for User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Check if a user is, publicly or privately, a member of the organization." }, { "info": { "name": "GitHub Remove an Organization Member", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories." }, { "info": { "name": "GitHub Get Organization Membership for User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status." }, { "info": { "name": "GitHub Set Organization Membership for User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership" }, { "info": { "name": "GitHub Remove Organization Membership for User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases." }, { "info": { "name": "GitHub List Organization Migrations", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations", "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": "exclude", "value": "", "type": "query", "description": "Exclude attributes from the API response to improve performance" } ] }, "docs": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).\n\nA list of `repositories` is only returned for export migrations." }, { "info": { "name": "GitHub Start an Organization Migration", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the generation of a migration archive.\n\nBefore you can use this endpoint, you must configure a blob storage provider in the \"Migrations\" section in the Management Console. For more details, see \"[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enter" }, { "info": { "name": "GitHub Get an Organization Migration Status", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." }, { "name": "exclude", "value": "", "type": "query", "description": "Exclude attributes from the API response to improve performance" } ] }, "docs": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed." }, { "info": { "name": "GitHub Download an Organization Migration Archive", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id/archive", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." } ] }, "docs": "Fetches the URL to a migration archive." }, { "info": { "name": "GitHub Delete an Organization Migration Archive", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id/archive", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." } ] }, "docs": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days." }, { "info": { "name": "GitHub Unlock an Organization Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id/repos/:repo_name/lock", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." }, { "name": "repo_name", "value": "", "type": "path", "description": "repo_name parameter" } ] }, "docs": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data." }, { "info": { "name": "GitHub List Repositories in an Organization Migration", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." }, { "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": "List all the repositories for this organization migration." }, { "info": { "name": "GitHub List Outside Collaborators for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/outside_collaborators", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "filter", "value": "2fa_disabled", "type": "query", "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned." }, { "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": "List all users who are outside collaborators of an organization." }, { "info": { "name": "GitHub Convert an Organization Member to Outside Collaborator", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/outside_collaborators/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.9/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restrict" }, { "info": { "name": "GitHub Remove Outside Collaborator from an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/outside_collaborators/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removing a user from this list will remove them from all the organization's repositories." }, { "info": { "name": "GitHub List Packages for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages", "params": [ { "name": "package_type", "value": "npm", "type": "query", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "visibility", "value": "", "type": "query", "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"" }, { "name": "page", "value": "42", "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": "42", "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": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packag" }, { "info": { "name": "GitHub Get Package for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissio" }, { "info": { "name": "GitHub Delete Package for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registrie" }, { "info": { "name": "GitHub Restore Package for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/restore", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "token", "value": "example_value", "type": "query", "description": "package token" } ] }, "docs": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nThe authenti" }, { "info": { "name": "GitHub List Package Versions for Package Owned by an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/versions", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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).\"" }, { "name": "state", "value": "active", "type": "query", "description": "The state of the package, either active or deleted." } ] }, "docs": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-p" }, { "info": { "name": "GitHub Get Package Version for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/versions/:package_version_id", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#p" }, { "info": { "name": "GitHub Delete Package Version for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/versions/:package_version_id", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package." }, { "info": { "name": "GitHub Restore Package Version for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/versions/:package_version_id/restore", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nThe" }, { "info": { "name": "GitHub List Pre-receive Hooks for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/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": "created", "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": "GitHub Get Pre-receive Hook for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/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": "This API endpoint retrieves detailed information about a specific pre-receive hook configured for a GitHub organization. By making a GET request to `/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}`, you can fetch the configuration and metadata of a particular pre-receive hook identified by its unique ID within the specified organization. Pre-receive hooks are scripts that run on the GitHub server to enforce custom requirements before commits are accepted into a repository, and this endpoint " }, { "info": { "name": "GitHub Update Pre-receive Hook Enforcement for an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/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": "GitHub Remove Pre-receive Hook Enforcement for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/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": "GitHub List Organization Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the projects to return." }, { "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 projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Create an Organization Project", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub List Public Organization Members", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/public_members", "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).\"" } ] }, "docs": "Members of an organization can choose to have their membership publicized or not." }, { "info": { "name": "GitHub Check Public Organization Membership for User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/public_members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Check if the provided user is a public member of the organization." }, { "info": { "name": "GitHub Set Public Organization Membership for the Authenticated User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/public_members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote 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": "GitHub Remove Public Organization Membership for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/public_members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default." }, { "info": { "name": "GitHub List Organization Repositories", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/repos", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "type", "value": "all", "type": "query", "description": "Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation access token." }, { "name": "sort", "value": "created", "type": "query", "description": "The property to sort the results by." }, { "name": "direction", "value": "asc", "type": "query", "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`." }, { "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 repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organizati" }, { "info": { "name": "GitHub Create an Organization Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/repos", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository." }, { "info": { "name": "GitHub List Repository Fine-grained Permissions for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/repository-fine-grained-permissions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need th" }, { "info": { "name": "GitHub List Secret Scanning Alerts for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/secret-scanning/alerts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "state", "value": "", "type": "query", "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state." }, { "name": "secret_type", "value": "", "type": "query", "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types." }, { "name": "resolution", "value": "", "type": "query", "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`." }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "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).\"" }, { "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. To receive an initial cursor on your first request, include an empty \"before\" query string." }, { "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. To receive an initial cursor on your first request, include an empty \"after\" query string." } ] }, "docs": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub Get Github Advanced Security Active Committers for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/settings/billing/advanced-security", "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).\"" } ] }, "docs": "Gets the GitHub Advanced Security active committers for an organization per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.\n\nIf this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so th" }, { "info": { "name": "GitHub Enable or Disable Security Feature for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/:security_product/:enablement", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "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 organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization." } ] }, "docs": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and per" }, { "info": { "name": "GitHub List Repository Organization Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/organization-secrets", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "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 organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Repository Organization Variables", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/organization-variables", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 30). 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 organization variables shared with a repository.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." } ] } ], "bundled": true }