Reference: Deprecated fields

Fields might be deprecated in favor of other fields for improved performance, functionality support, or other reasons. After 12 months from the initial announcement, deprecated fields receive support and maintenance for a minimum of six months. Starting with the next release after that six month period, deprecated fields might be removed from the API Gateway schema.

After a field deprecation announcement, update your requests to replace deprecated fields with the recommended replacement fields.

August 2022 deprecated fields

Support for these fields ends February 2024.

Deprecated field Replacement field Notes

query.directEndpoint. performance.memoryUsagePercent

query.directEndpoint. performance.memoryUsedPercent The query.directEndpoint.performance.memoryUsagePercent field maps one-to-one to query.directEndpoint.performance.memoryUsedPercent.
query.lastActionDetails (id) query.scheduledAction (ref: {id}).lastAction

Child fields for query.lastActionDetails map one-to-one to child fields for query.scheduledAction.lastAction.

For more information, see a query.scheduledAction example request.

query.lastActionResults (id) query.scheduledAction (ref: {id}).lastAction.results

Child fields for query.lastActionResults map one-to-one to child fields for query.scheduledAction.lastAction.results.

For more information, see a query.scheduledAction example request.

mutation.createAction (action: {<arguments>})

mutation.actionPerform (input: {<arguments>}), mutation.scheduledActionCreate (input: {<arguments>}),

Certain arguments for mutation.createAction map one-to-one to mutation.actionPerform arguments:

  • changeClientSetting
  • collectActiveDirectoryInfo

  • reboot
  • restartService
  • startService
  • stopService

For more information, see a mutation.actionPerform example request.

The mutation.createAction (name) argument maps one-to-one to the mutation.scheduledActionCreate (name).

Certain mutation.createAction arguments map to the following mutation.scheduledActionCreate arguments:

  • description deprecated, use comment instead

  • schedule.distributeOverSeconds deprecated, use distributeSeconds instead

  • schedule.end deprecated, use endTime instead

  • schedule.reissueSeconds deprecated, use issueSeconds instead

  • schedule.start deprecated, use startTime instead

  • target deprecated, use targets instead

For more information, see a mutation.scheduledActionCreate example request.

The mutation.createAction (replaceExisting) argument does not map directly to a replacement argument. Instead, retrieve scheduled actions, filtering on the name you want to replace (query.scheduledActions), then delete the scheduled actions by ID (mutation.scheduledActionDelete).

For more information, see a query.scheduledActions example request and a mutation.scheduledActionDelete example request.

mutation.deleteAction (name) mutation.scheduledActionDelete (ref: {id})

Pass the action ID instead of the action name to delete an action.

For more information, see a mutation.scheduledActionDelete example request.

December 2021 deprecated fields

Support for these fields ends June 2023.

Deprecated field Replacement field
query.assets query.endpoints

November 2021 deprecated fields

These fields were deprecated before API Gateway released to the public. Support for these fields ends May 2023.

Deprecated field Replacement field
mutation.installSoftware mutation.manageSoftware
mutation.removeSoftware mutation.manageSoftware
mutation.upsertEntity mutation.importConfigurationItemEntities
query.directConnection query.directEndpoint
query.endpoints.edges.node.diskSpace query.endpoints.edges.node.disks
query.endpoints.edges.node.memory.used

query.directEndpoint.performance.memoryUsedPercent (originally directEndpoint.performance.memoryUsagePercent, deprecated August 2022)

directEndpoint.performance.memoryUsagePercent

query.endpoints.edges.node.memory.usedPercentage

query.directEndpoint.performance.memoryUsedPercent (originally directEndpoint.performance.memoryUsagePercent, deprecated August 2022)

directEndpoint.performance.memoryUsagePercent

query.entities query.configItemEntities
query.relationships query.configItemRelationships
query.software query.softwarePackage
query.directEndpoint.performance.memoryUsagePercent query.directEndpoint.performance.memoryUsedPercent