secrets

Creates, updates, deletes, gets or lists a secrets resource.

Overview

Name	secrets
Type	Resource
Id	github.dependabot.secrets

Fields

The following fields are returned by SELECT queries:

get_repo_secret

Response

Name	Datatype	Description
name	string	The name of the secret. (example: MY_ARTIFACTORY_PASSWORD)
created_at	string (date-time)
updated_at	string (date-time)

get_org_secret

Response

Name	Datatype	Description
name	string	The name of the secret. (example: SECRET_TOKEN)
created_at	string (date-time)
selected_repositories_url	string (uri)	(example: https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories)
updated_at	string (date-time)
visibility	string	Visibility of a secret (all, private, selected)

list_repo_secrets

Response

Name	Datatype	Description
secrets	array
total_count	integer

list_org_secrets

Response

Name	Datatype	Description
secrets	array
total_count	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_repo_secret	select	owner, repo, secret_name		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.
get_org_secret	select	org, secret_name		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.
list_repo_secrets	select	owner, repo	per_page, page	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.
list_org_secrets	select	org	per_page, page	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.
create_or_update_repo_secret	insert	owner, repo, secret_name		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.
create_or_update_org_secret	insert	org, secret_name, visibility		Creates or updates an organization 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 admin:org scope to use this endpoint.
delete_repo_secret	delete	owner, repo, secret_name		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.
delete_org_secret	delete	org, secret_name		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.
secret_name	string	The name of the secret.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

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.

SELECT
name,
created_at,
updated_at
FROM github.dependabot.secrets
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND secret_name = '{{ secret_name }}' -- required
;

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.

SELECT
name,
created_at,
selected_repositories_url,
updated_at,
visibility
FROM github.dependabot.secrets
WHERE org = '{{ org }}' -- required
AND secret_name = '{{ secret_name }}' -- required
;

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.

SELECT
secrets,
total_count
FROM github.dependabot.secrets
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

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.

SELECT
secrets,
total_count
FROM github.dependabot.secrets
WHERE org = '{{ org }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

INSERT examples

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.

INSERT INTO github.dependabot.secrets (
encrypted_value,
key_id,
owner,
repo,
secret_name
)
SELECT 
'{{ encrypted_value }}',
'{{ key_id }}',
'{{ owner }}',
'{{ repo }}',
'{{ secret_name }}'
;

create_or_update_org_secret

Creates or updates an organization 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 admin:org scope to use this endpoint.

INSERT INTO github.dependabot.secrets (
encrypted_value,
key_id,
visibility,
selected_repository_ids,
org,
secret_name
)
SELECT 
'{{ encrypted_value }}',
'{{ key_id }}',
'{{ visibility }}' /* required */,
'{{ selected_repository_ids }}',
'{{ org }}',
'{{ secret_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: secrets
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the secrets resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the secrets resource.
  - name: secret_name
    value: "{{ secret_name }}"
    description: Required parameter for the secrets resource.
  - name: org
    value: "{{ org }}"
    description: Required parameter for the secrets resource.
  - name: encrypted_value
    value: "{{ encrypted_value }}"
    description: |
      Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.
  - name: key_id
    value: "{{ key_id }}"
    description: |
      ID of the key you used to encrypt the secret.
  - name: visibility
    value: "{{ visibility }}"
    description: |
      Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
    valid_values: ['all', 'private', 'selected']
  - name: selected_repository_ids
    value: "{{ selected_repository_ids }}"
    description: |
      An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.

DELETE examples

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.

DELETE FROM github.dependabot.secrets
WHERE owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND secret_name = '{{ secret_name }}' --required
;

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.

DELETE FROM github.dependabot.secrets
WHERE org = '{{ org }}' --required
AND secret_name = '{{ secret_name }}' --required
;