Create or update a repository secret

Creates or updates a repository secret with an encrypted value. Encrypt your secret using
LibSodium. 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.

Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

from base64 import b64encode
from nacl import encoding, public

def encrypt(public_key: str, secret_value: str) -> str:
  """Encrypt a Unicode string using the public key."""
  public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
  sealed_box = public.SealedBox(public_key)
  encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
  return b64encode(encrypted).decode("utf-8")

Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");

var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);

Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));

Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

curl --location --request PUT 'https://api.github.com/repos///actions/secrets/' \ --header 'Content-Type: application/json' \ --data-raw '{ "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }'

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

secret_name

string

必需

secret_name parameter

Body 参数application/json

encrypted_value

string

可选

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

正则匹配:

^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$

key_id

string

可选

ID of the key you used to encrypt the secret.

示例

Create or update a repository secret

Example encrypting a secret using Node.js#

Example encrypting a secret using Python#

Example encrypting a secret using C##

Example encrypting a secret using Ruby#

请求参数

返回响应

Example encrypting a secret using Node.js

Example encrypting a secret using Python

Example encrypting a secret using C#

Example encrypting a secret using Ruby