Secretos de Acciones de GitHub

Usa la API REST para interactuar con secretos en GitHub Actions.

Acerca de los secretos de GitHub Actions

Puedes usar la API de REST para crear, actualizar, eliminar y recuperar información sobre secretos que se pueden usar en flujos de trabajo de GitHub Actions. Los secretos te permiten almacenar información confidencial, como los tokens de acceso, en tu repositorio, entornos de repositorio u organización. Para más información, consulta "Uso de secretos en Acciones de GitHub".

List organization secrets

Funciona con GitHub Apps

Lists all secrets available in an organization without revealing their encrypted values.

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "List organization secrets"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). Valor predeterminado: `30`
`page` integer Page number of the results to fetch. Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List organization secrets"

status code	Descripción
`200`	OK

Ejemplos de código para "List organization secrets"

get/orgs/{org}/actions/secrets

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets

Response

Status: 200

{
  "total_count": 3,
  "secrets": [
    {
      "name": "GIST_ID",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z",
      "visibility": "private"
    },
    {
      "name": "DEPLOY_TOKEN",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z",
      "visibility": "all"
    },
    {
      "name": "GH_TOKEN",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z",
      "visibility": "selected",
      "selected_repositories_url": "https://HOSTNAME/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories"
    }
  ]
}

Get an organization public key

Funciona con GitHub Apps

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Get an organization public key"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.

Códigos de estado de respuesta HTTP para "Get an organization public key"

status code	Descripción
`200`	OK

Ejemplos de código para "Get an organization public key"

get/orgs/{org}/actions/secrets/public-key

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets/public-key

Response

Status: 200

{
  "key_id": "012345678912345678",
  "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
}

Get an organization secret

Funciona con GitHub Apps

Gets a single organization secret without revealing its encrypted value.

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Get an organization secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.

Códigos de estado de respuesta HTTP para "Get an organization secret"

status code	Descripción
`200`	OK

Ejemplos de código para "Get an organization secret"

