Sign in

v57

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

Retrieve all SSH Key Groups

Retrieve all SSH Key Groups for the current Tenant.

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

get/v2/org/{org}/nico/sshkeygroup

Query parameters

siteIdstring

Filter SSH Key Groups by Site ID

instanceIdstring

Filter SSH Key Groups by Instance ID

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

Status filter for the SSH Key Groups

querystring

Search for matches across all SSH Key Groups. Input will be matched against the name field

includeRelation'Tenant'

Related entity to expand

pageNumberinteger
Example:1

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

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"
  }
]