---
title: "Create SSH Key Group"
method: POST
path: "/v2/org/{org}/nico/sshkeygroup"
tags: ["SSH Key Group"]
---

# Create SSH Key Group

`POST /v2/org/{org}/nico/sshkeygroup`

Create an SSH Key Group for the current Tenant.

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

## Request body

- SshKeyGroupCreateRequest — Request data to create an SSH Key Group
  - `name` string, required — Name of the SSHKeyGroup
  - `description` string, nullable — Description of the SSHKeyGroup
  - `siteIds` string[] — List of Site objects
  - `sshKeyIds` string[] — List of SSHKeyID objects

## Response `201`

Created

- SshKeyGroup — Describes the model that groups SSH Keys
  - `id` string, uuid — Unique identifier for the SSH Key Group
  - `name` string — Name of the SSH Key Group
  - `description` string, nullable — Description for the SSH Key Group, optional
  - `org` string — Organization this SSH Key Group belongs to
  - `tenantId` string, uuid — ID of the Tenane the SSH Key Group belongs to
  - `version` string, nullable — Version of the SSH Key Group
  - `sshKeys` SshKey[] — SSH Keys associated with this SSH Key Group
    - `id` string, uuid — Unique identifier for the key
    - `name` string — Name of the SSHKey
    - `org` string — Organization the SSHKey belongs to
    - `tenantId` string, uuid — ID of the Tenant
    - `fingerprint` string — SHA256 fingerprint of the public key
    - `created` string, date-time — Date/time when the SSH key was created
    - `updated` string, date-time — Date/time when the SSH key was last updated
  - `siteAssociations` SshKeyGroupSiteAssociation[] — Sites the SSH Key Group is synced to
    - `site` SiteSummary — SiteSummary contains a subset of data for Site object, used when nesting in other objects
      - `id` string, uuid — Unique UUID v4 identifier for the Site
      - `name` string — Name of the Site
      - `infrastructureProviderId` string, uuid — ID of the Infrastructure Provider that owns the Site
      - `isSerialConsoleEnabled` boolean — Indicates if Serial Console is enabled for the Site by the Provider
      - `isOnline` boolean — Indicates if the Site is currently reachable from Cloud
      - `capabilities` SiteCapabilities — Boolean flags to indicate features supported by a Site
        - `nativeNetworking` boolean — Whether the Site supports native networking
        - `networkSecurityGroup` boolean — Whether the Site supports Network Security Groups
        - `nvLinkPartition` boolean — Whether the Site supports NVLink partitioning
        - `flow` boolean — Whether the Site supports Flow-based operations
        - `imageBasedOperatingSystem` boolean — Whether the Site supports image-based operating system provisioning
      - `status` 'Pending' | 'Registered' | 'Error' — Status values for Site objects
    - `status` 'Syncing' | 'Synced' | 'Pending' | 'Error' | 'Deleting' — Status values for SSH Key Group Site Association objects
    - `version` string, nullable — Version of the Key Group on Site
    - `created` string, date-time — Date/time when the Site was created
    - `updated` string, date-time — Date/time when the Site was last updated
  - `status` 'Syncing' | 'Synced' | 'Error' | 'Deleting' — Status values for SSH Key Group objects
  - `statusHistory` StatusDetail[] — History of the SSH Key Group states
    - `status` string — State of the associated entity at a particular time
    - `message` string, nullable — Description of the state and cause/remedy in case of error
    - `created` string, date-time — Date/time when the associated entity assumed the status
    - `updated` string, date-time — Date/time when the associated entity was last observed with this status
  - `created` string, date-time — Date/time when the SSH key was created
  - `updated` string, date-time — Date/time when the SSH key was last updated

## Other responses

- `400` — Error response when request data cannot be validated
- `403` — Error response when user is not authorized to call an endpoint or retrieve/modify objects

---

[API](https://skmtc.net/nvidia/apis/nvidia-infra-controller-rest-api.md) · [All operations](https://skmtc.net/nvidia/apis/nvidia-infra-controller-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nvidia/nvidia-infra-controller-rest-api/revisions/4c29fe59bd4e/schema)
