curl -X POST 'https://api.github.com/user/gpg_keys' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "armored_public_key": "example-armored-public-key"
}'

# POST /user/gpg_keys (GitHub API)
Base URL: https://api.github.com
Auth: Authorization; GitHub token; required.
Request formats: application/json.
Last verified: 2026-10-20

> Create a GPG key for the authenticated user

## Critical Gotchas
* GitHub recommends an `Accept: application/vnd.github+json` header and an explicit `X-GitHub-Api-Version` header.
* Fine-grained tokens only authorize repositories and permissions selected when the token is created.

## cURL
curl -X POST 'https://api.github.com/user/gpg_keys' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "armored_public_key": "example-armored-public-key"
}'

## Parameters
| Name | In | Type | Required | Description |
| :--- | :--- | :--- | :--- | :--- |
| armored_public_key | body | string | Yes | A GPG key in ASCII-armored format. |
| name | body | string | No | A descriptive name for the new key. |

## Response example
{"id":3,"name":"Octocat's GPG Key"}

---
Need an API key? Get one at https://github.com/settings/tokens

POST

POST /user/gpg_keys — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Create a GPG key for the authenticated user

Base URL: https://api.github.com
Auth: Authorization: Bearer <GITHUB_API_KEY>
Last verified: 2026-10-20 · upstream hash matched

Actions Try in browser→

Agents: curl -H "Accept: text/markdown" this URL
→ 206 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X POST 'https://api.github.com/user/gpg_keys' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10' \  -H 'Content-Type: application/json' \  -d '{  "armored_public_key": "example-armored-public-key"}'

Parameters

Name	In	Type	Required	Description
name	body	string	No	A descriptive name for the new key.
armored_public_key	body	string	Yes	A GPG key in ASCII-armored format.

Response 200 OK

{
  "id": 3,
  "name": "Octocat's GPG Key",
  "primary_key_id": 0,
  "key_id": "3262EFF25BA0D270",
  "public_key": "xsBNBFayYZ...",
  "emails": [
    {
      "email": "[email protected]",
      "verified": true
    }
  ],
  "subkeys": [
    {
      "id": 4,
      "primary_key_id": 3,
      "key_id": "4A595D4C72EE49C7",
      "public_key": "zsBNBFayYZ...",
      "emails": [],
      "can_sign": false,
      "can_encrypt_comms": true,
      "can_encrypt_storage": true,
      "can_certify": false,
      "created_at": "2016-03-24T11:31:04-06:00",
      "expires_at": null,
      "revoked": false
    }
  ],
  "can_sign": true,
  "can_encrypt_comms": true,
  "can_encrypt_storage": true,
  "can_certify": true,
  "created_at": "2016-03-24T11:31:04-06:00",
  "expires_at": "2026-09-03T00:00:00Z",
  "revoked": true,
  "raw_key": "string"
}

Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.