---
updatedAt: 2026-05-31T12:17:20.000Z
agentTools:
  siteIndex: https://docs.jfrog.com/llms.txt
  projectIndex: https://docs.jfrog.com/administration/llms.txt
---

# Verify Key Pair

Verifies the validity of the key pair.

Since: 7.19

Notes: Requires Artifactory Pro

Security: Requires a valid admin user

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "JFrog Artifactory Security API",
    "description": "REST API for managing security settings in JFrog Artifactory, including users, permissions, API keys, GPG keys, certificates, and encryption. \n\nNote - From Artifactory release 7.49.3, the security APIs are being decoupled from Artifactory and moving to JFrog Platform Access. This means that the security APIs below are planned to be deprecated at a later stage. We recommend using the available new APIs for all your security and access needs moving forward.\n",
    "version": "1.0.0",
    "contact": {
      "name": "JFrog Support"
    }
  },
  "servers": [
    {
      "url": "https://{jfrog_url}/artifactory/api",
      "description": "JFrog Platform",
      "variables": {
        "jfrog_url": {
          "default": "myserver.jfrog.io",
          "description": "Your JFrog Platform hostname (e.g., mycompany.jfrog.io)"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "GPG Key Pairs",
      "description": "GPG key pair management for signing operations"
    }
  ],
  "paths": {
    "/security/keypair/verify": {
      "post": {
        "tags": [
          "GPG Key Pairs"
        ],
        "summary": "Verify Key Pair",
        "description": "Verifies the validity of the key pair.\n\nSince: 7.19\n\nNotes: Requires Artifactory Pro\n\nSecurity: Requires a valid admin user",
        "operationId": "verifyKeyPair",
        "requestBody": {
          "description": "Key pair to verify, including pair name, type, alias, and public/private keys.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/KeyPairInput"
              },
              "examples": {
                "verifyRsaKeyPair": {
                  "summary": "Verify an RSA key pair",
                  "value": {
                    "pairName": "alpine-local-key",
                    "pairType": "RSA",
                    "alias": "artifactory-alpine-local",
                    "privateKey": "-----BEGIN PRIVATE KEY-----\nMIGEAgEAMBAGByqGSM49AgEGBSuBBAAKBG0wawIBAQQgVcB/UNPxalR9zDYAjQIf\n...\n-----END PRIVATE KEY-----",
                    "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END PUBLIC KEY-----"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Returns verification result, e.g. 'Key was verified.'",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "verified": {
                    "summary": "Key pair verified",
                    "value": "Key was verified."
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Key pair verification failed.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "description": "Permission Denied - This operation requires a valid admin user.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  },
  "security": [
    {
      "BasicAuth": []
    },
    {
      "ApiKeyAuth": []
    },
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-JFrog-Art-Api"
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "responses": {
      "UnauthorizedError": {
        "description": "Bad Credentials - The provided authentication is invalid.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "integer",
                  "description": "HTTP status code"
                },
                "message": {
                  "type": "string",
                  "description": "Error message"
                }
              }
            }
          }
        }
      },
      "KeyPairInput": {
        "type": "object",
        "required": [
          "pairName",
          "pairType",
          "alias",
          "privateKey",
          "publicKey"
        ],
        "properties": {
          "pairName": {
            "type": "string",
            "description": "The name of the key pair (mandatory)"
          },
          "pairType": {
            "type": "string",
            "enum": [
              "RSA",
              "GPG"
            ],
            "description": "The type of key pair (mandatory)"
          },
          "alias": {
            "type": "string",
            "description": "The alias for the key pair (mandatory)"
          },
          "privateKey": {
            "type": "string",
            "description": "The private key in PEM format (mandatory)"
          },
          "publicKey": {
            "type": "string",
            "description": "The public key in PEM format (mandatory)"
          },
          "passphrase": {
            "type": "string",
            "description": "The passphrase for the private key"
          },
          "vaultKey": {
            "type": "string",
            "description": "Vault key identifier"
          },
          "vaultPublicKey": {
            "type": "object",
            "description": "Vault public key configuration",
            "properties": {
              "path": {
                "type": "string"
              },
              "key": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```