Skip to content

Instantly share code, notes, and snippets.

@xuorig

xuorig/diff.json

Created July 28, 2021 18:00
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save xuorig/7ccd5d8c23d0da9c32045ea5697144d0 to your computer and use it in GitHub Desktop.
Save xuorig/7ccd5d8c23d0da9c32045ea5697144d0 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
diff.json
This file has been truncated, but you can view the full file.
{
"version": null,
"servers": {
"added": [
{
"url": "{protocol}://{hostname}",
"variables": {
"hostname": {
"default": "HOSTNAME",
"description": "Self-hosted Enterprise Server or Enterprise Cloud hostname"
},
"protocol": {
"default": "http",
"description": "Self-hosted Enterprise Server or Enterprise Cloud protocol"
}
}
}
],
"removed": [
{
"url": "{protocol}://{hostname}/api/v3",
"variables": {
"hostname": {
"default": "HOSTNAME",
"description": "Self-hosted Enterprise Server or Enterprise Cloud hostname"
},
"protocol": {
"default": "http",
"description": "Self-hosted Enterprise Server or Enterprise Cloud protocol"
}
}
}
],
"changed": {}
},
"paths": {
"added": [
[
"/app/hook/config",
{
"get": {
"tags": [
"apps"
],
"summary": "Get a webhook configuration for an app",
"description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#get-a-webhook-configuration-for-an-app"
},
"operationId": "apps/get-webhook-config-for-app",
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Configuration object of the webhook",
"type": "object",
"properties": {
"content_type": {
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
"type": "string",
"example": "\"json\""
},
"insecure_ssl": {
"oneOf": [
{
"description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
"type": "string",
"example": "\"0\""
},
{
"type": "number"
}
]
},
"secret": {
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#delivery-headers).",
"type": "string",
"example": "\"********\""
},
"url": {
"description": "The URL to which the payloads will be delivered.",
"type": "string",
"format": "uri",
"example": "https://example.com/webhook"
}
},
"title": "Webhook Configuration"
},
"examples": {
"default": {
"value": {
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "webhooks"
}
},
"patch": {
"tags": [
"apps"
],
"summary": "Update a webhook configuration for an app",
"description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#update-a-webhook-configuration-for-an-app"
},
"operationId": "apps/update-webhook-config-for-app",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"content_type": {
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
"type": "string",
"example": "\"json\""
},
"insecure_ssl": {
"oneOf": [
{
"description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
"type": "string",
"example": "\"0\""
},
{
"type": "number"
}
]
},
"secret": {
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#delivery-headers).",
"type": "string",
"example": "\"********\""
},
"url": {
"description": "The URL to which the payloads will be delivered.",
"type": "string",
"format": "uri",
"example": "https://example.com/webhook"
}
},
"example": {
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
}
}
},
"required": null
},
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Configuration object of the webhook",
"type": "object",
"properties": {
"content_type": {
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
"type": "string",
"example": "\"json\""
},
"insecure_ssl": {
"oneOf": [
{
"description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
"type": "string",
"example": "\"0\""
},
{
"type": "number"
}
]
},
"secret": {
"description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#delivery-headers).",
"type": "string",
"example": "\"********\""
},
"url": {
"description": "The URL to which the payloads will be delivered.",
"type": "string",
"format": "uri",
"example": "https://example.com/webhook"
}
},
"title": "Webhook Configuration"
},
"examples": {
"default": {
"value": {
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "webhooks"
}
}
}
],
[
"/app/installations/{installation_id}/suspended",
{
"put": {
"tags": [
"apps"
],
"summary": "Suspend an app installation",
"description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#suspend-an-app-installation"
},
"operationId": "apps/suspend-installation",
"parameters": [
{
"in": "path",
"name": "installation_id",
"description": "installation_id parameter",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"description": "Basic Error",
"type": "object",
"properties": {
"documentation_url": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"url": {
"type": "string"
}
},
"title": "Basic Error"
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": null
}
},
"delete": {
"tags": [
"apps"
],
"summary": "Unsuspend an app installation",
"description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#unsuspend-an-app-installation"
},
"operationId": "apps/unsuspend-installation",
"parameters": [
{
"in": "path",
"name": "installation_id",
"description": "installation_id parameter",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"description": "Basic Error",
"type": "object",
"properties": {
"documentation_url": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"url": {
"type": "string"
}
},
"title": "Basic Error"
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": null
}
}
}
],
[
"/applications/{client_id}/grant",
{
"delete": {
"tags": [
"apps"
],
"summary": "Delete an app authorization",
"description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.1/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#delete-an-app-authorization"
},
"operationId": "apps/delete-authorization",
"parameters": [
{
"in": "path",
"name": "client_id",
"description": "The client ID of your GitHub app.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access_token": {
"description": "The OAuth access token used to authenticate to the GitHub API.",
"type": "string"
}
}
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
},
"422": {
"description": "Validation failed",
"content": {
"application/json": {
"schema": {
"description": "Validation Error",
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"documentation_url": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"index": {
"type": "integer"
},
"message": {
"type": "string"
},
"resource": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "integer",
"nullable": true
},
{
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
]
}
}
}
},
"message": {
"type": "string"
}
},
"title": "Validation Error"
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "oauth-applications"
}
}
}
],
[
"/applications/{client_id}/token",
{
"post": {
"tags": [
"apps"
],
"summary": "Check a token",
"description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.1/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#check-a-token"
},
"operationId": "apps/check-token",
"parameters": [
{
"in": "path",
"name": "client_id",
"description": "The client ID of your GitHub app.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"access_token"
],
"properties": {
"access_token": {
"description": "The access_token of the OAuth application.",
"type": "string"
}
}
}
}
},
"required": null
},
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.",
"type": "object",
"required": [
"app",
"id",
"note",
"note_url",
"scopes",
"token",
"hashed_token",
"token_last_eight",
"fingerprint",
"url",
"created_at",
"updated_at"
],
"properties": {
"app": {
"type": "object",
"required": [
"client_id",
"name",
"url"
],
"properties": {
"client_id": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"fingerprint": {
"type": "string",
"nullable": true
},
"hashed_token": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer"
},
"installation": {
"nullable": true,
"allOf": [
{
"type": "object",
"required": [
"permissions",
"repository_selection",
"single_file_name",
"repositories_url",
"account"
],
"properties": {
"account": {
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
},
"has_multiple_single_files": {
"type": "boolean",
"example": true
},
"permissions": {
"description": "The permissions granted to the user-to-server access token.",
"type": "object",
"properties": {
"actions": {
"description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"administration": {
"description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"checks": {
"description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"content_references": {
"description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"contents": {
"description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"deployments": {
"description": "The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"environments": {
"description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"issues": {
"description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"members": {
"description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"metadata": {
"description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_administration": {
"description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_hooks": {
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_packages": {
"description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_plan": {
"description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.",
"type": "string",
"enum": [
"read"
]
},
"organization_projects": {
"description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"organization_secrets": {
"description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_self_hosted_runners": {
"description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_user_blocking": {
"description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"packages": {
"description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"pages": {
"description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"pull_requests": {
"description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_hooks": {
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_projects": {
"description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"secret_scanning_alerts": {
"description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"secrets": {
"description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"security_events": {
"description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"single_file": {
"description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"statuses": {
"description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"team_discussions": {
"description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"vulnerability_alerts": {
"description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.",
"type": "string",
"enum": [
"read"
]
},
"workflows": {
"description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.",
"type": "string",
"enum": [
"write"
]
}
},
"example": {
"contents": "read",
"deployments": "write",
"issues": "read",
"single_file": "read"
},
"title": "App Permissions"
},
"repositories_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"repository_selection": {
"description": "Describe whether all repositories have been selected or there's a selection involved",
"type": "string",
"enum": [
"all",
"selected"
]
},
"single_file_name": {
"type": "string",
"nullable": true,
"example": "config.yaml"
},
"single_file_paths": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"config.yml",
".github/issue_TEMPLATE.md"
]
}
},
"title": "Scoped Installation"
}
]
},
"note": {
"type": "string",
"nullable": true
},
"note_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"scopes": {
"description": "A list of scopes that this authorization is in.",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"token": {
"type": "string"
},
"token_last_eight": {
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
},
"user": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
}
},
"title": "Authorization"
},
"examples": {
"default": {
"value": {
"app": {
"client_id": "abcde12345fghij67890",
"name": "my github app",
"url": "http://my-github-app.com"
},
"created_at": "2011-09-06T17:26:27Z",
"fingerprint": "jklmnop12345678",
"hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
"id": 1,
"note": "optional note",
"note_url": "http://optional/note/url",
"scopes": [
"public_repo",
"user"
],
"token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
"token_last_eight": "Ae178B4a",
"updated_at": "2011-09-06T20:39:23Z",
"url": "https://api.github.com/authorizations/1",
"user": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
}
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"description": "Basic Error",
"type": "object",
"properties": {
"documentation_url": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"url": {
"type": "string"
}
},
"title": "Basic Error"
}
}
}
},
"422": {
"description": "Validation failed",
"content": {
"application/json": {
"schema": {
"description": "Validation Error",
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"documentation_url": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"index": {
"type": "integer"
},
"message": {
"type": "string"
},
"resource": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "integer",
"nullable": true
},
{
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
]
}
}
}
},
"message": {
"type": "string"
}
},
"title": "Validation Error"
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "oauth-applications"
}
},
"delete": {
"tags": [
"apps"
],
"summary": "Delete an app token",
"description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.1/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#delete-an-app-token"
},
"operationId": "apps/delete-token",
"parameters": [
{
"in": "path",
"name": "client_id",
"description": "The client ID of your GitHub app.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"access_token"
],
"properties": {
"access_token": {
"description": "The OAuth access token used to authenticate to the GitHub API.",
"type": "string"
}
}
},
"example": {
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
},
"422": {
"description": "Validation failed",
"content": {
"application/json": {
"schema": {
"description": "Validation Error",
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"documentation_url": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"index": {
"type": "integer"
},
"message": {
"type": "string"
},
"resource": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "integer",
"nullable": true
},
{
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
]
}
}
}
},
"message": {
"type": "string"
}
},
"title": "Validation Error"
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "oauth-applications"
}
},
"patch": {
"tags": [
"apps"
],
"summary": "Reset a token",
"description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.1/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#reset-a-token"
},
"operationId": "apps/reset-token",
"parameters": [
{
"in": "path",
"name": "client_id",
"description": "The client ID of your GitHub app.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"access_token"
],
"properties": {
"access_token": {
"description": "The access_token of the OAuth application.",
"type": "string"
}
}
}
}
},
"required": null
},
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.",
"type": "object",
"required": [
"app",
"id",
"note",
"note_url",
"scopes",
"token",
"hashed_token",
"token_last_eight",
"fingerprint",
"url",
"created_at",
"updated_at"
],
"properties": {
"app": {
"type": "object",
"required": [
"client_id",
"name",
"url"
],
"properties": {
"client_id": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"fingerprint": {
"type": "string",
"nullable": true
},
"hashed_token": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer"
},
"installation": {
"nullable": true,
"allOf": [
{
"type": "object",
"required": [
"permissions",
"repository_selection",
"single_file_name",
"repositories_url",
"account"
],
"properties": {
"account": {
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
},
"has_multiple_single_files": {
"type": "boolean",
"example": true
},
"permissions": {
"description": "The permissions granted to the user-to-server access token.",
"type": "object",
"properties": {
"actions": {
"description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"administration": {
"description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"checks": {
"description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"content_references": {
"description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"contents": {
"description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"deployments": {
"description": "The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"environments": {
"description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"issues": {
"description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"members": {
"description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"metadata": {
"description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_administration": {
"description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_hooks": {
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_packages": {
"description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_plan": {
"description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.",
"type": "string",
"enum": [
"read"
]
},
"organization_projects": {
"description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"organization_secrets": {
"description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_self_hosted_runners": {
"description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_user_blocking": {
"description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"packages": {
"description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"pages": {
"description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"pull_requests": {
"description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_hooks": {
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_projects": {
"description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"secret_scanning_alerts": {
"description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"secrets": {
"description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"security_events": {
"description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"single_file": {
"description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"statuses": {
"description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"team_discussions": {
"description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"vulnerability_alerts": {
"description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.",
"type": "string",
"enum": [
"read"
]
},
"workflows": {
"description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.",
"type": "string",
"enum": [
"write"
]
}
},
"example": {
"contents": "read",
"deployments": "write",
"issues": "read",
"single_file": "read"
},
"title": "App Permissions"
},
"repositories_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"repository_selection": {
"description": "Describe whether all repositories have been selected or there's a selection involved",
"type": "string",
"enum": [
"all",
"selected"
]
},
"single_file_name": {
"type": "string",
"nullable": true,
"example": "config.yaml"
},
"single_file_paths": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"config.yml",
".github/issue_TEMPLATE.md"
]
}
},
"title": "Scoped Installation"
}
]
},
"note": {
"type": "string",
"nullable": true
},
"note_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"scopes": {
"description": "A list of scopes that this authorization is in.",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"token": {
"type": "string"
},
"token_last_eight": {
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
},
"user": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
}
},
"title": "Authorization"
},
"examples": {
"default": {
"value": {
"app": {
"client_id": "abcde12345fghij67890",
"name": "my github app",
"url": "http://my-github-app.com"
},
"created_at": "2011-09-06T17:26:27Z",
"fingerprint": "jklmnop12345678",
"hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
"id": 1,
"note": "optional note",
"note_url": "http://optional/note/url",
"scopes": [
"public_repo",
"user"
],
"token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
"token_last_eight": "Ae178B4a",
"updated_at": "2011-09-06T20:39:23Z",
"url": "https://api.github.com/authorizations/1",
"user": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
}
}
}
}
}
}
},
"422": {
"description": "Validation failed",
"content": {
"application/json": {
"schema": {
"description": "Validation Error",
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"documentation_url": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"index": {
"type": "integer"
},
"message": {
"type": "string"
},
"resource": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "integer",
"nullable": true
},
{
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
]
}
}
}
},
"message": {
"type": "string"
}
},
"title": "Validation Error"
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "oauth-applications"
}
}
}
],
[
"/applications/{client_id}/token/scoped",
{
"post": {
"tags": [
"apps"
],
"summary": "Create a scoped access token",
"description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.1/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-scoped-access-token"
},
"operationId": "apps/scope-token",
"parameters": [
{
"in": "path",
"name": "client_id",
"description": "The client ID of your GitHub app.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"access_token"
],
"properties": {
"access_token": {
"description": "The OAuth access token used to authenticate to the GitHub API.",
"type": "string",
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a"
},
"permissions": {
"description": "The permissions granted to the user-to-server access token.",
"type": "object",
"properties": {
"actions": {
"description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"administration": {
"description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"checks": {
"description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"content_references": {
"description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"contents": {
"description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"deployments": {
"description": "The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"environments": {
"description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"issues": {
"description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"members": {
"description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"metadata": {
"description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_administration": {
"description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_hooks": {
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_packages": {
"description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_plan": {
"description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.",
"type": "string",
"enum": [
"read"
]
},
"organization_projects": {
"description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"organization_secrets": {
"description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_self_hosted_runners": {
"description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_user_blocking": {
"description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"packages": {
"description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"pages": {
"description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"pull_requests": {
"description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_hooks": {
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_projects": {
"description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"secret_scanning_alerts": {
"description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"secrets": {
"description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"security_events": {
"description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"single_file": {
"description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"statuses": {
"description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"team_discussions": {
"description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"vulnerability_alerts": {
"description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.",
"type": "string",
"enum": [
"read"
]
},
"workflows": {
"description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.",
"type": "string",
"enum": [
"write"
]
}
},
"example": {
"contents": "read",
"deployments": "write",
"issues": "read",
"single_file": "read"
},
"title": "App Permissions"
},
"repositories": {
"description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.",
"type": "array",
"items": {
"type": "string",
"example": "rails"
}
},
"repository_ids": {
"description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.",
"type": "array",
"items": {
"type": "integer"
},
"example": [
1
]
},
"target": {
"description": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.",
"type": "string",
"example": "octocat"
},
"target_id": {
"description": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.",
"type": "integer",
"example": 1
}
}
}
}
},
"required": null
},
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.",
"type": "object",
"required": [
"app",
"id",
"note",
"note_url",
"scopes",
"token",
"hashed_token",
"token_last_eight",
"fingerprint",
"url",
"created_at",
"updated_at"
],
"properties": {
"app": {
"type": "object",
"required": [
"client_id",
"name",
"url"
],
"properties": {
"client_id": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"fingerprint": {
"type": "string",
"nullable": true
},
"hashed_token": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer"
},
"installation": {
"nullable": true,
"allOf": [
{
"type": "object",
"required": [
"permissions",
"repository_selection",
"single_file_name",
"repositories_url",
"account"
],
"properties": {
"account": {
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
},
"has_multiple_single_files": {
"type": "boolean",
"example": true
},
"permissions": {
"description": "The permissions granted to the user-to-server access token.",
"type": "object",
"properties": {
"actions": {
"description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"administration": {
"description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"checks": {
"description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"content_references": {
"description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"contents": {
"description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"deployments": {
"description": "The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"environments": {
"description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"issues": {
"description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"members": {
"description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"metadata": {
"description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_administration": {
"description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_hooks": {
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_packages": {
"description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_plan": {
"description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.",
"type": "string",
"enum": [
"read"
]
},
"organization_projects": {
"description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"organization_secrets": {
"description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_self_hosted_runners": {
"description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_user_blocking": {
"description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"packages": {
"description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"pages": {
"description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"pull_requests": {
"description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_hooks": {
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_projects": {
"description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"secret_scanning_alerts": {
"description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"secrets": {
"description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"security_events": {
"description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"single_file": {
"description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"statuses": {
"description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"team_discussions": {
"description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.",
"type": "string",
"enum": [
"read",
"write"
]
},
"vulnerability_alerts": {
"description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.",
"type": "string",
"enum": [
"read"
]
},
"workflows": {
"description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.",
"type": "string",
"enum": [
"write"
]
}
},
"example": {
"contents": "read",
"deployments": "write",
"issues": "read",
"single_file": "read"
},
"title": "App Permissions"
},
"repositories_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"repository_selection": {
"description": "Describe whether all repositories have been selected or there's a selection involved",
"type": "string",
"enum": [
"all",
"selected"
]
},
"single_file_name": {
"type": "string",
"nullable": true,
"example": "config.yaml"
},
"single_file_paths": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"config.yml",
".github/issue_TEMPLATE.md"
]
}
},
"title": "Scoped Installation"
}
]
},
"note": {
"type": "string",
"nullable": true
},
"note_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"scopes": {
"description": "A list of scopes that this authorization is in.",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"token": {
"type": "string"
},
"token_last_eight": {
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
},
"user": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
}
},
"title": "Authorization"
},
"examples": {
"default": {
"value": {
"app": {
"client_id": "abcde12345fghij67890",
"name": "my github app",
"url": "http://my-github-app.com"
},
"created_at": "2011-09-06T17:26:27Z",
"fingerprint": "jklmnop12345678",
"hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
"id": 1,
"installation": {
"account": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
},
"has_multiple_single_files": false,
"permissions": {
"contents": "read",
"issues": "write",
"metadata": "read"
},
"repositories_url": "https://api.github.com/user/repos",
"repository_selection": "selected",
"single_file_name": ".github/workflow.yml",
"single_file_paths": []
},
"note": "optional note",
"note_url": "http://optional/note/url",
"scopes": [],
"token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
"token_last_eight": "Ae178B4a",
"updated_at": "2011-09-06T20:39:23Z",
"url": "https://api.github.com/authorizations/1",
"user": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
}
}
}
}
}
}
},
"401": {
"description": "Requires authentication",
"content": {
"application/json": {
"schema": {
"description": "Basic Error",
"type": "object",
"properties": {
"documentation_url": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"url": {
"type": "string"
}
},
"title": "Basic Error"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"description": "Basic Error",
"type": "object",
"properties": {
"documentation_url": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"url": {
"type": "string"
}
},
"title": "Basic Error"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"description": "Basic Error",
"type": "object",
"properties": {
"documentation_url": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"url": {
"type": "string"
}
},
"title": "Basic Error"
}
}
}
},
"422": {
"description": "Validation failed",
"content": {
"application/json": {
"schema": {
"description": "Validation Error",
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"documentation_url": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"index": {
"type": "integer"
},
"message": {
"type": "string"
},
"resource": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "integer",
"nullable": true
},
{
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
]
}
}
}
},
"message": {
"type": "string"
}
},
"title": "Validation Error"
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "oauth-applications"
}
}
}
],
[
"/enterprise/announcement",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "Get the global announcement banner",
"description": "Gets the current message and expiration date of the global announcement banner in your enterprise.",
"operationId": "enterprise-admin/get-announcement",
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Enterprise global announcement",
"type": "object",
"required": [
"announcement"
],
"properties": {
"announcement": {
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"",
"type": "string",
"example": "Very **important** announcement about _nothing_."
},
"expires_at": {
"description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.",
"type": "string",
"format": "date-time",
"nullable": true,
"example": "\"2021-01-01T00:00:00.000-07:00\""
}
},
"title": "Enterprise Announcement"
},
"examples": {
"default": {
"summary": "Default response",
"value": {
"announcement": "Very **important** announcement about _nothing_.",
"expires_at": "2021-01-01T00:00:00.000+00:00"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "announcement"
}
},
"delete": {
"tags": [
"enterprise-admin"
],
"summary": "Remove the global announcement banner",
"description": "Removes the global announcement banner in your enterprise.",
"operationId": "enterprise-admin/remove-announcement",
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "announcement"
}
},
"patch": {
"tags": [
"enterprise-admin"
],
"summary": "Set the global announcement banner",
"description": "Sets the message and expiration time for the global announcement banner in your enterprise.",
"operationId": "enterprise-admin/set-announcement",
"requestBody": {
"content": {
"application/json": {
"schema": {
"description": "Enterprise global announcement",
"type": "object",
"required": [
"announcement"
],
"properties": {
"announcement": {
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"",
"type": "string",
"example": "Very **important** announcement about _nothing_."
},
"expires_at": {
"description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.",
"type": "string",
"format": "date-time",
"nullable": true,
"example": "\"2021-01-01T00:00:00.000-07:00\""
}
},
"title": "Enterprise Announcement"
}
}
},
"required": null
},
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Enterprise global announcement",
"type": "object",
"required": [
"announcement"
],
"properties": {
"announcement": {
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"",
"type": "string",
"example": "Very **important** announcement about _nothing_."
},
"expires_at": {
"description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.",
"type": "string",
"format": "date-time",
"nullable": true,
"example": "\"2021-01-01T00:00:00.000-07:00\""
}
},
"title": "Enterprise Announcement"
},
"examples": {
"default": {
"summary": "Default response",
"value": {
"announcement": "Very **important** announcement about _nothing_.",
"expires_at": "2021-01-01T00:00:00.000+00:00"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "announcement"
}
}
}
],
[
"/enterprises/{enterprise}/actions/permissions",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "Get GitHub Actions permissions for an enterprise",
"description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise"
},
"operationId": "enterprise-admin/get-github-actions-permissions-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled_organizations",
"allowed_actions"
],
"properties": {
"allowed_actions": {
"description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"type": "string",
"enum": [
"all",
"local_only",
"selected"
]
},
"enabled_organizations": {
"description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.",
"type": "string",
"enum": [
"all",
"none",
"selected"
]
},
"selected_actions_url": {
"description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`.",
"type": "string"
},
"selected_organizations_url": {
"description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`.",
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"allowed_actions": "selected",
"enabled_organizations": "all",
"selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"put": {
"tags": [
"enterprise-admin"
],
"summary": "Set GitHub Actions permissions for an enterprise",
"description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise"
},
"operationId": "enterprise-admin/set-github-actions-permissions-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled_organizations"
],
"properties": {
"allowed_actions": {
"description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"type": "string",
"enum": [
"all",
"local_only",
"selected"
]
},
"enabled_organizations": {
"description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.",
"type": "string",
"enum": [
"all",
"none",
"selected"
]
}
}
},
"example": {
"allowed_actions": "selected",
"enabled_organizations": "all"
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/permissions/organizations",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "List selected organizations enabled for GitHub Actions in an enterprise",
"description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise"
},
"operationId": "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"organizations"
],
"properties": {
"organizations": {
"type": "array",
"items": {
"description": "Organization Simple",
"type": "object",
"required": [
"login",
"url",
"id",
"node_id",
"repos_url",
"events_url",
"hooks_url",
"issues_url",
"members_url",
"public_members_url",
"avatar_url",
"description"
],
"properties": {
"avatar_url": {
"type": "string",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"description": {
"type": "string",
"nullable": true,
"example": "A great organization"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/orgs/github/events"
},
"hooks_url": {
"type": "string",
"example": "https://api.github.com/orgs/github/hooks"
},
"id": {
"type": "integer",
"example": 1
},
"issues_url": {
"type": "string",
"example": "https://api.github.com/orgs/github/issues"
},
"login": {
"type": "string",
"example": "github"
},
"members_url": {
"type": "string",
"example": "https://api.github.com/orgs/github/members{/member}"
},
"node_id": {
"type": "string",
"example": "MDEyOk9yZ2FuaXphdGlvbjE="
},
"public_members_url": {
"type": "string",
"example": "https://api.github.com/orgs/github/public_members{/member}"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/orgs/github/repos"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/orgs/github"
}
},
"title": "Organization Simple"
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"organizations": [
{
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"events_url": "https://api.github.com/orgs/octo-org/events",
"hooks_url": "https://api.github.com/orgs/octo-org/hooks",
"id": 161335,
"issues_url": "https://api.github.com/orgs/octo-org/issues",
"login": "octocat",
"members_url": "https://api.github.com/orgs/octo-org/members{/member}",
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
"repos_url": "https://api.github.com/orgs/octo-org/repos",
"url": "https://api.github.com/orgs/octo-org"
}
],
"total_count": 1
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"put": {
"tags": [
"enterprise-admin"
],
"summary": "Set selected organizations enabled for GitHub Actions in an enterprise",
"description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise"
},
"operationId": "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"selected_organization_ids"
],
"properties": {
"selected_organization_ids": {
"description": "List of organization IDs to enable for GitHub Actions.",
"type": "array",
"items": {
"description": "Unique identifier of the organization.",
"type": "integer"
}
}
}
},
"example": {
"selected_organization_ids": [
32,
91
]
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/permissions/organizations/{org_id}",
{
"put": {
"tags": [
"enterprise-admin"
],
"summary": "Enable a selected organization for GitHub Actions in an enterprise",
"description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise"
},
"operationId": "enterprise-admin/enable-selected-organization-github-actions-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "org_id",
"description": "Unique identifier of an organization.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"delete": {
"tags": [
"enterprise-admin"
],
"summary": "Disable a selected organization for GitHub Actions in an enterprise",
"description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise"
},
"operationId": "enterprise-admin/disable-selected-organization-github-actions-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "org_id",
"description": "Unique identifier of an organization.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/permissions/selected-actions",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "Get allowed actions for an enterprise",
"description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise"
},
"operationId": "enterprise-admin/get-allowed-actions-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"github_owned_allowed",
"patterns_allowed"
],
"properties": {
"github_owned_allowed": {
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
"type": "boolean"
},
"patterns_allowed": {
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"examples": {
"default": {
"value": {
"github_owned_allowed": true,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
],
"verified_allowed": false
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"put": {
"tags": [
"enterprise-admin"
],
"summary": "Set allowed actions for an enterprise",
"description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise"
},
"operationId": "enterprise-admin/set-allowed-actions-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"github_owned_allowed",
"patterns_allowed"
],
"properties": {
"github_owned_allowed": {
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
"type": "boolean"
},
"patterns_allowed": {
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"examples": {
"selected_actions": {
"value": {
"github_owned_allowed": true,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
],
"verified_allowed": false
}
}
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runner-groups",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise"
},
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"runner_groups"
],
"properties": {
"runner_groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"visibility",
"allows_public_repositories",
"default",
"runners_url"
],
"properties": {
"allows_public_repositories": {
"type": "boolean"
},
"default": {
"type": "boolean"
},
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"runners_url": {
"type": "string"
},
"selected_organizations_url": {
"type": "string"
},
"visibility": {
"type": "string"
}
}
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"runner_groups": [
{
"allows_public_repositories": false,
"default": true,
"id": 1,
"name": "Default",
"runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners",
"visibility": "all"
},
{
"allows_public_repositories": true,
"default": false,
"id": 2,
"name": "octo-runner-group",
"runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners",
"selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations",
"visibility": "selected"
},
{
"allows_public_repositories": true,
"default": false,
"id": 3,
"name": "expensive-hardware",
"runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners",
"visibility": "private"
}
],
"total_count": 3
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"post": {
"tags": [
"enterprise-admin"
],
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise"
},
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "Name of the runner group.",
"type": "string"
},
"runners": {
"description": "List of runner IDs to add to the runner group.",
"type": "array",
"items": {
"description": "Unique identifier of the runner.",
"type": "integer"
}
},
"selected_organization_ids": {
"description": "List of organization IDs that can access the runner group.",
"type": "array",
"items": {
"description": "Unique identifier of the organization.",
"type": "integer"
}
},
"visibility": {
"description": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`",
"type": "string",
"enum": [
"selected",
"all"
]
}
}
},
"example": {
"name": "Expensive hardware runners",
"runners": [
9,
2
],
"selected_organization_ids": [
32,
91
],
"visibility": "selected"
}
}
},
"required": null
},
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"visibility",
"allows_public_repositories",
"default",
"runners_url"
],
"properties": {
"allows_public_repositories": {
"type": "boolean"
},
"default": {
"type": "boolean"
},
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"runners_url": {
"type": "string"
},
"selected_organizations_url": {
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"allows_public_repositories": false,
"default": false,
"id": 2,
"name": "octo-runner-group",
"runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners",
"selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations",
"visibility": "selected"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise"
},
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"visibility",
"allows_public_repositories",
"default",
"runners_url"
],
"properties": {
"allows_public_repositories": {
"type": "boolean"
},
"default": {
"type": "boolean"
},
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"runners_url": {
"type": "string"
},
"selected_organizations_url": {
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"allows_public_repositories": false,
"default": false,
"id": 2,
"name": "octo-runner-group",
"runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners",
"selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations",
"visibility": "selected"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"delete": {
"tags": [
"enterprise-admin"
],
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise"
},
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"patch": {
"tags": [
"enterprise-admin"
],
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise"
},
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"description": "Name of the runner group.",
"type": "string"
},
"visibility": {
"description": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`",
"type": "string",
"enum": [
"selected",
"all"
],
"default": "all"
}
}
},
"example": {
"name": "Expensive hardware runners",
"visibility": "selected"
}
}
},
"required": null
},
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"visibility",
"allows_public_repositories",
"default",
"runners_url"
],
"properties": {
"allows_public_repositories": {
"type": "boolean"
},
"default": {
"type": "boolean"
},
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"runners_url": {
"type": "string"
},
"selected_organizations_url": {
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"allows_public_repositories": true,
"default": false,
"id": 2,
"name": "Expensive hardware runners",
"runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners",
"selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations",
"visibility": "selected"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise"
},
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"organizations"
],
"properties": {
"organizations": {
"type": "array",
"items": {
"description": "Organization Simple",
"type": "object",
"required": [
"login",
"url",
"id",
"node_id",
"repos_url",
"events_url",
"hooks_url",
"issues_url",
"members_url",
"public_members_url",
"avatar_url",
"description"
],
"properties": {
"avatar_url": {
"type": "string",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"description": {
"type": "string",
"nullable": true,
"example": "A great organization"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/orgs/github/events"
},
"hooks_url": {
"type": "string",
"example": "https://api.github.com/orgs/github/hooks"
},
"id": {
"type": "integer",
"example": 1
},
"issues_url": {
"type": "string",
"example": "https://api.github.com/orgs/github/issues"
},
"login": {
"type": "string",
"example": "github"
},
"members_url": {
"type": "string",
"example": "https://api.github.com/orgs/github/members{/member}"
},
"node_id": {
"type": "string",
"example": "MDEyOk9yZ2FuaXphdGlvbjE="
},
"public_members_url": {
"type": "string",
"example": "https://api.github.com/orgs/github/public_members{/member}"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/orgs/github/repos"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/orgs/github"
}
},
"title": "Organization Simple"
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"organizations": [
{
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"events_url": "https://api.github.com/orgs/octo-org/events",
"hooks_url": "https://api.github.com/orgs/octo-org/hooks",
"id": 161335,
"issues_url": "https://api.github.com/orgs/octo-org/issues",
"login": "octocat",
"members_url": "https://api.github.com/orgs/octo-org/members{/member}",
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
"repos_url": "https://api.github.com/orgs/octo-org/repos",
"url": "https://api.github.com/orgs/octo-org"
}
],
"total_count": 1
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"put": {
"tags": [
"enterprise-admin"
],
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
},
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"selected_organization_ids"
],
"properties": {
"selected_organization_ids": {
"description": "List of organization IDs that can access the runner group.",
"type": "array",
"items": {
"description": "Unique identifier of the organization.",
"type": "integer"
}
}
}
},
"example": {
"selected_organization_ids": [
32,
91
]
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}",
{
"put": {
"tags": [
"enterprise-admin"
],
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
},
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "path",
"name": "org_id",
"description": "Unique identifier of an organization.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"delete": {
"tags": [
"enterprise-admin"
],
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
},
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "path",
"name": "org_id",
"description": "Unique identifier of an organization.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise"
},
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"headers": {
"Link": {
"style": "simple",
"required": null,
"schema": {
"type": "string"
},
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\""
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"runners"
],
"properties": {
"runners": {
"type": "array",
"items": {
"description": "A self hosted runner",
"type": "object",
"required": [
"id",
"name",
"os",
"status",
"busy",
"labels"
],
"properties": {
"busy": {
"type": "boolean"
},
"id": {
"description": "The id of the runner.",
"type": "integer",
"example": 5
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the label.",
"type": "integer"
},
"name": {
"description": "Name of the label.",
"type": "string"
},
"type": {
"description": "The type of label. Read-only labels are applied automatically when the runner is configured.",
"type": "string",
"enum": [
"read-only",
"custom"
]
}
}
}
},
"name": {
"description": "The name of the runner.",
"type": "string",
"example": "iMac"
},
"os": {
"description": "The Operating System of the runner.",
"type": "string",
"example": "macos"
},
"status": {
"description": "The status of the runner.",
"type": "string",
"example": "online"
}
},
"title": "Self hosted runners"
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"runners": [
{
"busy": true,
"id": 23,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 11,
"name": "Linux",
"type": "read-only"
}
],
"name": "linux_runner",
"os": "linux",
"status": "online"
},
{
"busy": false,
"id": 24,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
],
"name": "mac_runner",
"os": "macos",
"status": "offline"
}
],
"total_count": 2
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"put": {
"tags": [
"enterprise-admin"
],
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise"
},
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"runners"
],
"properties": {
"runners": {
"description": "List of runner IDs to add to the runner group.",
"type": "array",
"items": {
"description": "Unique identifier of the runner.",
"type": "integer"
}
}
}
},
"example": {
"runners": [
9,
2
]
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}",
{
"put": {
"tags": [
"enterprise-admin"
],
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise"
},
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_id",
"description": "Unique identifier of the self-hosted runner.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"delete": {
"tags": [
"enterprise-admin"
],
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise"
},
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_id",
"description": "Unique identifier of the self-hosted runner.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runners",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise"
},
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"headers": {
"Link": {
"style": "simple",
"required": null,
"schema": {
"type": "string"
},
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\""
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"runners": {
"type": "array",
"items": {
"description": "A self hosted runner",
"type": "object",
"required": [
"id",
"name",
"os",
"status",
"busy",
"labels"
],
"properties": {
"busy": {
"type": "boolean"
},
"id": {
"description": "The id of the runner.",
"type": "integer",
"example": 5
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the label.",
"type": "integer"
},
"name": {
"description": "Name of the label.",
"type": "string"
},
"type": {
"description": "The type of label. Read-only labels are applied automatically when the runner is configured.",
"type": "string",
"enum": [
"read-only",
"custom"
]
}
}
}
},
"name": {
"description": "The name of the runner.",
"type": "string",
"example": "iMac"
},
"os": {
"description": "The Operating System of the runner.",
"type": "string",
"example": "macos"
},
"status": {
"description": "The status of the runner.",
"type": "string",
"example": "online"
}
},
"title": "Self hosted runners"
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"runners": [
{
"busy": true,
"id": 23,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 11,
"name": "Linux",
"type": "read-only"
}
],
"name": "linux_runner",
"os": "linux",
"status": "online"
},
{
"busy": false,
"id": 24,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
],
"name": "mac_runner",
"os": "macos",
"status": "offline"
}
],
"total_count": 2
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runners/downloads",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise"
},
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "Runner Application",
"type": "object",
"required": [
"os",
"architecture",
"download_url",
"filename"
],
"properties": {
"architecture": {
"type": "string"
},
"download_url": {
"type": "string"
},
"filename": {
"type": "string"
},
"os": {
"type": "string"
},
"sha256_checksum": {
"type": "string"
},
"temp_download_token": {
"description": "A short lived bearer token used to download the runner, if needed.",
"type": "string"
}
},
"title": "Runner Application"
}
},
"examples": {
"default": {
"value": [
{
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz",
"filename": "actions-runner-osx-x64-2.164.0.tar.gz",
"os": "osx"
},
{
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz",
"filename": "actions-runner-linux-x64-2.164.0.tar.gz",
"os": "linux"
},
{
"architecture": "arm",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz",
"filename": "actions-runner-linux-arm-2.164.0.tar.gz",
"os": "linux"
},
{
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip",
"filename": "actions-runner-win-x64-2.164.0.zip",
"os": "win"
},
{
"architecture": "arm64",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz",
"filename": "actions-runner-linux-arm64-2.164.0.tar.gz",
"os": "linux"
}
]
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runners/registration-token",
{
"post": {
"tags": [
"enterprise-admin"
],
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise"
},
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Authentication Token",
"type": "object",
"required": [
"token",
"expires_at"
],
"properties": {
"expires_at": {
"description": "The time this token expires",
"type": "string",
"format": "date-time",
"example": "2016-07-11T22:14:10Z"
},
"permissions": {
"type": "object",
"example": {
"deployments": "write",
"issues": "read"
}
},
"repositories": {
"description": "The repositories this token has access to",
"type": "array",
"items": {
"description": "A git repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url",
"clone_url",
"default_branch",
"forks",
"forks_count",
"git_url",
"has_downloads",
"has_issues",
"has_projects",
"has_wiki",
"has_pages",
"homepage",
"language",
"archived",
"disabled",
"mirror_url",
"open_issues",
"open_issues_count",
"license",
"pushed_at",
"size",
"ssh_url",
"stargazers_count",
"svn_url",
"watchers",
"watchers_count",
"created_at",
"updated_at"
],
"properties": {
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"description": "Whether the repository is archived.",
"type": "boolean",
"default": false
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"type": "boolean",
"example": false,
"default": false
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"description": "Returns whether or not this repository disabled.",
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer"
},
"forks_count": {
"type": "integer",
"example": 9
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string",
"example": "git:github.com/octocat/Hello-World.git"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_issues": {
"description": "Whether issues are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"description": "Whether projects are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"type": "boolean",
"example": true,
"default": true
},
"homepage": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://github.com"
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"description": "Unique identifier of the repository",
"type": "integer",
"example": 42
},
"is_template": {
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"type": "boolean",
"example": true,
"default": false
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"nullable": true,
"allOf": [
{
"description": "License Simple",
"type": "object",
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"properties": {
"html_url": {
"type": "string",
"format": "uri"
},
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://api.github.com/licenses/mit"
}
},
"title": "License Simple"
}
]
},
"master_branch": {
"type": "string"
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "git:git.example.com/octocat/Hello-World"
},
"name": {
"description": "The name of the repository.",
"type": "string",
"example": "Team Environment"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer"
},
"open_issues_count": {
"type": "integer",
"example": 0
},
"organization": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"owner": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"required": [
"admin",
"pull",
"push"
],
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"description": "Whether the repository is private or public.",
"type": "boolean",
"default": false
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer",
"example": 108
},
"ssh_url": {
"type": "string",
"example": "git@github.com:octocat/Hello-World.git"
},
"stargazers_count": {
"type": "integer",
"example": 80
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:42Z\""
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"svn_url": {
"type": "string",
"format": "uri",
"example": "https://svn.github.com/octocat/Hello-World"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"temp_clone_token": {
"type": "string"
},
"template_repository": {
"type": "object",
"properties": {
"allow_merge_commit": {
"type": "boolean"
},
"allow_rebase_merge": {
"type": "boolean"
},
"allow_squash_merge": {
"type": "boolean"
},
"archive_url": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"default_branch": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"deployments_url": {
"type": "string"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"downloads_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"fork": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_url": {
"type": "string"
},
"has_downloads": {
"type": "boolean"
},
"has_issues": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"homepage": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"language": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"mirror_url": {
"type": "string"
},
"name": {
"type": "string"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"open_issues_count": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"size": {
"type": "integer"
},
"ssh_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"temp_clone_token": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
},
"visibility": {
"type": "string"
},
"watchers_count": {
"type": "integer"
}
},
"nullable": true
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:14:43Z"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World"
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
"type": "string",
"default": "public"
},
"watchers": {
"type": "integer"
},
"watchers_count": {
"type": "integer",
"example": 80
}
},
"title": "Repository"
}
},
"repository_selection": {
"description": "Describe whether all repositories have been selected or there's a selection involved",
"type": "string",
"enum": [
"all",
"selected"
]
},
"single_file": {
"type": "string",
"nullable": true,
"example": "config.yaml"
},
"token": {
"description": "The token used for authentication",
"type": "string",
"example": "v1.1f699f1069f60xxx"
}
},
"title": "Authentication Token"
},
"examples": {
"default": {
"value": {
"expires_at": "2020-01-22T12:13:35.123-08:00",
"token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runners/remove-token",
{
"post": {
"tags": [
"enterprise-admin"
],
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise"
},
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Authentication Token",
"type": "object",
"required": [
"token",
"expires_at"
],
"properties": {
"expires_at": {
"description": "The time this token expires",
"type": "string",
"format": "date-time",
"example": "2016-07-11T22:14:10Z"
},
"permissions": {
"type": "object",
"example": {
"deployments": "write",
"issues": "read"
}
},
"repositories": {
"description": "The repositories this token has access to",
"type": "array",
"items": {
"description": "A git repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url",
"clone_url",
"default_branch",
"forks",
"forks_count",
"git_url",
"has_downloads",
"has_issues",
"has_projects",
"has_wiki",
"has_pages",
"homepage",
"language",
"archived",
"disabled",
"mirror_url",
"open_issues",
"open_issues_count",
"license",
"pushed_at",
"size",
"ssh_url",
"stargazers_count",
"svn_url",
"watchers",
"watchers_count",
"created_at",
"updated_at"
],
"properties": {
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"description": "Whether the repository is archived.",
"type": "boolean",
"default": false
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"type": "boolean",
"example": false,
"default": false
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"description": "Returns whether or not this repository disabled.",
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer"
},
"forks_count": {
"type": "integer",
"example": 9
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string",
"example": "git:github.com/octocat/Hello-World.git"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_issues": {
"description": "Whether issues are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"description": "Whether projects are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"type": "boolean",
"example": true,
"default": true
},
"homepage": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://github.com"
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"description": "Unique identifier of the repository",
"type": "integer",
"example": 42
},
"is_template": {
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"type": "boolean",
"example": true,
"default": false
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"nullable": true,
"allOf": [
{
"description": "License Simple",
"type": "object",
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"properties": {
"html_url": {
"type": "string",
"format": "uri"
},
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://api.github.com/licenses/mit"
}
},
"title": "License Simple"
}
]
},
"master_branch": {
"type": "string"
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "git:git.example.com/octocat/Hello-World"
},
"name": {
"description": "The name of the repository.",
"type": "string",
"example": "Team Environment"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer"
},
"open_issues_count": {
"type": "integer",
"example": 0
},
"organization": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"owner": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"required": [
"admin",
"pull",
"push"
],
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"description": "Whether the repository is private or public.",
"type": "boolean",
"default": false
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer",
"example": 108
},
"ssh_url": {
"type": "string",
"example": "git@github.com:octocat/Hello-World.git"
},
"stargazers_count": {
"type": "integer",
"example": 80
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:42Z\""
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"svn_url": {
"type": "string",
"format": "uri",
"example": "https://svn.github.com/octocat/Hello-World"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"temp_clone_token": {
"type": "string"
},
"template_repository": {
"type": "object",
"properties": {
"allow_merge_commit": {
"type": "boolean"
},
"allow_rebase_merge": {
"type": "boolean"
},
"allow_squash_merge": {
"type": "boolean"
},
"archive_url": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"default_branch": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"deployments_url": {
"type": "string"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"downloads_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"fork": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_url": {
"type": "string"
},
"has_downloads": {
"type": "boolean"
},
"has_issues": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"homepage": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"language": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"mirror_url": {
"type": "string"
},
"name": {
"type": "string"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"open_issues_count": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"size": {
"type": "integer"
},
"ssh_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"temp_clone_token": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
},
"visibility": {
"type": "string"
},
"watchers_count": {
"type": "integer"
}
},
"nullable": true
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:14:43Z"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World"
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
"type": "string",
"default": "public"
},
"watchers": {
"type": "integer"
},
"watchers_count": {
"type": "integer",
"example": 80
}
},
"title": "Repository"
}
},
"repository_selection": {
"description": "Describe whether all repositories have been selected or there's a selection involved",
"type": "string",
"enum": [
"all",
"selected"
]
},
"single_file": {
"type": "string",
"nullable": true,
"example": "config.yaml"
},
"token": {
"description": "The token used for authentication",
"type": "string",
"example": "v1.1f699f1069f60xxx"
}
},
"title": "Authentication Token"
},
"examples": {
"default": {
"value": {
"expires_at": "2020-01-29T12:13:35.123-08:00",
"token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/enterprises/{enterprise}/actions/runners/{runner_id}",
{
"get": {
"tags": [
"enterprise-admin"
],
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise"
},
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_id",
"description": "Unique identifier of the self-hosted runner.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "A self hosted runner",
"type": "object",
"required": [
"id",
"name",
"os",
"status",
"busy",
"labels"
],
"properties": {
"busy": {
"type": "boolean"
},
"id": {
"description": "The id of the runner.",
"type": "integer",
"example": 5
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the label.",
"type": "integer"
},
"name": {
"description": "Name of the label.",
"type": "string"
},
"type": {
"description": "The type of label. Read-only labels are applied automatically when the runner is configured.",
"type": "string",
"enum": [
"read-only",
"custom"
]
}
}
}
},
"name": {
"description": "The name of the runner.",
"type": "string",
"example": "iMac"
},
"os": {
"description": "The Operating System of the runner.",
"type": "string",
"example": "macos"
},
"status": {
"description": "The status of the runner.",
"type": "string",
"example": "online"
}
},
"title": "Self hosted runners"
},
"examples": {
"default": {
"value": {
"busy": true,
"id": 23,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
],
"name": "MBP",
"os": "macos",
"status": "online"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
},
"delete": {
"tags": [
"enterprise-admin"
],
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise"
},
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"parameters": [
{
"in": "path",
"name": "enterprise",
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_id",
"description": "Unique identifier of the self-hosted runner.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "enterprise-admin",
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"previews": [],
"subcategory": "actions"
}
}
}
],
[
"/installation/token",
{
"delete": {
"tags": [
"apps"
],
"summary": "Revoke an installation access token",
"description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#revoke-an-installation-access-token"
},
"operationId": "apps/revoke-installation-access-token",
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "apps",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "installations"
}
}
}
],
[
"/orgs/{org}/actions/permissions",
{
"get": {
"tags": [
"actions"
],
"summary": "Get GitHub Actions permissions for an organization",
"description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#get-github-actions-permissions-for-an-organization"
},
"operationId": "actions/get-github-actions-permissions-organization",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled_repositories"
],
"properties": {
"allowed_actions": {
"description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"type": "string",
"enum": [
"all",
"local_only",
"selected"
]
},
"enabled_repositories": {
"description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.",
"type": "string",
"enum": [
"all",
"none",
"selected"
]
},
"selected_actions_url": {
"description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`.",
"type": "string"
},
"selected_repositories_url": {
"description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`.",
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"allowed_actions": "selected",
"enabled_repositories": "all",
"selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "permissions"
}
},
"put": {
"tags": [
"actions"
],
"summary": "Set GitHub Actions permissions for an organization",
"description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#set-github-actions-permissions-for-an-organization"
},
"operationId": "actions/set-github-actions-permissions-organization",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled_repositories"
],
"properties": {
"allowed_actions": {
"description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"type": "string",
"enum": [
"all",
"local_only",
"selected"
]
},
"enabled_repositories": {
"description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.",
"type": "string",
"enum": [
"all",
"none",
"selected"
]
}
}
},
"example": {
"allowed_actions": "selected",
"enabled_repositories": "all"
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "permissions"
}
}
}
],
[
"/orgs/{org}/actions/permissions/repositories",
{
"get": {
"tags": [
"actions"
],
"summary": "List selected repositories enabled for GitHub Actions in an organization",
"description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization"
},
"operationId": "actions/list-selected-repositories-enabled-github-actions-organization",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"repositories"
],
"properties": {
"repositories": {
"type": "array",
"items": {
"description": "A git repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url",
"clone_url",
"default_branch",
"forks",
"forks_count",
"git_url",
"has_downloads",
"has_issues",
"has_projects",
"has_wiki",
"has_pages",
"homepage",
"language",
"archived",
"disabled",
"mirror_url",
"open_issues",
"open_issues_count",
"license",
"pushed_at",
"size",
"ssh_url",
"stargazers_count",
"svn_url",
"watchers",
"watchers_count",
"created_at",
"updated_at"
],
"properties": {
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"description": "Whether the repository is archived.",
"type": "boolean",
"default": false
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"type": "boolean",
"example": false,
"default": false
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"description": "Returns whether or not this repository disabled.",
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer"
},
"forks_count": {
"type": "integer",
"example": 9
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string",
"example": "git:github.com/octocat/Hello-World.git"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_issues": {
"description": "Whether issues are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"description": "Whether projects are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"type": "boolean",
"example": true,
"default": true
},
"homepage": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://github.com"
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"description": "Unique identifier of the repository",
"type": "integer",
"example": 42
},
"is_template": {
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"type": "boolean",
"example": true,
"default": false
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"nullable": true,
"allOf": [
{
"description": "License Simple",
"type": "object",
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"properties": {
"html_url": {
"type": "string",
"format": "uri"
},
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://api.github.com/licenses/mit"
}
},
"title": "License Simple"
}
]
},
"master_branch": {
"type": "string"
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "git:git.example.com/octocat/Hello-World"
},
"name": {
"description": "The name of the repository.",
"type": "string",
"example": "Team Environment"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer"
},
"open_issues_count": {
"type": "integer",
"example": 0
},
"organization": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"owner": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"required": [
"admin",
"pull",
"push"
],
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"description": "Whether the repository is private or public.",
"type": "boolean",
"default": false
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer",
"example": 108
},
"ssh_url": {
"type": "string",
"example": "git@github.com:octocat/Hello-World.git"
},
"stargazers_count": {
"type": "integer",
"example": 80
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:42Z\""
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"svn_url": {
"type": "string",
"format": "uri",
"example": "https://svn.github.com/octocat/Hello-World"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"temp_clone_token": {
"type": "string"
},
"template_repository": {
"type": "object",
"properties": {
"allow_merge_commit": {
"type": "boolean"
},
"allow_rebase_merge": {
"type": "boolean"
},
"allow_squash_merge": {
"type": "boolean"
},
"archive_url": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"default_branch": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"deployments_url": {
"type": "string"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"downloads_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"fork": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_url": {
"type": "string"
},
"has_downloads": {
"type": "boolean"
},
"has_issues": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"homepage": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"language": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"mirror_url": {
"type": "string"
},
"name": {
"type": "string"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"open_issues_count": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"size": {
"type": "integer"
},
"ssh_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"temp_clone_token": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
},
"visibility": {
"type": "string"
},
"watchers_count": {
"type": "integer"
}
},
"nullable": true
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:14:43Z"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World"
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
"type": "string",
"default": "public"
},
"watchers": {
"type": "integer"
},
"watchers_count": {
"type": "integer",
"example": 80
}
},
"title": "Repository"
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"repositories": [
{
"allow_merge_commit": true,
"allow_rebase_merge": true,
"allow_squash_merge": true,
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"archived": false,
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"created_at": "2011-01-26T19:01:12Z",
"default_branch": "master",
"delete_branch_on_merge": true,
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"description": "This your first repo!",
"disabled": false,
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"fork": false,
"forks": 1,
"forks_count": 9,
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"full_name": "octocat/Hello-World",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"has_downloads": true,
"has_issues": true,
"has_pages": false,
"has_projects": true,
"has_wiki": true,
"homepage": "https://github.com",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"html_url": "https://github.com/octocat/Hello-World",
"id": 1296269,
"is_template": true,
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"language": null,
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"license": {
"html_url": "https://github.com/licenses/mit",
"key": "mit",
"name": "MIT License",
"node_id": "MDc6TGljZW5zZW1pdA==",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit"
},
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"name": "Hello-World",
"network_count": 0,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"open_issues": 1,
"open_issues_count": 0,
"owner": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
},
"permissions": {
"admin": false,
"pull": true,
"push": false
},
"private": false,
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"pushed_at": "2011-01-26T19:06:43Z",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"size": 108,
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_count": 80,
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_count": 42,
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"template_repository": null,
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"updated_at": "2011-01-26T19:14:43Z",
"url": "https://api.github.com/repos/octocat/Hello-World",
"visibility": "public",
"watchers": 1,
"watchers_count": 80
}
],
"total_count": 1
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "permissions"
}
},
"put": {
"tags": [
"actions"
],
"summary": "Set selected repositories enabled for GitHub Actions in an organization",
"description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization"
},
"operationId": "actions/set-selected-repositories-enabled-github-actions-organization",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"selected_repository_ids"
],
"properties": {
"selected_repository_ids": {
"description": "List of repository IDs to enable for GitHub Actions.",
"type": "array",
"items": {
"description": "Unique identifier of the repository.",
"type": "integer"
}
}
}
},
"example": {
"selected_repository_ids": [
32,
42
]
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "permissions"
}
}
}
],
[
"/orgs/{org}/actions/permissions/repositories/{repository_id}",
{
"put": {
"tags": [
"actions"
],
"summary": "Enable a selected repository for GitHub Actions in an organization",
"description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization"
},
"operationId": "actions/enable-selected-repository-github-actions-organization",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "repository_id",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "permissions"
}
},
"delete": {
"tags": [
"actions"
],
"summary": "Disable a selected repository for GitHub Actions in an organization",
"description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization"
},
"operationId": "actions/disable-selected-repository-github-actions-organization",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "repository_id",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "permissions"
}
}
}
],
[
"/orgs/{org}/actions/permissions/selected-actions",
{
"get": {
"tags": [
"actions"
],
"summary": "Get allowed actions for an organization",
"description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#get-allowed-actions-for-an-organization"
},
"operationId": "actions/get-allowed-actions-organization",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"github_owned_allowed",
"patterns_allowed"
],
"properties": {
"github_owned_allowed": {
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
"type": "boolean"
},
"patterns_allowed": {
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"examples": {
"default": {
"value": {
"github_owned_allowed": true,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
],
"verified_allowed": false
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "permissions"
}
},
"put": {
"tags": [
"actions"
],
"summary": "Set allowed actions for an organization",
"description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#set-allowed-actions-for-an-organization"
},
"operationId": "actions/set-allowed-actions-organization",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"github_owned_allowed",
"patterns_allowed"
],
"properties": {
"github_owned_allowed": {
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
"type": "boolean"
},
"patterns_allowed": {
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"examples": {
"selected_actions": {
"value": {
"github_owned_allowed": true,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
],
"verified_allowed": false
}
}
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "permissions"
}
}
}
],
[
"/orgs/{org}/actions/runner-groups",
{
"get": {
"tags": [
"actions"
],
"summary": "List self-hosted runner groups for an organization",
"description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization"
},
"operationId": "actions/list-self-hosted-runner-groups-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"runner_groups"
],
"properties": {
"runner_groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"visibility",
"default",
"runners_url",
"inherited",
"allows_public_repositories"
],
"properties": {
"allows_public_repositories": {
"type": "boolean"
},
"default": {
"type": "boolean"
},
"id": {
"type": "number"
},
"inherited": {
"type": "boolean"
},
"inherited_allows_public_repositories": {
"type": "boolean"
},
"name": {
"type": "string"
},
"runners_url": {
"type": "string"
},
"selected_repositories_url": {
"description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`",
"type": "string"
},
"visibility": {
"type": "string"
}
}
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"runner_groups": [
{
"allows_public_repositories": true,
"default": true,
"id": 1,
"inherited": false,
"name": "Default",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners",
"visibility": "all"
},
{
"allows_public_repositories": true,
"default": false,
"id": 2,
"inherited": true,
"name": "octo-runner-group",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories",
"visibility": "selected"
},
{
"allows_public_repositories": true,
"default": false,
"id": 3,
"inherited": false,
"name": "expensive-hardware",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners",
"visibility": "private"
}
],
"total_count": 3
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
},
"post": {
"tags": [
"actions"
],
"summary": "Create a self-hosted runner group for an organization",
"description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nCreates a new self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization"
},
"operationId": "actions/create-self-hosted-runner-group-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "Name of the runner group.",
"type": "string"
},
"runners": {
"description": "List of runner IDs to add to the runner group.",
"type": "array",
"items": {
"description": "Unique identifier of the runner.",
"type": "integer"
}
},
"selected_repository_ids": {
"description": "List of repository IDs that can access the runner group.",
"type": "array",
"items": {
"description": "Unique identifier of the repository.",
"type": "integer"
}
},
"visibility": {
"description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.",
"type": "string",
"enum": [
"selected",
"all",
"private"
],
"default": "all"
}
}
},
"example": {
"name": "Expensive hardware runners",
"runners": [
9,
2
],
"selected_repository_ids": [
32,
91
],
"visibility": "selected"
}
}
},
"required": null
},
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"visibility",
"default",
"runners_url",
"inherited",
"allows_public_repositories"
],
"properties": {
"allows_public_repositories": {
"type": "boolean"
},
"default": {
"type": "boolean"
},
"id": {
"type": "number"
},
"inherited": {
"type": "boolean"
},
"inherited_allows_public_repositories": {
"type": "boolean"
},
"name": {
"type": "string"
},
"runners_url": {
"type": "string"
},
"selected_repositories_url": {
"description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`",
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"allows_public_repositories": true,
"default": false,
"id": 2,
"inherited": false,
"name": "octo-runner-group",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories",
"visibility": "selected"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
}
}
],
[
"/orgs/{org}/actions/runner-groups/{runner_group_id}",
{
"get": {
"tags": [
"actions"
],
"summary": "Get a self-hosted runner group for an organization",
"description": "Gets a specific self-hosted runner group for an organization.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#get-a-self-hosted-runner-group-for-an-organization"
},
"operationId": "actions/get-self-hosted-runner-group-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"visibility",
"default",
"runners_url",
"inherited",
"allows_public_repositories"
],
"properties": {
"allows_public_repositories": {
"type": "boolean"
},
"default": {
"type": "boolean"
},
"id": {
"type": "number"
},
"inherited": {
"type": "boolean"
},
"inherited_allows_public_repositories": {
"type": "boolean"
},
"name": {
"type": "string"
},
"runners_url": {
"type": "string"
},
"selected_repositories_url": {
"description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`",
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"allows_public_repositories": true,
"default": false,
"id": 2,
"inherited": false,
"name": "octo-runner-group",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories",
"visibility": "selected"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
},
"delete": {
"tags": [
"actions"
],
"summary": "Delete a self-hosted runner group from an organization",
"description": "Deletes a self-hosted runner group for an organization.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization"
},
"operationId": "actions/delete-self-hosted-runner-group-from-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
},
"patch": {
"tags": [
"actions"
],
"summary": "Update a self-hosted runner group for an organization",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization"
},
"operationId": "actions/update-self-hosted-runner-group-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"description": "Name of the runner group.",
"type": "string"
},
"visibility": {
"description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.",
"type": "string",
"enum": [
"selected",
"all",
"private"
]
}
}
},
"example": {
"name": "Expensive hardware runners",
"visibility": "selected"
}
}
},
"required": null
},
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"visibility",
"default",
"runners_url",
"inherited",
"allows_public_repositories"
],
"properties": {
"allows_public_repositories": {
"type": "boolean"
},
"default": {
"type": "boolean"
},
"id": {
"type": "number"
},
"inherited": {
"type": "boolean"
},
"inherited_allows_public_repositories": {
"type": "boolean"
},
"name": {
"type": "string"
},
"runners_url": {
"type": "string"
},
"selected_repositories_url": {
"description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`",
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"examples": {
"default": {
"value": {
"allows_public_repositories": true,
"default": false,
"id": 2,
"inherited": false,
"name": "octo-runner-group",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories",
"visibility": "selected"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
}
}
],
[
"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories",
{
"get": {
"tags": [
"actions"
],
"summary": "List repository access to a self-hosted runner group in an organization",
"description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nLists the repositories with access to a self-hosted runner group configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization"
},
"operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"repositories"
],
"properties": {
"repositories": {
"type": "array",
"items": {
"description": "Minimal Repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url"
],
"properties": {
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"type": "boolean"
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string"
},
"code_of_conduct": {
"description": "Code Of Conduct",
"type": "object",
"required": [
"url",
"html_url",
"key",
"name"
],
"properties": {
"body": {
"type": "string",
"example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
},
"html_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"key": {
"type": "string",
"example": "contributor_covenant"
},
"name": {
"type": "string",
"example": "Contributor Covenant"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/codes_of_conduct/contributor_covenant"
}
},
"title": "Code Of Conduct"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer",
"example": 0
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string"
},
"has_downloads": {
"type": "boolean"
},
"has_issues": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"homepage": {
"type": "string",
"nullable": true
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"type": "integer",
"example": 1296269
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"spdx_id": {
"type": "string"
},
"url": {
"type": "string"
}
},
"nullable": true
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"example": "Hello-World"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer",
"example": 0
},
"open_issues_count": {
"type": "integer"
},
"owner": {
"type": "object",
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer"
},
"ssh_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"svn_url": {
"type": "string"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"temp_clone_token": {
"type": "string"
},
"template_repository": {
"type": "object",
"nullable": true,
"allOf": [
{
"description": "A git repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url",
"clone_url",
"default_branch",
"forks",
"forks_count",
"git_url",
"has_downloads",
"has_issues",
"has_projects",
"has_wiki",
"has_pages",
"homepage",
"language",
"archived",
"disabled",
"mirror_url",
"open_issues",
"open_issues_count",
"license",
"pushed_at",
"size",
"ssh_url",
"stargazers_count",
"svn_url",
"watchers",
"watchers_count",
"created_at",
"updated_at"
],
"properties": {
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"description": "Whether the repository is archived.",
"type": "boolean",
"default": false
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"type": "boolean",
"example": false,
"default": false
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"description": "Returns whether or not this repository disabled.",
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer"
},
"forks_count": {
"type": "integer",
"example": 9
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string",
"example": "git:github.com/octocat/Hello-World.git"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_issues": {
"description": "Whether issues are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"description": "Whether projects are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"type": "boolean",
"example": true,
"default": true
},
"homepage": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://github.com"
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"description": "Unique identifier of the repository",
"type": "integer",
"example": 42
},
"is_template": {
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"type": "boolean",
"example": true,
"default": false
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"nullable": true,
"allOf": [
{
"description": "License Simple",
"type": "object",
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"properties": {
"html_url": {
"type": "string",
"format": "uri"
},
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://api.github.com/licenses/mit"
}
},
"title": "License Simple"
}
]
},
"master_branch": {
"type": "string"
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "git:git.example.com/octocat/Hello-World"
},
"name": {
"description": "The name of the repository.",
"type": "string",
"example": "Team Environment"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer"
},
"open_issues_count": {
"type": "integer",
"example": 0
},
"organization": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"owner": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"required": [
"admin",
"pull",
"push"
],
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"description": "Whether the repository is private or public.",
"type": "boolean",
"default": false
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer",
"example": 108
},
"ssh_url": {
"type": "string",
"example": "git@github.com:octocat/Hello-World.git"
},
"stargazers_count": {
"type": "integer",
"example": 80
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:42Z\""
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"svn_url": {
"type": "string",
"format": "uri",
"example": "https://svn.github.com/octocat/Hello-World"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"temp_clone_token": {
"type": "string"
},
"template_repository": {
"type": "object",
"properties": {
"allow_merge_commit": {
"type": "boolean"
},
"allow_rebase_merge": {
"type": "boolean"
},
"allow_squash_merge": {
"type": "boolean"
},
"archive_url": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"default_branch": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"deployments_url": {
"type": "string"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"downloads_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"fork": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_url": {
"type": "string"
},
"has_downloads": {
"type": "boolean"
},
"has_issues": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"homepage": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"language": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"mirror_url": {
"type": "string"
},
"name": {
"type": "string"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"open_issues_count": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"size": {
"type": "integer"
},
"ssh_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"temp_clone_token": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
},
"visibility": {
"type": "string"
},
"watchers_count": {
"type": "integer"
}
},
"nullable": true
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:14:43Z"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World"
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
"type": "string",
"default": "public"
},
"watchers": {
"type": "integer"
},
"watchers_count": {
"type": "integer",
"example": 80
}
},
"title": "Repository"
}
]
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:14:43Z"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World"
},
"visibility": {
"type": "string"
},
"watchers": {
"type": "integer",
"example": 0
},
"watchers_count": {
"type": "integer"
}
},
"title": "Minimal Repository"
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"repositories": [
{
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"archived": false,
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"created_at": "2011-01-26T19:01:12Z",
"default_branch": "master",
"delete_branch_on_merge": true,
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"description": "This your first repo!",
"disabled": false,
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"fork": false,
"forks": 1,
"forks_count": 9,
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"full_name": "octocat/Hello-World",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"has_downloads": true,
"has_issues": true,
"has_pages": false,
"has_projects": true,
"has_wiki": true,
"homepage": "https://github.com",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"html_url": "https://github.com/octocat/Hello-World",
"id": 1296269,
"is_template": true,
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"language": null,
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"license": {
"key": "mit",
"name": "MIT License",
"node_id": "MDc6TGljZW5zZW1pdA==",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit"
},
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"name": "Hello-World",
"network_count": 0,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"open_issues": 1,
"open_issues_count": 0,
"owner": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
},
"permissions": {
"admin": false,
"pull": true,
"push": false
},
"private": false,
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"pushed_at": "2011-01-26T19:06:43Z",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"size": 108,
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_count": 80,
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_count": 42,
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"template_repository": {
"allow_merge_commit": true,
"allow_rebase_merge": true,
"allow_squash_merge": true,
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"archived": false,
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"created_at": "2011-01-26T19:01:12Z",
"default_branch": "master",
"delete_branch_on_merge": true,
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"description": "This your first repo!",
"disabled": false,
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"fork": false,
"forks": 9,
"forks_count": 9,
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"full_name": "octocat/Hello-World",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"has_downloads": true,
"has_issues": true,
"has_pages": false,
"has_projects": true,
"has_wiki": true,
"homepage": "https://github.com",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"html_url": "https://github.com/octocat/Hello-World",
"id": 1296269,
"is_template": true,
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"language": null,
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"license": {
"html_url": "https://api.github.com/licenses/mit",
"key": "mit",
"name": "MIT License",
"node_id": "MDc6TGljZW5zZW1pdA==",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit"
},
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"name": "Hello-World",
"network_count": 0,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"open_issues": 0,
"open_issues_count": 0,
"organization": null,
"owner": {
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
},
"permissions": {
"admin": false,
"pull": true,
"push": false
},
"private": false,
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"pushed_at": "2011-01-26T19:06:43Z",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"size": 108,
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_count": 80,
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_count": 42,
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"template_repository": null,
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"updated_at": "2011-01-26T19:14:43Z",
"url": "https://api.github.com/repos/octocat/Hello-World",
"visibility": "public",
"watchers": 80,
"watchers_count": 80
},
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"updated_at": "2011-01-26T19:14:43Z",
"url": "https://api.github.com/repos/octocat/Hello-World",
"visibility": "public",
"watchers": 1,
"watchers_count": 80
}
],
"total_count": 1
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
},
"put": {
"tags": [
"actions"
],
"summary": "Set repository access for a self-hosted runner group in an organization",
"description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#set-repository-access-to-a-self-hosted-runner-group-in-an-organization"
},
"operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"selected_repository_ids"
],
"properties": {
"selected_repository_ids": {
"description": "List of repository IDs that can access the runner group.",
"type": "array",
"items": {
"description": "Unique identifier of the repository.",
"type": "integer"
}
}
}
},
"example": {
"selected_repository_ids": [
32,
91
]
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
}
}
],
[
"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}",
{
"put": {
"tags": [
"actions"
],
"summary": "Add repository access to a self-hosted runner group in an organization",
"description": "Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization"
},
"operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "path",
"name": "repository_id",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": true,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
},
"delete": {
"tags": [
"actions"
],
"summary": "Remove repository access to a self-hosted runner group in an organization",
"description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization"
},
"operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "path",
"name": "repository_id",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
}
}
],
[
"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners",
{
"get": {
"tags": [
"actions"
],
"summary": "List self-hosted runners in a group for an organization",
"description": "Lists self-hosted runners that are in a specific organization group.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization"
},
"operationId": "actions/list-self-hosted-runners-in-group-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"headers": {
"Link": {
"style": "simple",
"required": null,
"schema": {
"type": "string"
},
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\""
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"runners"
],
"properties": {
"runners": {
"type": "array",
"items": {
"description": "A self hosted runner",
"type": "object",
"required": [
"id",
"name",
"os",
"status",
"busy",
"labels"
],
"properties": {
"busy": {
"type": "boolean"
},
"id": {
"description": "The id of the runner.",
"type": "integer",
"example": 5
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the label.",
"type": "integer"
},
"name": {
"description": "Name of the label.",
"type": "string"
},
"type": {
"description": "The type of label. Read-only labels are applied automatically when the runner is configured.",
"type": "string",
"enum": [
"read-only",
"custom"
]
}
}
}
},
"name": {
"description": "The name of the runner.",
"type": "string",
"example": "iMac"
},
"os": {
"description": "The Operating System of the runner.",
"type": "string",
"example": "macos"
},
"status": {
"description": "The status of the runner.",
"type": "string",
"example": "online"
}
},
"title": "Self hosted runners"
}
},
"total_count": {
"type": "number"
}
}
},
"examples": {
"default": {
"value": {
"runners": [
{
"busy": true,
"id": 23,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 11,
"name": "Linux",
"type": "read-only"
}
],
"name": "linux_runner",
"os": "linux",
"status": "online"
},
{
"busy": false,
"id": 24,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
],
"name": "mac_runner",
"os": "macos",
"status": "offline"
}
],
"total_count": 2
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
},
"put": {
"tags": [
"actions"
],
"summary": "Set self-hosted runners in a group for an organization",
"description": "Replaces the list of self-hosted runners that are part of an organization runner group.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization"
},
"operationId": "actions/set-self-hosted-runners-in-group-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"runners"
],
"properties": {
"runners": {
"description": "List of runner IDs to add to the runner group.",
"type": "array",
"items": {
"description": "Unique identifier of the runner.",
"type": "integer"
}
}
}
},
"example": {
"runners": [
9,
2
]
}
}
},
"required": null
},
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
}
}
],
[
"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}",
{
"put": {
"tags": [
"actions"
],
"summary": "Add a self-hosted runner to a group for an organization",
"description": "Adds a self-hosted runner to a runner group configured in an organization.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#add-a-self-hosted-runner-to-a-group-for-an-organization"
},
"operationId": "actions/add-self-hosted-runner-to-group-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_id",
"description": "Unique identifier of the self-hosted runner.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
},
"delete": {
"tags": [
"actions"
],
"summary": "Remove a self-hosted runner from a group for an organization",
"description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization"
},
"operationId": "actions/remove-self-hosted-runner-from-group-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_group_id",
"description": "Unique identifier of the self-hosted runner group.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_id",
"description": "Unique identifier of the self-hosted runner.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runner-groups"
}
}
}
],
[
"/orgs/{org}/actions/runners",
{
"get": {
"tags": [
"actions"
],
"summary": "List self-hosted runners for an organization",
"description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-self-hosted-runners-for-an-organization"
},
"operationId": "actions/list-self-hosted-runners-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"headers": {
"Link": {
"style": "simple",
"required": null,
"schema": {
"type": "string"
},
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\""
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"runners"
],
"properties": {
"runners": {
"type": "array",
"items": {
"description": "A self hosted runner",
"type": "object",
"required": [
"id",
"name",
"os",
"status",
"busy",
"labels"
],
"properties": {
"busy": {
"type": "boolean"
},
"id": {
"description": "The id of the runner.",
"type": "integer",
"example": 5
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the label.",
"type": "integer"
},
"name": {
"description": "Name of the label.",
"type": "string"
},
"type": {
"description": "The type of label. Read-only labels are applied automatically when the runner is configured.",
"type": "string",
"enum": [
"read-only",
"custom"
]
}
}
}
},
"name": {
"description": "The name of the runner.",
"type": "string",
"example": "iMac"
},
"os": {
"description": "The Operating System of the runner.",
"type": "string",
"example": "macos"
},
"status": {
"description": "The status of the runner.",
"type": "string",
"example": "online"
}
},
"title": "Self hosted runners"
}
},
"total_count": {
"type": "integer"
}
}
},
"examples": {
"default": {
"value": {
"runners": [
{
"busy": true,
"id": 23,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 11,
"name": "Linux",
"type": "read-only"
}
],
"name": "linux_runner",
"os": "linux",
"status": "online"
},
{
"busy": false,
"id": 24,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
],
"name": "mac_runner",
"os": "macos",
"status": "offline"
}
],
"total_count": 2
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runners"
}
}
}
],
[
"/orgs/{org}/actions/runners/downloads",
{
"get": {
"tags": [
"actions"
],
"summary": "List runner applications for an organization",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-runner-applications-for-an-organization"
},
"operationId": "actions/list-runner-applications-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "Runner Application",
"type": "object",
"required": [
"os",
"architecture",
"download_url",
"filename"
],
"properties": {
"architecture": {
"type": "string"
},
"download_url": {
"type": "string"
},
"filename": {
"type": "string"
},
"os": {
"type": "string"
},
"sha256_checksum": {
"type": "string"
},
"temp_download_token": {
"description": "A short lived bearer token used to download the runner, if needed.",
"type": "string"
}
},
"title": "Runner Application"
}
},
"examples": {
"default": {
"value": [
{
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz",
"filename": "actions-runner-osx-x64-2.164.0.tar.gz",
"os": "osx"
},
{
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz",
"filename": "actions-runner-linux-x64-2.164.0.tar.gz",
"os": "linux"
},
{
"architecture": "arm",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz",
"filename": "actions-runner-linux-arm-2.164.0.tar.gz",
"os": "linux"
},
{
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip",
"filename": "actions-runner-win-x64-2.164.0.zip",
"os": "win"
},
{
"architecture": "arm64",
"download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz",
"filename": "actions-runner-linux-arm64-2.164.0.tar.gz",
"os": "linux"
}
]
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runners"
}
}
}
],
[
"/orgs/{org}/actions/runners/registration-token",
{
"post": {
"tags": [
"actions"
],
"summary": "Create a registration token for an organization",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#create-a-registration-token-for-an-organization"
},
"operationId": "actions/create-registration-token-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Authentication Token",
"type": "object",
"required": [
"token",
"expires_at"
],
"properties": {
"expires_at": {
"description": "The time this token expires",
"type": "string",
"format": "date-time",
"example": "2016-07-11T22:14:10Z"
},
"permissions": {
"type": "object",
"example": {
"deployments": "write",
"issues": "read"
}
},
"repositories": {
"description": "The repositories this token has access to",
"type": "array",
"items": {
"description": "A git repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url",
"clone_url",
"default_branch",
"forks",
"forks_count",
"git_url",
"has_downloads",
"has_issues",
"has_projects",
"has_wiki",
"has_pages",
"homepage",
"language",
"archived",
"disabled",
"mirror_url",
"open_issues",
"open_issues_count",
"license",
"pushed_at",
"size",
"ssh_url",
"stargazers_count",
"svn_url",
"watchers",
"watchers_count",
"created_at",
"updated_at"
],
"properties": {
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"description": "Whether the repository is archived.",
"type": "boolean",
"default": false
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"type": "boolean",
"example": false,
"default": false
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"description": "Returns whether or not this repository disabled.",
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer"
},
"forks_count": {
"type": "integer",
"example": 9
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string",
"example": "git:github.com/octocat/Hello-World.git"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_issues": {
"description": "Whether issues are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"description": "Whether projects are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"type": "boolean",
"example": true,
"default": true
},
"homepage": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://github.com"
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"description": "Unique identifier of the repository",
"type": "integer",
"example": 42
},
"is_template": {
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"type": "boolean",
"example": true,
"default": false
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"nullable": true,
"allOf": [
{
"description": "License Simple",
"type": "object",
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"properties": {
"html_url": {
"type": "string",
"format": "uri"
},
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://api.github.com/licenses/mit"
}
},
"title": "License Simple"
}
]
},
"master_branch": {
"type": "string"
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "git:git.example.com/octocat/Hello-World"
},
"name": {
"description": "The name of the repository.",
"type": "string",
"example": "Team Environment"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer"
},
"open_issues_count": {
"type": "integer",
"example": 0
},
"organization": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"owner": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"required": [
"admin",
"pull",
"push"
],
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"description": "Whether the repository is private or public.",
"type": "boolean",
"default": false
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer",
"example": 108
},
"ssh_url": {
"type": "string",
"example": "git@github.com:octocat/Hello-World.git"
},
"stargazers_count": {
"type": "integer",
"example": 80
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:42Z\""
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"svn_url": {
"type": "string",
"format": "uri",
"example": "https://svn.github.com/octocat/Hello-World"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"temp_clone_token": {
"type": "string"
},
"template_repository": {
"type": "object",
"properties": {
"allow_merge_commit": {
"type": "boolean"
},
"allow_rebase_merge": {
"type": "boolean"
},
"allow_squash_merge": {
"type": "boolean"
},
"archive_url": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"default_branch": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"deployments_url": {
"type": "string"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"downloads_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"fork": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_url": {
"type": "string"
},
"has_downloads": {
"type": "boolean"
},
"has_issues": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"homepage": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"language": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"mirror_url": {
"type": "string"
},
"name": {
"type": "string"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"open_issues_count": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"size": {
"type": "integer"
},
"ssh_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"temp_clone_token": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
},
"visibility": {
"type": "string"
},
"watchers_count": {
"type": "integer"
}
},
"nullable": true
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:14:43Z"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World"
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
"type": "string",
"default": "public"
},
"watchers": {
"type": "integer"
},
"watchers_count": {
"type": "integer",
"example": 80
}
},
"title": "Repository"
}
},
"repository_selection": {
"description": "Describe whether all repositories have been selected or there's a selection involved",
"type": "string",
"enum": [
"all",
"selected"
]
},
"single_file": {
"type": "string",
"nullable": true,
"example": "config.yaml"
},
"token": {
"description": "The token used for authentication",
"type": "string",
"example": "v1.1f699f1069f60xxx"
}
},
"title": "Authentication Token"
},
"examples": {
"default": {
"value": {
"expires_at": "2020-01-22T12:13:35.123-08:00",
"token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runners"
}
}
}
],
[
"/orgs/{org}/actions/runners/remove-token",
{
"post": {
"tags": [
"actions"
],
"summary": "Create a remove token for an organization",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#create-a-remove-token-for-an-organization"
},
"operationId": "actions/create-remove-token-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Authentication Token",
"type": "object",
"required": [
"token",
"expires_at"
],
"properties": {
"expires_at": {
"description": "The time this token expires",
"type": "string",
"format": "date-time",
"example": "2016-07-11T22:14:10Z"
},
"permissions": {
"type": "object",
"example": {
"deployments": "write",
"issues": "read"
}
},
"repositories": {
"description": "The repositories this token has access to",
"type": "array",
"items": {
"description": "A git repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url",
"clone_url",
"default_branch",
"forks",
"forks_count",
"git_url",
"has_downloads",
"has_issues",
"has_projects",
"has_wiki",
"has_pages",
"homepage",
"language",
"archived",
"disabled",
"mirror_url",
"open_issues",
"open_issues_count",
"license",
"pushed_at",
"size",
"ssh_url",
"stargazers_count",
"svn_url",
"watchers",
"watchers_count",
"created_at",
"updated_at"
],
"properties": {
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"description": "Whether the repository is archived.",
"type": "boolean",
"default": false
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"type": "boolean",
"example": false,
"default": false
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"description": "Returns whether or not this repository disabled.",
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer"
},
"forks_count": {
"type": "integer",
"example": 9
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string",
"example": "git:github.com/octocat/Hello-World.git"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_issues": {
"description": "Whether issues are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"description": "Whether projects are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"type": "boolean",
"example": true,
"default": true
},
"homepage": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://github.com"
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"description": "Unique identifier of the repository",
"type": "integer",
"example": 42
},
"is_template": {
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"type": "boolean",
"example": true,
"default": false
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"nullable": true,
"allOf": [
{
"description": "License Simple",
"type": "object",
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"properties": {
"html_url": {
"type": "string",
"format": "uri"
},
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://api.github.com/licenses/mit"
}
},
"title": "License Simple"
}
]
},
"master_branch": {
"type": "string"
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "git:git.example.com/octocat/Hello-World"
},
"name": {
"description": "The name of the repository.",
"type": "string",
"example": "Team Environment"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer"
},
"open_issues_count": {
"type": "integer",
"example": 0
},
"organization": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"owner": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"required": [
"admin",
"pull",
"push"
],
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"description": "Whether the repository is private or public.",
"type": "boolean",
"default": false
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer",
"example": 108
},
"ssh_url": {
"type": "string",
"example": "git@github.com:octocat/Hello-World.git"
},
"stargazers_count": {
"type": "integer",
"example": 80
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:42Z\""
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"svn_url": {
"type": "string",
"format": "uri",
"example": "https://svn.github.com/octocat/Hello-World"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"temp_clone_token": {
"type": "string"
},
"template_repository": {
"type": "object",
"properties": {
"allow_merge_commit": {
"type": "boolean"
},
"allow_rebase_merge": {
"type": "boolean"
},
"allow_squash_merge": {
"type": "boolean"
},
"archive_url": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"default_branch": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"deployments_url": {
"type": "string"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"downloads_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"fork": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_url": {
"type": "string"
},
"has_downloads": {
"type": "boolean"
},
"has_issues": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"homepage": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"language": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"mirror_url": {
"type": "string"
},
"name": {
"type": "string"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"open_issues_count": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"size": {
"type": "integer"
},
"ssh_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"temp_clone_token": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string"
},
"visibility": {
"type": "string"
},
"watchers_count": {
"type": "integer"
}
},
"nullable": true
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:14:43Z"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World"
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
"type": "string",
"default": "public"
},
"watchers": {
"type": "integer"
},
"watchers_count": {
"type": "integer",
"example": 80
}
},
"title": "Repository"
}
},
"repository_selection": {
"description": "Describe whether all repositories have been selected or there's a selection involved",
"type": "string",
"enum": [
"all",
"selected"
]
},
"single_file": {
"type": "string",
"nullable": true,
"example": "config.yaml"
},
"token": {
"description": "The token used for authentication",
"type": "string",
"example": "v1.1f699f1069f60xxx"
}
},
"title": "Authentication Token"
},
"examples": {
"default": {
"value": {
"expires_at": "2020-01-29T12:13:35.123-08:00",
"token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runners"
}
}
}
],
[
"/orgs/{org}/actions/runners/{runner_id}",
{
"get": {
"tags": [
"actions"
],
"summary": "Get a self-hosted runner for an organization",
"description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#get-a-self-hosted-runner-for-an-organization"
},
"operationId": "actions/get-self-hosted-runner-for-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_id",
"description": "Unique identifier of the self-hosted runner.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "A self hosted runner",
"type": "object",
"required": [
"id",
"name",
"os",
"status",
"busy",
"labels"
],
"properties": {
"busy": {
"type": "boolean"
},
"id": {
"description": "The id of the runner.",
"type": "integer",
"example": 5
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the label.",
"type": "integer"
},
"name": {
"description": "Name of the label.",
"type": "string"
},
"type": {
"description": "The type of label. Read-only labels are applied automatically when the runner is configured.",
"type": "string",
"enum": [
"read-only",
"custom"
]
}
}
}
},
"name": {
"description": "The name of the runner.",
"type": "string",
"example": "iMac"
},
"os": {
"description": "The Operating System of the runner.",
"type": "string",
"example": "macos"
},
"status": {
"description": "The status of the runner.",
"type": "string",
"example": "online"
}
},
"title": "Self hosted runners"
},
"examples": {
"default": {
"value": {
"busy": true,
"id": 23,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
],
"name": "MBP",
"os": "macos",
"status": "online"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runners"
}
},
"delete": {
"tags": [
"actions"
],
"summary": "Delete a self-hosted runner from an organization",
"description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization"
},
"operationId": "actions/delete-self-hosted-runner-from-org",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "runner_id",
"description": "Unique identifier of the self-hosted runner.",
"required": true,
"schema": {
"type": "integer"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "self-hosted-runners"
}
}
}
],
[
"/orgs/{org}/actions/secrets",
{
"get": {
"tags": [
"actions"
],
"summary": "List organization secrets",
"description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-organization-secrets"
},
"operationId": "actions/list-org-secrets",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"headers": {
"Link": {
"style": "simple",
"required": null,
"schema": {
"type": "string"
},
"example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\""
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"secrets"
],
"properties": {
"secrets": {
"type": "array",
"items": {
"description": "Secrets for GitHub Actions for an organization.",
"type": "object",
"required": [
"name",
"created_at",
"updated_at",
"visibility"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"name": {
"description": "The name of the secret.",
"type": "string",
"example": "SECRET_TOKEN"
},
"selected_repositories_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/organizations/org/secrets/my_secret/repositories"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"visibility": {
"description": "Visibility of a secret",
"type": "string",
"enum": [
"all",
"private",
"selected"
]
}
},
"title": "Actions Secret for an Organization"
}
},
"total_count": {
"type": "integer"
}
}
},
"examples": {
"default": {
"value": {
"secrets": [
{
"created_at": "2019-08-10T14:59:22Z",
"name": "GIST_ID",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "private"
},
{
"created_at": "2019-08-10T14:59:22Z",
"name": "DEPLOY_TOKEN",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "all"
},
{
"created_at": "2019-08-10T14:59:22Z",
"name": "GH_TOKEN",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "selected"
}
],
"total_count": 3
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "secrets"
}
}
}
],
[
"/orgs/{org}/actions/secrets/public-key",
{
"get": {
"tags": [
"actions"
],
"summary": "Get an organization public key",
"description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#get-an-organization-public-key"
},
"operationId": "actions/get-org-public-key",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "The public key used for setting Actions Secrets.",
"type": "object",
"required": [
"key_id",
"key"
],
"properties": {
"created_at": {
"type": "string",
"example": "2011-01-26T19:01:12Z"
},
"id": {
"type": "integer",
"example": 2
},
"key": {
"description": "The Base64 encoded public key.",
"type": "string",
"example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs="
},
"key_id": {
"description": "The identifier for the key.",
"type": "string",
"example": "1234567"
},
"title": {
"type": "string",
"example": "ssh-rsa AAAAB3NzaC1yc2EAAA"
},
"url": {
"type": "string",
"example": "https://api.github.com/user/keys/2"
}
},
"title": "ActionsPublicKey"
},
"examples": {
"default": {
"value": {
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"key_id": "012345678912345678"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "secrets"
}
}
}
],
[
"/orgs/{org}/actions/secrets/{secret_name}",
{
"get": {
"tags": [
"actions"
],
"summary": "Get an organization secret",
"description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#get-an-organization-secret"
},
"operationId": "actions/get-org-secret",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "secret_name",
"description": "secret_name parameter",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"description": "Secrets for GitHub Actions for an organization.",
"type": "object",
"required": [
"name",
"created_at",
"updated_at",
"visibility"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"name": {
"description": "The name of the secret.",
"type": "string",
"example": "SECRET_TOKEN"
},
"selected_repositories_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/organizations/org/secrets/my_secret/repositories"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"visibility": {
"description": "Visibility of a secret",
"type": "string",
"enum": [
"all",
"private",
"selected"
]
}
},
"title": "Actions Secret for an Organization"
},
"examples": {
"default": {
"value": {
"created_at": "2019-08-10T14:59:22Z",
"name": "GH_TOKEN",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "selected"
}
}
}
}
}
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "secrets"
}
},
"put": {
"tags": [
"actions"
],
"summary": "Create or update an organization secret",
"description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#create-or-update-an-organization-secret"
},
"operationId": "actions/create-or-update-org-secret",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "secret_name",
"description": "secret_name parameter",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"visibility"
],
"properties": {
"encrypted_value": {
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.1/rest/reference/actions#get-an-organization-public-key) endpoint.",
"type": "string",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
},
"key_id": {
"description": "ID of the key you used to encrypt the secret.",
"type": "string"
},
"selected_repository_ids": {
"description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.1/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.1/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
"type": "array",
"items": {
"type": "string"
}
},
"visibility": {
"description": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.",
"type": "string",
"enum": [
"all",
"private",
"selected"
]
}
}
},
"example": {
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"selected_repository_ids": [
"1296269",
"1296280"
],
"visibility": "selected"
}
}
},
"required": null
},
"responses": {
"201": {
"description": "Response when creating a secret",
"content": {
"application/json": {
"schema": {
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false,
"title": "Empty Object"
}
}
}
},
"204": {
"description": "Response when updating a secret"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "secrets"
}
},
"delete": {
"tags": [
"actions"
],
"summary": "Delete an organization secret",
"description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#delete-an-organization-secret"
},
"operationId": "actions/delete-org-secret",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "secret_name",
"description": "secret_name parameter",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "Response"
}
},
"deprecated": null,
"x-github": {
"category": "actions",
"enabledForGitHubApps": true,
"githubCloudOnly": false,
"previews": [],
"subcategory": "secrets"
}
}
}
],
[
"/orgs/{org}/actions/secrets/{secret_name}/repositories",
{
"get": {
"tags": [
"actions"
],
"summary": "List selected repositories for an organization secret",
"description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/actions#list-selected-repositories-for-an-organization-secret"
},
"operationId": "actions/list-selected-repos-for-org-secret",
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "secret_name",
"description": "secret_name parameter",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "page",
"description": "Page number of the results to fetch.",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"allowReserved": null,
"style": "form"
},
{
"in": "query",
"name": "per_page",
"description": "Results per page (max 100).",
"required": false,
"schema": {
"type": "integer",
"default": 30
},
"allowReserved": null,
"style": "form"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_count",
"repositories"
],
"properties": {
"repositories": {
"type": "array",
"items": {
"description": "Minimal Repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url"
],
"properties": {
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"type": "boolean"
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string"
},
"code_of_conduct": {
"description": "Code Of Conduct",
"type": "object",
"required": [
"url",
"html_url",
"key",
"name"
],
"properties": {
"body": {
"type": "string",
"example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
},
"html_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"key": {
"type": "string",
"example": "contributor_covenant"
},
"name": {
"type": "string",
"example": "Contributor Covenant"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/codes_of_conduct/contributor_covenant"
}
},
"title": "Code Of Conduct"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer",
"example": 0
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string"
},
"has_downloads": {
"type": "boolean"
},
"has_issues": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"homepage": {
"type": "string",
"nullable": true
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"type": "integer",
"example": 1296269
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"spdx_id": {
"type": "string"
},
"url": {
"type": "string"
}
},
"nullable": true
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"example": "Hello-World"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer",
"example": 0
},
"open_issues_count": {
"type": "integer"
},
"owner": {
"type": "object",
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer"
},
"ssh_url": {
"type": "string"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"svn_url": {
"type": "string"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"temp_clone_token": {
"type": "string"
},
"template_repository": {
"type": "object",
"nullable": true,
"allOf": [
{
"description": "A git repository",
"type": "object",
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url",
"clone_url",
"default_branch",
"forks",
"forks_count",
"git_url",
"has_downloads",
"has_issues",
"has_projects",
"has_wiki",
"has_pages",
"homepage",
"language",
"archived",
"disabled",
"mirror_url",
"open_issues",
"open_issues_count",
"license",
"pushed_at",
"size",
"ssh_url",
"stargazers_count",
"svn_url",
"watchers",
"watchers_count",
"created_at",
"updated_at"
],
"properties": {
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"type": "boolean",
"example": true,
"default": true
},
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"archived": {
"description": "Whether the repository is archived.",
"type": "boolean",
"default": false
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:01:12Z"
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"type": "boolean",
"example": false,
"default": false
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"description": {
"type": "string",
"nullable": true,
"example": "This your first repo!"
},
"disabled": {
"description": "Returns whether or not this repository disabled.",
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer"
},
"forks_count": {
"type": "integer",
"example": 9
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string",
"example": "git:github.com/octocat/Hello-World.git"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_issues": {
"description": "Whether issues are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"description": "Whether projects are enabled.",
"type": "boolean",
"example": true,
"default": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"type": "boolean",
"example": true,
"default": true
},
"homepage": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://github.com"
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"id": {
"description": "Unique identifier of the repository",
"type": "integer",
"example": 42
},
"is_template": {
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"type": "boolean",
"example": true,
"default": false
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"license": {
"nullable": true,
"allOf": [
{
"description": "License Simple",
"type": "object",
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"properties": {
"html_url": {
"type": "string",
"format": "uri"
},
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "https://api.github.com/licenses/mit"
}
},
"title": "License Simple"
}
]
},
"master_branch": {
"type": "string"
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"mirror_url": {
"type": "string",
"format": "uri",
"nullable": true,
"example": "git:git.example.com/octocat/Hello-World"
},
"name": {
"description": "The name of the repository.",
"type": "string",
"example": "Team Environment"
},
"network_count": {
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"open_issues": {
"type": "integer"
},
"open_issues_count": {
"type": "integer",
"example": 0
},
"organization": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"owner": {
"nullable": true,
"allOf": [
{
"description": "Simple User",
"type": "object",
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"properties": {
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"gravatar_id": {
"type": "string",
"nullable": true,
"example": "41d064eb2195891e12d0413f63227ea7"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"id": {
"type": "integer",
"example": 1
},
"login": {
"type": "string",
"example": "octocat"
},
"name": {
"type": "string",
"nullable": true
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"type": {
"type": "string",
"example": "User"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
}
},
"nullable": true,
"title": "Simple User"
}
]
},
"permissions": {
"type": "object",
"required": [
"admin",
"pull",
"push"
],
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
}
},
"private": {
"description": "Whether the repository is private or public.",
"type": "boolean",
"default": false
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2011-01-26T19:06:43Z"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"size": {
"type": "integer",
"example": 108
},
"ssh_url": {
"type": "string",
"example": "git@github.com:octocat/Hello-World.git"
},
"stargazers_count": {
"type": "integer",
"example": 80
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:42Z\""
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_count": {
"type": "integer"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/sub
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment