PUT/repos/{owner}/{repo}/actions/secrets/{secret_name}

Create or update a repository secret

Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters · 2 body fields

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

secret_namestringrequired

The name of the secret.

encrypted_valuestringrequired

Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint.

key_idstringrequired

ID of the key you used to encrypt the secret.

2 status codes

201Response when creating a secret

204Response when updating a secret

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.secrets.update({
  owner: "octocat",
  repo: "hello-world",
  secretName: "sk_live_4eC39Hq",
  encryptedValue: "example",
  keyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{}