get/orgs/{org}/actions/secrets/{secret_name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets/SECRET_NAME

Response

Status: 200

{
  "name": "GH_TOKEN",
  "created_at": "2019-08-10T14:59:22Z",
  "updated_at": "2020-01-10T14:59:22Z",
  "visibility": "selected",
  "selected_repositories_url": "https://HOSTNAME/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories"
}

Create or update an organization secret

Funciona con GitHub Apps

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."

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Create or update an organization secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`encrypted_value` string Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
`key_id` string ID of the key you used to encrypt the secret.
`visibility` string Requerido 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. Puede ser uno de los siguientes: `all`, `private`, `selected`
`selected_repository_ids` array of integers 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, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

Códigos de estado de respuesta HTTP para "Create or update an organization secret"

status code	Descripción
`201`	Response when creating a secret
`204`	Response when updating a secret

Ejemplos de código para "Create or update an organization secret"

Select the example type

put/orgs/{org}/actions/secrets/{secret_name}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets/SECRET_NAME \
  -d '{"encrypted_value":"c2VjcmV0","key_id":"012345678912345678","visibility":"selected","selected_repository_ids":[1296269,1296280]}'

Response when creating a secret

Status: 201

Delete an organization secret

Funciona con GitHub Apps

Deletes a secret in an organization using the secret name.

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Delete an organization secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.

Códigos de estado de respuesta HTTP para "Delete an organization secret"

status code	Descripción
`204`	No Content

Ejemplos de código para "Delete an organization secret"

delete/orgs/{org}/actions/secrets/{secret_name}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets/SECRET_NAME

Response

Status: 204

List selected repositories for an organization secret

Funciona con GitHub Apps

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected.

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "List selected repositories for an organization secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.

Parámetros de consulta
Nombre, Tipo, Descripción
`page` integer Page number of the results to fetch. Valor predeterminado: `1`
`per_page` integer The number of results per page (max 100). Valor predeterminado: `30`

Códigos de estado de respuesta HTTP para "List selected repositories for an organization secret"

status code	Descripción
`200`	OK

Ejemplos de código para "List selected repositories for an organization secret"

get/orgs/{org}/actions/secrets/{secret_name}/repositories

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories

Response

Status: 200

{
  "total_count": 1,
  "repositories": [
    {
      "id": 1296269,
      "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
      "name": "Hello-World",
      "full_name": "octocat/Hello-World",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://HOSTNAME/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://HOSTNAME/users/octocat/followers",
        "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
        "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
        "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
        "organizations_url": "https://HOSTNAME/users/octocat/orgs",
        "repos_url": "https://HOSTNAME/users/octocat/repos",
        "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
        "received_events_url": "https://HOSTNAME/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "private": false,
      "html_url": "https://github.com/octocat/Hello-World",
      "description": "This your first repo!",
      "fork": false,
      "url": "https://HOSTNAME/repos/octocat/Hello-World",
      "archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
      "assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
      "blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
      "branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
      "collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
      "comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
      "commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
      "compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
      "contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
      "contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
      "deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
      "downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
      "events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
      "forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
      "git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
      "git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
      "git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
      "git_url": "git:github.com/octocat/Hello-World.git",
      "issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
      "issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
      "issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
      "keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
      "labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
      "languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
      "merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
      "milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
      "notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
      "pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
      "releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
      "ssh_url": "git@github.com:octocat/Hello-World.git",
      "stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
      "statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
      "subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
      "subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
      "tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
      "teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
      "trees_url": "https://HOSTNAME/repos/octocat/Hello-World/git/trees{/sha}",
      "hooks_url": "http://HOSTNAME/repos/octocat/Hello-World/hooks"
    }
  ]
}

Set selected repositories for an organization secret

Funciona con GitHub Apps

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.

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Set selected repositories for an organization secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`selected_repository_ids` array of integers Requerido 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 add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.

Códigos de estado de respuesta HTTP para "Set selected repositories for an organization secret"

status code	Descripción
`204`	No Content

Ejemplos de código para "Set selected repositories for an organization secret"

put/orgs/{org}/actions/secrets/{secret_name}/repositories

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories \
  -d '{"selected_repository_ids":[64780797]}'

Response

Status: 204

Add selected repository to an organization secret

Funciona con GitHub Apps

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.

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Add selected repository to an organization secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.
`repository_id` integer Requerido

Códigos de estado de respuesta HTTP para "Add selected repository to an organization secret"

status code	Descripción
`204`	No Content when repository was added to the selected list
`409`	Conflict when visibility type is not set to selected

Ejemplos de código para "Add selected repository to an organization secret"

put/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/REPOSITORY_ID

No Content when repository was added to the selected list

Status: 204

Remove selected repository from an organization secret

Funciona con GitHub Apps

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.

You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the secrets organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Remove selected repository from an organization secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.
`repository_id` integer Requerido

Códigos de estado de respuesta HTTP para "Remove selected repository from an organization secret"

status code	Descripción
`204`	Response when repository was removed from the selected list
`409`	Conflict when visibility type not set to selected

Ejemplos de código para "Remove selected repository from an organization secret"

delete/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/secrets/SECRET_NAME/repositories/REPOSITORY_ID

Response when repository was removed from the selected list

Status: 204

List repository secrets

Funciona con GitHub Apps

Lists all secrets available in a repository without revealing their encrypted values.

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. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "List repository secrets"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). Valor predeterminado: `30`
`page` integer Page number of the results to fetch. Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List repository secrets"

status code	Descripción
`200`	OK

Ejemplos de código para "List repository secrets"

get/repos/{owner}/{repo}/actions/secrets

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/secrets

Response

Status: 200

{
  "total_count": 2,
  "secrets": [
    {
      "name": "GH_TOKEN",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z"
    },
    {
      "name": "GIST_ID",
      "created_at": "2020-01-10T10:59:22Z",
      "updated_at": "2020-01-11T11:59:22Z"
    }
  ]
}

Get a repository public key

Funciona con GitHub Apps

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. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Get a repository public key"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.

Códigos de estado de respuesta HTTP para "Get a repository public key"

status code	Descripción
`200`	OK

Ejemplos de código para "Get a repository public key"

get/repos/{owner}/{repo}/actions/secrets/public-key

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/secrets/public-key

Response

Status: 200

{
  "key_id": "012345678912345678",
  "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
}

Get a repository secret

Funciona con GitHub Apps

Gets a single repository secret without revealing its encrypted value.

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. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Get a repository secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.

Códigos de estado de respuesta HTTP para "Get a repository secret"

status code	Descripción
`200`	OK

Ejemplos de código para "Get a repository secret"

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/secrets/SECRET_NAME

Response

Status: 200

