Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
SSH Key Group

Update an SSH Key Group

Update a specific SSH Key Group.

SSH Key Group must be owned by current Tenant. All Sites being added or removed must be online to proceed.

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

patch/v2/org/{org}/nico/sshkeygroup/{sshKeyGroupId}

Request body

namestring nullable

Name of the SSHKeyGroup

descriptionstring nullable

Description of the SSHKeyGroup

siteIdsstring[]

When specified, replaces existing Site associations

sshKeyIdsstring[]

When specified, replaces existing SSH Key associations

versionstring required

Version of the SSH Key Group being modified must be provided

Example request

{
  "name": "reno-int-sre",
  "description": "SRE access SSH keys for Reno Integration Site",
  "siteIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "05d6e108-9f06-44c9-be47-7ab4d62b20d0"
  ],
  "sshKeyIds": [
    "ff06da79-707a-4069-8623-211d49ae96c8",
    "30fc7238-133d-42f7-8d29-866658b0c019"
  ],
  "version": "098f6bcd4621d373cade4e832627b4f6"
}

Response

OK

idstring uuid

Unique identifier for the SSH Key Group

namestring

Name of the SSH Key Group

descriptionstring nullable

Description for the SSH Key Group, optional

orgstring

Organization this SSH Key Group belongs to

tenantIdstring uuid

ID of the Tenane the SSH Key Group belongs to

versionstring nullable

Version of the SSH Key Group

status'Syncing' | 'Synced' | 'Error' | 'Deleting'

Status values for SSH Key Group objects

createdstring date-time

Date/time when the SSH key was created

updatedstring date-time

Date/time when the SSH key was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "reno-integration-sre",
  "description": "SRE access SSH keys for Reno Integration",
  "org": "wdksahew1rqf",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "version": "fbc692b61ffef6fbfc38a3833f6b7e7ae508da75",
  "siteAssociations": [
    {
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "sjc-central-1",
        "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
        "isSerialConsoleEnabled": true,
        "isOnline": true,
        "capabilities": {
          "nativeNetworking": false,
          "networkSecurityGroup": true,
          "nvLinkPartition": false,
          "flow": false,
          "imageBasedOperatingSystem": false
        },
        "status": "Registered"
      },
      "status": "Syncing",
      "version": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "sshKeys": [
    {
      "id": "ff06da79-707a-4069-8623-211d49ae96c8",
      "name": "sre-ssh-reno",
      "org": "wdksahew1rqf",
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "fingerprint": "CaK2yoj5fDOhf1swM2kFyjQrd3bwZfDYlWnVjBHgveQ",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "status": "Syncing",
  "statusHistory": [
    {
      "status": "Syncing",
      "message": "Group is being synced to Sites",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}