Get a secret for the authenticated user | Sample

1 parameter

secret_namestringrequired

The name of the secret.

1 status code

200Response

namestringrequired

The name of the secret

created_atstringrequired

The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.

updated_atstringrequired

The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.

visibilitystringrequired

The type of repositories in the organization that the secret is visible to

Allowed:allprivateselected

selected_repositories_urlstringrequired

The API URL at which the list of repositories this secret is visible to can be retrieved

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.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.get({ secretName: "sk_live_4eC39Hq" });

{
  "name": "CODESPACE_GH_SECRET",
  "created_at": "2019-08-10T14:59:22Z",
  "updated_at": "2020-01-10T14:59:22Z",
  "visibility": "selected",
  "selected_repositories_url": "https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories"
}

Was this helpful?

Request

Response