{
  "name": "GH_TOKEN",
  "created_at": "2019-08-10T14:59:22Z",
  "updated_at": "2020-01-10T14:59:22Z"
}

Create or update a repository secret

Funciona con GitHub Apps

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."

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. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Create or update a repository secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`encrypted_value` string Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
`key_id` string ID of the key you used to encrypt the secret.

Códigos de estado de respuesta HTTP para "Create or update a repository secret"

status code	Descripción
`201`	Response when creating a secret
`204`	Response when updating a secret

Ejemplos de código para "Create or update a repository secret"

Select the example type

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

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/secrets/SECRET_NAME \
  -d '{"encrypted_value":"c2VjcmV0","key_id":"012345678912345678"}'

Response when creating a secret

Status: 201

Delete a repository secret

Funciona con GitHub Apps

Deletes a secret in a repository using the secret name.

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. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Delete a repository secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.
`secret_name` string Requerido The name of the secret.

Códigos de estado de respuesta HTTP para "Delete a repository secret"

status code	Descripción
`204`	No Content

Ejemplos de código para "Delete a repository secret"

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

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/secrets/SECRET_NAME

Response

Status: 204

List environment secrets

Funciona con GitHub Apps

Lists all secrets available in an environment without revealing their encrypted values.

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. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "List environment secrets"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`repository_id` integer Requerido The unique identifier of the repository.
`environment_name` string Requerido The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). Valor predeterminado: `30`
`page` integer Page number of the results to fetch. Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List environment secrets"

status code	Descripción
`200`	OK

Ejemplos de código para "List environment secrets"

get/repositories/{repository_id}/environments/{environment_name}/secrets

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/secrets

Response

Status: 200

{
  "total_count": 2,
  "secrets": [
    {
      "name": "GH_TOKEN",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z"
    },
    {
      "name": "GIST_ID",
      "created_at": "2020-01-10T10:59:22Z",
      "updated_at": "2020-01-11T11:59:22Z"
    }
  ]
}

Get an environment public key

Funciona con GitHub Apps

Get the public key for an environment, which you need to encrypt environment 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. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Get an environment public key"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`repository_id` integer Requerido The unique identifier of the repository.
`environment_name` string Requerido The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

Códigos de estado de respuesta HTTP para "Get an environment public key"

status code	Descripción
`200`	OK

Ejemplos de código para "Get an environment public key"

get/repositories/{repository_id}/environments/{environment_name}/secrets/public-key

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/secrets/public-key

Response

Status: 200

{
  "key_id": "012345678912345678",
  "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
}

Get an environment secret

Funciona con GitHub Apps

Gets a single environment secret without revealing its encrypted value.

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. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Get an environment secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`repository_id` integer Requerido The unique identifier of the repository.
`environment_name` string Requerido The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`secret_name` string Requerido The name of the secret.

Códigos de estado de respuesta HTTP para "Get an environment secret"

status code	Descripción
`200`	OK

Ejemplos de código para "Get an environment secret"

get/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME

Response

Status: 200

{
  "name": "GH_TOKEN",
  "created_at": "2019-08-10T14:59:22Z",
  "updated_at": "2020-01-10T14:59:22Z"
}

Create or update an environment secret

Funciona con GitHub Apps

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

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. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Create or update an environment secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`repository_id` integer Requerido The unique identifier of the repository.
`environment_name` string Requerido The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`secret_name` string Requerido The name of the secret.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`encrypted_value` string Requerido Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.
`key_id` string Requerido ID of the key you used to encrypt the secret.

Códigos de estado de respuesta HTTP para "Create or update an environment secret"

status code	Descripción
`201`	Response when creating a secret
`204`	Response when updating a secret

Ejemplos de código para "Create or update an environment secret"

Select the example type

put/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME \
  -d '{"encrypted_value":"c2VjcmV0","key_id":"012345678912345678"}'

Response when creating a secret

Status: 201

Delete an environment secret

Funciona con GitHub Apps

Deletes a secret in an environment using the secret name.

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. Authenticated users must have collaborator access to a repository to create, update, or read secrets.

Parámetros para "Delete an environment secret"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`repository_id` integer Requerido The unique identifier of the repository.
`environment_name` string Requerido The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`secret_name` string Requerido The name of the secret.

Códigos de estado de respuesta HTTP para "Delete an environment secret"

status code	Descripción
`204`	Default response

Ejemplos de código para "Delete an environment secret"

delete/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME

Default response

Status: 204