From 012beafe1b17fd687bf58e9dfbeed0f316191235 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 26 Jul 2023 09:42:25 -0700 Subject: [PATCH] Update OpenAPI Description (#39737) --- .../fine-grained-pat-permissions.json | 9 + .../data/fpt-2022-11-28/fine-grained-pat.json | 6 + .../server-to-server-permissions.json | 11 + .../fpt-2022-11-28/server-to-server-rest.json | 6 + .../fpt-2022-11-28/user-to-server-rest.json | 6 + .../fine-grained-pat-permissions.json | 9 + .../ghec-2022-11-28/fine-grained-pat.json | 6 + .../server-to-server-permissions.json | 11 + .../server-to-server-rest.json | 6 + .../ghec-2022-11-28/user-to-server-rest.json | 6 + src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 567 ++++++++++++++--- src/rest/data/ghae/schema.json | 60 +- src/rest/data/ghec-2022-11-28/schema.json | 569 +++++++++++++++--- src/rest/data/ghes-3.6/schema.json | 92 +-- src/rest/data/ghes-3.7/schema.json | 92 +-- src/rest/data/ghes-3.8/schema.json | 130 ++-- src/rest/data/ghes-3.9-2022-11-28/schema.json | 134 ++--- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 20 files changed, 1328 insertions(+), 398 deletions(-) diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index fa4e992dec..6da1fcdbf7 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -3472,6 +3472,15 @@ "title": "Contents", "displayTitle": "Repository permissions for \"Contents\"", "permissions": [ + { + "category": "repos", + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity", + "additional-permissions": [], + "access": "read" + }, { "category": "branches", "slug": "list-branches", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 41886981fc..3023ece748 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -3746,6 +3746,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}" }, + { + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity" + }, { "slug": "list-all-autolinks-of-a-repository", "subcategory": "autolinks", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index e85aecc227..03da3f7e38 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -4290,6 +4290,17 @@ "title": "Contents", "displayTitle": "Repository permissions for \"Contents\"", "permissions": [ + { + "category": "repos", + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "branches", "slug": "list-branches", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index c32622a6bb..4bfc9853a1 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -3382,6 +3382,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}" }, + { + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity" + }, { "slug": "list-all-autolinks-of-a-repository", "subcategory": "autolinks", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 0f1efc67ff..58462b7e22 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -3812,6 +3812,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}" }, + { + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity" + }, { "slug": "list-all-autolinks-of-a-repository", "subcategory": "autolinks", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index 650e8b0513..093e5ee252 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -4031,6 +4031,15 @@ "title": "Contents", "displayTitle": "Repository permissions for \"Contents\"", "permissions": [ + { + "category": "repos", + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity", + "additional-permissions": [], + "access": "read" + }, { "category": "branches", "slug": "list-branches", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index 199c7efbb1..32c337f821 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -3996,6 +3996,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}" }, + { + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity" + }, { "slug": "list-all-autolinks-of-a-repository", "subcategory": "autolinks", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index cbcc649795..da4c5c3869 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -4980,6 +4980,17 @@ "title": "Contents", "displayTitle": "Repository permissions for \"Contents\"", "permissions": [ + { + "category": "repos", + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "branches", "slug": "list-branches", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index db7732cbcc..3d3f9576a2 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -3632,6 +3632,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}" }, + { + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity" + }, { "slug": "list-all-autolinks-of-a-repository", "subcategory": "autolinks", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index d3de62f4c0..2396c7dd3a 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -4062,6 +4062,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}" }, + { + "slug": "list-repository-activities", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity" + }, { "slug": "list-all-autolinks-of-a-repository", "subcategory": "autolinks", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index c1cd70592d..3362153ca3 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "a57e233e49ce02b9c7445b38c8d8c920c95dddfd" + "sha": "8482a8d60da584a11eb150f7849ad78b2f58aadd" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index a761630f9b..b4100997b8 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -599,7 +599,7 @@ } ], "previews": [], - "descriptionHTML": "
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip.
You must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions:read permission to use this endpoint.
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.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets a single organization secret without revealing its encrypted value.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -5401,7 +5401,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
Deletes a secret in an organization using the secret name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Lists all repositories that have been selected when the visibility\nfor 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.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all organization secrets shared with a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -7226,7 +7226,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in a repository using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in an environment without revealing their\nencrypted values.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -7748,7 +7748,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in an environment using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -11454,7 +11454,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -11621,7 +11621,7 @@
}
],
"previews": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this\nendpoint.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all organization variables. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Lists all organization variables.\nYou must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
Creates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Gets a specific variable in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Updates an organization variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an organization variable using the variable name.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Deletes an organization variable using the variable name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Lists all repositories that can access an organization variable\nthat is available to selected repositories.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this\nendpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all organiation variables shared with a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Lists all repository variables.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
Lists all environment variables.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environments:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environments:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote: GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
GitHub Apps must have read and write permission for Deployments to use this endpoint.
", + "descriptionHTML": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote: GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
If the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have read and write permission for Deployments to use this endpoint.
Forbidden
" + "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -458784,6 +458784,433 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity", + "title": "List repository activities", + "category": "repos", + "subcategory": "repos", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "ref", + "description": "The Git reference for the activities you want to list.
\nThe ref for a branch can be formatted either as refs/heads/BRANCH_NAME or BRANCH_NAME, where BRANCH_NAME is the name of your branch.
The GitHub username to use to filter by the actor who performed the activity.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.
\nFor example, day will filter for activity that occurred in the past 24 hours, and week will filter for activity that occurred in the past 7 days (168 hours).
The activity type to filter by.
\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "push", + "force_push", + "branch_creation", + "branch_deletion", + "pr_merge", + "merge_queue_merge" + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "before": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "after": "827efc6d56897b048c772eb4087f854f46256132", + "ref": "refs/heads/main", + "pushed_at": "2011-01-26T19:06:43Z", + "push_type": "normal", + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Activity", + "description": "Activity", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "before": { + "type": "string", + "description": "The SHA of the commit before the activity.", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "after": { + "type": "string", + "description": "The SHA of the commit after the activity.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.
\nFor more information about viewing repository activity,\nsee \"Viewing repository activity.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -537045,7 +537472,7 @@ } ], "previews": [], - "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip.
You must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions:read permission to use this endpoint.
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.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets a single organization secret without revealing its encrypted value.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -4612,7 +4612,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
Deletes a secret in an organization using the secret name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Lists all repositories that have been selected when the visibility\nfor 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.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all organization secrets shared with a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -6437,7 +6437,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in a repository using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -15207,7 +15207,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -15374,7 +15374,7 @@
}
],
"previews": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip.
You must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions:read permission to use this endpoint.
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.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets a single organization secret without revealing its encrypted value.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -6341,7 +6341,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
Deletes a secret in an organization using the secret name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Lists all repositories that have been selected when the visibility\nfor 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.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all organization secrets shared with a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8166,7 +8166,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in a repository using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in an environment without revealing their\nencrypted values.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8688,7 +8688,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in an environment using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -21068,7 +21068,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -21235,7 +21235,7 @@
}
],
"previews": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this\nendpoint.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all organization variables. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Lists all organization variables.\nYou must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
Creates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Gets a specific variable in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Updates an organization variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an organization variable using the variable name.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Deletes an organization variable using the variable name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Lists all repositories that can access an organization variable\nthat is available to selected repositories.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this\nendpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all organiation variables shared with a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Lists all repository variables.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
Lists all environment variables.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environments:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environments:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote: GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
GitHub Apps must have read and write permission for Deployments to use this endpoint.
", + "descriptionHTML": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote: GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
If the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have read and write permission for Deployments to use this endpoint.
Forbidden
" + "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -475831,6 +475831,433 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/activity", + "title": "List repository activities", + "category": "repos", + "subcategory": "repos", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "ref", + "description": "The Git reference for the activities you want to list.
\nThe ref for a branch can be formatted either as refs/heads/BRANCH_NAME or BRANCH_NAME, where BRANCH_NAME is the name of your branch.
The GitHub username to use to filter by the actor who performed the activity.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.
\nFor example, day will filter for activity that occurred in the past 24 hours, and week will filter for activity that occurred in the past 7 days (168 hours).
The activity type to filter by.
\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "push", + "force_push", + "branch_creation", + "branch_deletion", + "pr_merge", + "merge_queue_merge" + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "before": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "after": "827efc6d56897b048c772eb4087f854f46256132", + "ref": "refs/heads/main", + "pushed_at": "2011-01-26T19:06:43Z", + "push_type": "normal", + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Activity", + "description": "Activity", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "before": { + "type": "string", + "description": "The SHA of the commit before the activity.", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "after": { + "type": "string", + "description": "The SHA of the commit after the activity.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.
\nFor more information about viewing repository activity,\nsee \"Viewing repository activity.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -503622,7 +504049,7 @@ }, { "name": "filter", - "description": "Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query:
?filter=userName%20eq%20\\\"Octocat\\\".
To filter results for the identity with the email octocat@github.com, you would use this query:
?filter=emails%20eq%20\\\"octocat@github.com\\\".
Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and externalId. For example, to search for an identity with the userName Octocat, you would use this query:
?filter=userName%20eq%20\\\"Octocat\\\".
To filter results for the identity with the email octocat@github.com, you would use this query:
?filter=emails%20eq%20\\\"octocat@github.com\\\".
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip.
You must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions:read permission to use this endpoint.
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.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets a single organization secret without revealing its encrypted value.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -5763,7 +5763,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
Deletes a secret in an organization using the secret name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Lists all repositories that have been selected when the visibility\nfor 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.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -7396,7 +7396,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in a repository using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in an environment without revealing their\nencrypted values.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -7918,7 +7918,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in an environment using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -19781,7 +19781,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -19948,7 +19948,7 @@
}
],
"previews": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this\nendpoint.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Forbidden
" + "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -457319,7 +457319,7 @@ } ], "previews": [], - "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip.
You must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions:read permission to use this endpoint.
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.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets a single organization secret without revealing its encrypted value.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -6529,7 +6529,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
Deletes a secret in an organization using the secret name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Lists all repositories that have been selected when the visibility\nfor 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.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8165,7 +8165,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in a repository using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in an environment without revealing their\nencrypted values.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8687,7 +8687,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in an environment using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -20585,7 +20585,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -20752,7 +20752,7 @@
}
],
"previews": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this\nendpoint.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Forbidden
" + "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -461239,7 +461239,7 @@ } ], "previews": [], - "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip.
You must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions:read permission to use this endpoint.
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.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets a single organization secret without revealing its encrypted value.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -6550,7 +6550,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
Deletes a secret in an organization using the secret name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Lists all repositories that have been selected when the visibility\nfor 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.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8186,7 +8186,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in a repository using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in an environment without revealing their\nencrypted values.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8708,7 +8708,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in an environment using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -20606,7 +20606,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -20773,7 +20773,7 @@
}
],
"previews": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this\nendpoint.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all organization variables. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Lists all organization variables.\nYou must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
Creates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Gets a specific variable in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Updates an organization variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an organization variable using the variable name.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Deletes an organization variable using the variable name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Lists all repositories that can access an organization variable\nthat is available to selected repositories.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this\nendpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Lists all repository variables.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
Lists all environment variables.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environments:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environments:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Forbidden
" + "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -471532,7 +471532,7 @@ } ], "previews": [], - "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip.
You must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions:read permission to use this endpoint.
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.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Gets a single organization secret without revealing its encrypted value.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -6550,7 +6550,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
Deletes a secret in an organization using the secret name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
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.
Lists all repositories that have been selected when the visibility\nfor 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.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. 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.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the secrets organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all organization secrets shared with a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8361,7 +8361,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in a repository using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists all secrets available in an environment without revealing their\nencrypted values.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
+ "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8883,7 +8883,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Deletes a secret in an environment using the secret name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the secrets repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -20825,7 +20825,7 @@
}
],
"previews": [],
- "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -20992,7 +20992,7 @@
}
],
"previews": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate using an access token with the repo scope to use this endpoint.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to the config script. The token\nexpires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this\nendpoint.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
Lists all organization variables. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Lists all organization variables.\nYou must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
Creates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Gets a specific variable in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Updates an organization variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an organization variable using the variable name.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Deletes an organization variable using the variable name.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
Lists all repositories that can access an organization variable\nthat is available to selected repositories.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this\nendpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.
You must authenticate using an access token with the admin:org scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all organiation variables shared with a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Lists all repository variables.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions_variables:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
Lists all environment variables.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environments:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environments:read repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.\nYou must authenticate using an access token with the repo scope to use this endpoint.\nGitHub Apps must have the environment:write repository permission to use this endpoint.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the environment:write repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
Cancels a workflow run using its id.
You must authenticate using an access token with the repo scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo scope.\nGitHub Apps must have the actions:write permission to use this endpoint.
Forbidden
" + "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -490029,7 +490029,7 @@ } ], "previews": [], - "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.