Update an SSH Key Group

PATCH

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/sshkeygroup/:sshKeyGroupId

PATCH

/v2/org/:org/nico/sshkeygroup/:sshKeyGroupId

curl -X PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/sshkeygroup/sshKeyGroupId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "version": "fbc692b61ffef6fbfc38a3833f6b7e7ae508da75",
  "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"
  ]
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "reno-int-sre",
  "description": "SRE access SSH keys for Reno Integration Site",
  "org": "wdksahew1rqf",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "version": "fbc692b61ffef6fbfc38a3833f6b7e7ae508da75",
  "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"
    },
    {
      "id": "30fc7238-133d-42f7-8d29-866658b0c019",
      "name": "sre-ssh-reno-ext",
      "org": "wdksahew1rqf",
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "fingerprint": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "siteAssociations": [
    {
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "sjc-central-1",
        "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
        "isSerialConsoleEnabled": true,
        "isOnline": true,
        "capabilities": {
          "nativeNetworking": true,
          "networkSecurityGroup": true,
          "vpcSlaac": false
        },
        "status": "Registered"
      },
      "status": "Syncing",
      "version": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    },
    {
      "site": {
        "id": "05d6e108-9f06-44c9-be47-7ab4d62b20d0",
        "name": "Reno Integration",
        "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
        "isSerialConsoleEnabled": true,
        "isOnline": true,
        "capabilities": {
          "nativeNetworking": true,
          "networkSecurityGroup": true,
          "vpcSlaac": false
        },
        "status": "Registered"
      },
      "status": "Syncing",
      "version": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
      "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"
}

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.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

sshKeyGroupIdstringRequired

ID of the SSH Key Group

Request

This endpoint expects an object.

versionstringRequired

Version of the SSH Key Group being modified must be provided

namestring or nullOptional

Name of the SSHKeyGroup

descriptionstring or nullOptional

Description of the SSHKeyGroup

siteIdslist of stringsOptional

When specified, replaces existing Site associations

sshKeyIdslist of stringsOptional

When specified, replaces existing SSH Key associations

Response

idstringOptionalRead-onlyformat: "uuid"

Unique identifier for the SSH Key Group

namestringOptional

Name of the SSH Key Group

descriptionstring or nullOptional

Description for the SSH Key Group, optional

orgstringOptional

Organization this SSH Key Group belongs to

tenantIdstringOptionalformat: "uuid"

ID of the Tenane the SSH Key Group belongs to

versionstring or nullOptional

Version of the SSH Key Group

sshKeyslist of objectsOptional

SSH Keys associated with this SSH Key Group

siteAssociationslist of objectsOptional

Sites the SSH Key Group is synced to

statusenumOptional

Status of the SSH Key Group

statusHistorylist of objectsOptional

History of the SSH Key Group states

createddatetimeOptionalRead-only

Date/time when the SSH key was created

updateddatetimeOptionalRead-only

Date/time when the SSH key was last updated

Errors

400

Bad Request Error

403

Forbidden Error