---
title: "Update a system"
method: PUT
path: "/api/systems/{id}"
tags: ["Systems"]
---

# Update a system

`PUT /api/systems/{id}`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/systems/{id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/systems/:id/put.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows you to update a system.

#### Sample Request 
```
curl -X PUT https://console.jumpcloud.com/api/systems/{SystemID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
	"displayName":"Name_Update",
	"allowSshPasswordAuthentication":"true",
	"allowSshRootLogin":"true",
	"allowMultiFactorAuthentication":"true",
	"allowPublicKeyAuthentication":"false",
	"attributes":[
		{"name":"{ATTRIBUTE_NAME}","value":"{ATTRIBUTE_VALUE}"}
	]
}'
```

## Headers

- `Date` string
- `Authorization` string
- `x-org-id` string

## Request body

- Systemput
  - `agentBoundMessages` object[]
    - `cmd` string
  - `allowMultiFactorAuthentication` boolean
  - `allowPublicKeyAuthentication` boolean
  - `allowSshPasswordAuthentication` boolean
  - `allowSshRootLogin` boolean
  - `displayName` string
  - `attributes` Attribute[]
    - `name` string
    - `value` string
  - `tags` string[]

## Response `200`

- System
  - `_id` string
  - `active` boolean
  - `agentHasFullDiskAccess` boolean
  - `agentVersion` string
  - `allowMultiFactorAuthentication` boolean
  - `allowPublicKeyAuthentication` boolean
  - `allowSshPasswordAuthentication` boolean
  - `allowSshRootLogin` boolean
  - `amazonInstanceID` string
  - `arch` string
  - `archFamily` string
  - `attributes` Attribute[]
    - `name` string
    - `value` string
  - `connectionHistory` object[]
  - `created` string, date-time
  - `description` string
  - `desktopCapable` boolean
  - `displayName` string
  - `fde` Fde: Indicates if the Full Disk Encryption is active in the system
    - `active` boolean
    - `keyPresent` boolean
  - `fileSystem` string, nullable
  - `hasServiceAccount` boolean
  - `hostname` string
  - `hwVendor` string
  - `isPolicyBound` boolean
  - `lastContact` string, date-time, nullable
  - `modifySSHDConfig` boolean
  - `networkInterfaces` object[]
    - `address` string
    - `family` 'IPv4' | 'IPv6'
    - `internal` boolean
    - `name` string
  - `networkInfo` object
    - `imei` string: PII data; do not log.
    - `macAddress` string: PII data; do not log.
    - `simInfo` object[]
      - `phoneNumber` string: PII data; do not log.
      - `iccid` string: PII data; do not log.
  - `organization` string
  - `os` string
  - `osVersionDetail` object
    - `osName` string
    - `releaseName` string
    - `major` string
    - `minor` string
    - `patch` string
    - `majorNumber` integer
    - `minorNumber` integer
    - `patchNumber` integer
    - `revision` string
    - `distributionName` string
    - `version` string
  - `policyStats` object
    - `duplicate` integer
    - `failed` integer
    - `pending` integer
    - `success` integer
    - `total` integer
    - `unsupportedOs` integer
  - `provisionMetadata` object
    - `provisioner` object
      - `type` 'administrator' | 'mdm' | 'user'
      - `provisionerId` string
  - `primarySystemUser` object
    - `id` string, nullable
  - `remoteIP` string
  - `serialNumber` string
  - `sshRootEnabled` boolean
  - `sshdParams` object[]
    - `name` string
    - `value` string
  - `systemInsights` object
    - `state` 'enabled' | 'disabled' | 'deferred'
  - `systemTimezone` integer
  - `tags` string[]
  - `templateName` string
  - `version` string
  - `mdm` object
    - `vendor` 'unknown' | 'none' | 'internal' | 'external'
    - `internal` object
      - `deviceId` string
      - `windowsDeviceId` string
    - `profileIdentifier` string
    - `dep` boolean
    - `userApproved` boolean
    - `enrollmentType` 'unknown' | 'automated device' | 'device' | 'user'
    - `providerId` string
    - `windows` object
      - `upn` string
    - `lostModeStatus` string
    - `deviceLockStatus` 0 | 1 | 2 | 3 | 4
    - `enrollmentStatus` 0 | 1
  - `builtInCommands` object[]
    - `type` 'security'
    - `name` 'erase' | 'lock' | 'restart' | 'shutdown'
  - `osFamily` string
  - `domainInfo` object
    - `partOfDomain` boolean
    - `domainName` string
  - `userMetrics` object[]
    - `userName` string
    - `admin` boolean
    - `managed` boolean
    - `suspended` boolean
    - `secureTokenEnabled` boolean
  - `serviceAccountState` object
    - `hasSecureToken` boolean
    - `passwordODValid` boolean
    - `passwordAPFSValid` boolean
  - `azureAdJoined` boolean
  - `displayManager` string
  - `secureLogin` object
    - `supported` boolean
    - `enabled` boolean
  - `remoteAssistAgentVersion` string

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)