Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Note: This endpoint is in beta and is subject to change.
\nPurchases a GitHub Copilot for Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"About billing for GitHub Copilot for Business\".
\n Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the manage_billing:copilot scope to use this endpoint.
In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"Setting up a Copilot for Business subscription for your organization\".\nFor more information about setting a suggestion matching policy, see \"Configuring suggestion matching policies for GitHub Copilot in your organization\".
", + "descriptionHTML": "Note: This endpoint is in beta and is subject to change.
\nPurchases a GitHub Copilot for Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"About billing for GitHub Copilot for Business\".
\nOnly organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the manage_billing:copilot scope to use this endpoint.
In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"Setting up a Copilot for Business subscription for your organization\".\nFor more information about setting a suggestion matching policy, see \"Configuring suggestion matching policies for GitHub Copilot in your organization\".
", "statusCodes": [ { "httpStatusCode": "201", @@ -227438,7 +227438,7 @@ "type": "boolean", "name": "read_only", "in": "body", - "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -254233,12 +254233,12 @@ { "type": "string or null", "name": "sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topic too heated resolved spamThe reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topictoo heatedresolvedspamAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", + "descriptionHTML": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -354160,7 +354160,7 @@ "type": "string", "name": "role", "in": "body", - "description": "The role for the new member.
\nadmin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. direct_member - Non-owner organization members with ability to see other members and join teams by invitation. billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.The role for the new member.
\nadmin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.direct_member - Non-owner organization members with ability to see other members and join teams by invitation.billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization.member - The user will become a non-owner member of the organization.Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf 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 will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -444964,7 +444964,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user. collaborator: Repositories that the user has been added to as a collaborator. organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user.collaborator: Repositories that the user has been added to as a collaborator.organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nraw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
This field is deprecated. Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
This field is deprecated. Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.notifications_enabledThe notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.notifications_enabledThe level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -168627,12 +168627,12 @@ { "type": "string or null", "name": "sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topic too heated resolved spamThe reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topictoo heatedresolvedspamAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", + "descriptionHTML": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -261152,7 +261152,7 @@ "type": "string", "name": "role", "in": "body", - "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization.member - The user will become a non-owner member of the organization.Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf 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 will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -325242,7 +325242,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user. collaborator: Repositories that the user has been added to as a collaborator. organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user.collaborator: Repositories that the user has been added to as a collaborator.organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
\nThis API supports files up to 1 megabyte in size.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
This field is deprecated. Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
This field is deprecated. Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.notifications_enabledThe notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.notifications_enabledThe level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Note: This endpoint is in beta and is subject to change.
\nPurchases a GitHub Copilot for Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"About billing for GitHub Copilot for Business\".
\n Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the manage_billing:copilot scope to use this endpoint.
In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"Setting up a Copilot for Business subscription for your organization\".\nFor more information about setting a suggestion matching policy, see \"Configuring suggestion matching policies for GitHub Copilot in your organization\".
", + "descriptionHTML": "Note: This endpoint is in beta and is subject to change.
\nPurchases a GitHub Copilot for Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"About billing for GitHub Copilot for Business\".
\nOnly organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the manage_billing:copilot scope to use this endpoint.
In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"Setting up a Copilot for Business subscription for your organization\".\nFor more information about setting a suggestion matching policy, see \"Configuring suggestion matching policies for GitHub Copilot in your organization\".
", "statusCodes": [ { "httpStatusCode": "201", @@ -239147,7 +239147,7 @@ "type": "boolean", "name": "read_only", "in": "body", - "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -273044,12 +273044,12 @@ { "type": "string or null", "name": "sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topic too heated resolved spamThe reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topictoo heatedresolvedspamAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", + "descriptionHTML": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -376456,7 +376456,7 @@ "type": "string", "name": "role", "in": "body", - "description": "The role for the new member.
\nadmin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. direct_member - Non-owner organization members with ability to see other members and join teams by invitation. billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.The role for the new member.
\nadmin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.direct_member - Non-owner organization members with ability to see other members and join teams by invitation.billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization.member - The user will become a non-owner member of the organization.Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf 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 will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -467266,7 +467266,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user. collaborator: Repositories that the user has been added to as a collaborator. organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user.collaborator: Repositories that the user has been added to as a collaborator.organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nraw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
This field is deprecated. Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
This field is deprecated. Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.notifications_enabledThe notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.notifications_enabledThe level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -210298,7 +210298,7 @@ } ], "previews": [], - "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -233102,12 +233102,12 @@ { "type": "string or null", "name": "sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topic too heated resolved spamThe reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topictoo heatedresolvedspamAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", + "descriptionHTML": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -336691,7 +336691,7 @@ "type": "string", "name": "role", "in": "body", - "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization.member - The user will become a non-owner member of the organization.Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf 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 will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -420298,7 +420298,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user. collaborator: Repositories that the user has been added to as a collaborator. organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user.collaborator: Repositories that the user has been added to as a collaborator.organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nraw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
The level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.notifications_enabledThe notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.notifications_enabledThe level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned.notifications_disabled - no one receives notifications.Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -192326,7 +192326,7 @@ } ], "previews": [], - "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -215062,12 +215062,12 @@ { "type": "string or null", "name": "sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topic too heated resolved spamThe reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topictoo heatedresolvedspamAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", + "descriptionHTML": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -316162,7 +316162,7 @@ "type": "string", "name": "role", "in": "body", - "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization.member - The user will become a non-owner member of the organization.Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf 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 will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -382456,7 +382456,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user. collaborator: Repositories that the user has been added to as a collaborator. organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user.collaborator: Repositories that the user has been added to as a collaborator.organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nraw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
The level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -195132,7 +195132,7 @@ } ], "previews": [], - "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -217888,12 +217888,12 @@ { "type": "string or null", "name": "sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topic too heated resolved spamThe reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topictoo heatedresolvedspamAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", + "descriptionHTML": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -319343,7 +319343,7 @@ "type": "string", "name": "role", "in": "body", - "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization.member - The user will become a non-owner member of the organization.Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf 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 will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -386115,7 +386115,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user. collaborator: Repositories that the user has been added to as a collaborator. organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user.collaborator: Repositories that the user has been added to as a collaborator.organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nraw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
The level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -205146,7 +205146,7 @@ } ], "previews": [], - "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -227926,12 +227926,12 @@ { "type": "string or null", "name": "sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topic too heated resolved spamThe reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topictoo heatedresolvedspamAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", + "descriptionHTML": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -329503,7 +329503,7 @@ "type": "string", "name": "role", "in": "body", - "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization.member - The user will become a non-owner member of the organization.Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf 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 will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -396305,7 +396305,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user. collaborator: Repositories that the user has been added to as a collaborator. organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user.collaborator: Repositories that the user has been added to as a collaborator.organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nraw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
The level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -207767,7 +207767,7 @@ } ], "previews": [], - "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -230571,12 +230571,12 @@ { "type": "string or null", "name": "sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topic too heated resolved spamThe reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\noff-topictoo heatedresolvedspamAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", + "descriptionHTML": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -334072,7 +334072,7 @@ "type": "string", "name": "role", "in": "body", - "description": "The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization. member - The user will become a non-owner member of the organization.The role to give the user in the organization. Can be one of:
\nadmin - The user will become an owner of the organization.member - The user will become a non-owner member of the organization.Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf 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 will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -414164,7 +414164,7 @@ } ], "previews": [], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user. collaborator: Repositories that the user has been added to as a collaborator. organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Comma-separated list of values. Can include:
\nowner: Repositories that are owned by the authenticated user.collaborator: Repositories that the user has been added to as a collaborator.organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
Greater than 100 MB: This endpoint is not supported.
\nIf the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nraw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
The level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.secretclosed - visible to all members of this organization.closedThe level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team. closed - visible to all members of this organization.closed - visible to all members of this organization.The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
secret - only visible to organization owners and members of this team.closed - visible to all members of this organization.closed - visible to all members of this organization.