Module dependabot_api

Source

Enums§

DependabotSlashAddSelectedRepoToOrgSecretError
struct for typed errors of method dependabot_slash_add_selected_repo_to_org_secret
DependabotSlashCreateOrUpdateOrgSecretError
struct for typed errors of method dependabot_slash_create_or_update_org_secret
DependabotSlashCreateOrUpdateRepoSecretError
struct for typed errors of method dependabot_slash_create_or_update_repo_secret
DependabotSlashDeleteOrgSecretError
struct for typed errors of method dependabot_slash_delete_org_secret
DependabotSlashDeleteRepoSecretError
struct for typed errors of method dependabot_slash_delete_repo_secret
DependabotSlashGetAlertError
struct for typed errors of method dependabot_slash_get_alert
DependabotSlashGetOrgPublicKeyError
struct for typed errors of method dependabot_slash_get_org_public_key
DependabotSlashGetOrgSecretError
struct for typed errors of method dependabot_slash_get_org_secret
DependabotSlashGetRepoPublicKeyError
struct for typed errors of method dependabot_slash_get_repo_public_key
DependabotSlashGetRepoSecretError
struct for typed errors of method dependabot_slash_get_repo_secret
DependabotSlashListAlertsForEnterpriseError
struct for typed errors of method dependabot_slash_list_alerts_for_enterprise
DependabotSlashListAlertsForOrgError
struct for typed errors of method dependabot_slash_list_alerts_for_org
DependabotSlashListAlertsForRepoError
struct for typed errors of method dependabot_slash_list_alerts_for_repo
DependabotSlashListOrgSecretsError
struct for typed errors of method dependabot_slash_list_org_secrets
DependabotSlashListRepoSecretsError
struct for typed errors of method dependabot_slash_list_repo_secrets
DependabotSlashListSelectedReposForOrgSecretError
struct for typed errors of method dependabot_slash_list_selected_repos_for_org_secret
DependabotSlashRemoveSelectedRepoFromOrgSecretError
struct for typed errors of method dependabot_slash_remove_selected_repo_from_org_secret
DependabotSlashSetSelectedReposForOrgSecretError
struct for typed errors of method dependabot_slash_set_selected_repos_for_org_secret
DependabotSlashUpdateAlertError
struct for typed errors of method dependabot_slash_update_alert

Functions§

dependabot_slash_add_selected_repo_to_org_secret
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. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
dependabot_slash_create_or_update_org_secret
Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint. #### Example encrypting a secret using Node.js Encrypt your secret using the tweetsodium library. const sodium = require('tweetsodium'); const key = \"base64-encoded-public-key\"; const value = \"plain-text-secret\"; // Convert the message and key to Uint8Array's (Buffer implements that interface) const messageBytes = Buffer.from(value); const keyBytes = Buffer.from(key, 'base64'); // Encrypt using LibSodium. const encryptedBytes = sodium.seal(messageBytes, keyBytes); // Base64 the encrypted secret const encrypted = Buffer.from(encryptedBytes).toString('base64'); console.log(encrypted); #### 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. ruby require \"rbnacl\" require \"base64\" key = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\") public_key = RbNaCl::PublicKey.new(key) box = RbNaCl::Boxes::Sealed.from_public_key(public_key) encrypted_secret = box.encrypt(\"my_secret\") # Print the base64 encoded secret puts Base64.strict_encode64(encrypted_secret)
dependabot_slash_create_or_update_repo_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." OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
dependabot_slash_delete_org_secret
Deletes a secret in an organization using the secret name. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
dependabot_slash_delete_repo_secret
Deletes a secret in a repository using the secret name. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
dependabot_slash_get_alert
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
dependabot_slash_get_org_public_key
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
dependabot_slash_get_org_secret
Gets a single organization secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
dependabot_slash_get_repo_public_key
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. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint if the repository is private.
dependabot_slash_get_repo_secret
Gets a single repository secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
dependabot_slash_list_alerts_for_enterprise
Lists Dependabot alerts for repositories that are owned by the specified enterprise. The authenticated user must be a member of the enterprise to use this endpoint. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "Managing security managers in your organization." OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint.
dependabot_slash_list_alerts_for_org
Lists Dependabot alerts for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
dependabot_slash_list_alerts_for_repo
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
dependabot_slash_list_org_secrets
Lists all secrets available in an organization without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
dependabot_slash_list_repo_secrets
Lists all secrets available in a repository without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
dependabot_slash_list_selected_repos_for_org_secret
Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
dependabot_slash_remove_selected_repo_from_org_secret
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. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
dependabot_slash_set_selected_repos_for_org_secret
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. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
dependabot_slash_update_alert
The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "Granting access to security alerts." OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.