Remove Private Key

Removes the private key assignment from a credential. The credential will no longer use the private key for decryption or signature generation. The credential is automatically deployed to all environments after the private key is removed.

​

Endpoint

DELETE /apiops/projects/{projectName}/credentials/{username}/privateKey/

​

Authentication

Requires a Personal API Access Token.

​

Header

Authorization: Bearer YOUR_TOKEN

​

Request

​

Headers

Header	Value	Required
Authorization	Bearer	Yes

​

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
username	string	Yes	Username of the credential

​

Notes

• Credential must exist
• Credential must have a private key assigned, otherwise the operation returns an error

​

Response

​

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "message": "Deployment completed successfully",
    "environmentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployed successfully"
      },
      {
        "environmentName": "staging",
        "success": true,
        "message": "Deployed successfully"
      }
    ]
  }
}

​

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "Credential (username: api-user) was not found!"
}

​

Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

​

Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "Project(MyProject) was not found or user does not have privilege to access it!"
}

​

cURL Example

curl -X DELETE \
  "https://demo.apinizer.com/apiops/projects/MyProject/credentials/api-user/privateKey/" \
  -H "Authorization: Bearer YOUR_TOKEN"

​

Notes and Warnings

• Credential Requirements:

  • Credential must exist
  • Credential must have a private key assigned, otherwise the operation returns a 400 error

• Automatic Deployment:

  • Credential is automatically deployed to all environments after private key removal
  • Deployment results are returned in the response

• No Impact on Private Key:

  • The private key itself is not deleted
  • Only the assignment to the credential is removed

​

Permissions

• User must have IDENTITY + MANAGE permission in the project
• For automatic deployment, user must also have IDENTITY + DEPLOY_UNDEPLOY permission

​

Related Documentation

• Set Private Key - Assign private key to credential
• Set Public Key - Assign public key to credential
• List Credentials - List all credentials