GIgithub
actions

Get an environment public key

Changed on

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, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

get/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key

Request

Path parameters

ownerstring required

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

repostring required

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

environment_namestring required

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

Response

Response

key_idstring required

The identifier for the key.

keystring required

The Base64 encoded public key.

idinteger
urlstring
titlestring
created_atstring

Example response

{
  "key_id": "1234567",
  "key": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=",
  "id": 2,
  "url": "https://api.github.com/user/keys/2",
  "title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
  "created_at": "2011-01-26T19:01:12Z"
}

Changes