Keypair

Update key pair name

Updates the name of a specified key pair. Include the key pair ID in the request path and the new name of the key pair in the request body.

put/core/keypair/{id}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/keypair/{id}
  • Auth: API key in header api_key

Path parameters

idinteger required

ID of the key pair.

Request body

namestring required

The new key pair name.

Response

Keypair name updated successfully.

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "status": true,
  "message": "Keypair name updated successfully to example-keypair",
  "keypair": {
    "id": 4501,
    "name": "example-keypair",
    "environment": {
      "id": 6190,
      "name": "example-environment",
      "features": {
        "green_status": "GREEN"
      }
    },
    "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOu6TJudyoheKvyDdnr8HYCBNjJVT79bq9EGuDHdR3e3 user@example.com",
    "fingerprint": "ff:00:4b:02:8e:43:b6:75:03:7c:52:52:df:82:9d:58",
    "created_at": "2026-05-07T11:47:30Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.