Skip to main content
Code42 Support

Changes To The Code42 API For Public Cloud Version 4.2

Applies to:
  • CrashPlan PROe

Overview

Beginning with version 4.2 of the Code42 platform, some Code42 API resources have changed. This article lists these changes to help you revise or remove instances of the changed API resources.

New resources

The following resources are newly available to users of the Code42 API:

  • PlanUserSetting
  • DeviceSetting
  • PlanDeviceSetting

See the API Documentation Viewer for usage.

Changing resources

  • UIDs or GUIDs are now preferred to IDs as inputs or query parameters. However, resources maintain backward compatibility when possible. The following Code42 API resources now support UIDs or GUIDs in addition to IDs (note that UIDs are conceptually the same as GUIDs):
    • User
    • Org
    • Plan
    • Computer
    • Archive
    • Destination
  • For the Destination resource, the GET, POST and PUT methods include a new JSON data structure that specifies which apps are enabled for the destination. See the API Documentation Viewer for specific details.
  • The following resources provide a new output value named archiveSessionCount, which supersedes the deprecated output value backupSessionCount:
    • Destination
    • Server
    • StorePoint

Data model changes

Previously, archives were identified by a combination of the source computer's GUID and the destination's GUID. Now, archives are identified by a new, single value: archiveGuid. This data model change affects a number of resources related to archives and archive maintenance, as described below.

Removed inputs, query parameters, and output values

The following inputs, query parameters, and output values were previously deprecated. Beginning with version 4.2, these were completely removed:

  • Archive resource
    • Query parameters
      • guid
        • Now removed: To identify an archive, use an archiveGuid instead of a guid+targetComputerId pair.
      • targetComputerId
        • Now removed: To identify an archive, use an archiveGuid instead of a guid+targetComputerId pair.
    • Output values
      • service
      • destinationId
      • computerId
      • guid
  • ArchiveCommand resource
    • Query parameters
      • sourceGuid
        • Now removed: Use archiveGuid to specify an archive.
      • targetGuid
        • Now removed: Use archiveGuid to specify an archive.
  • ArchiveMaintenance resource
    • Output values
      • sourceComputerId
        • Now removed: sourceComputerId is deprecated. Use archiveGuid.
      • sourceGuid
        • Now removed: sourceGuid is deprecated. Use archiveGuid.
      • targetGuid
        • Now removed: sourceComputerId is deprecated. Use archiveGuid.
  • BalancingActivity resource
    • Output value: guid
      • Now removed: guid is deprecated. Use archiveGuid.
  • BalancingCommand resource
    • Query parameters:
      • guid
        • Now removed: guid is deprecated. Use archiveGuid.
      • guids
        • Now removed: guids is deprecated. Use archiveGuids.
    • Output value: guid
  • ClientDownloadUrl resource
    • Output value: solaris (URL)
  • ColdStorage resource
    • Options for srtKey query parameter:
      • sourceUserName
      • sourceComputerName
    • Output values:
      • fcuId
        • Now removed: coldStorageRows[].fcuId is deprecated. Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceUserId
        • Now removed: coldStorageRows[].sourceUserId is deprecated. Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans
      • sourceUserFirstName
        • Now removed: coldStorageRows[].sourceUserFirstName is deprecated. Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceUserLastName
        • Now removed: coldStorageRows[].sourceUserLastName is deprecated. Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceUserEmail
        • Now removed: coldStorageRows[].sourceUserEmail is deprecated. Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceComputerId
        • Now removed: coldStorageRows[].sourceComputerId is deprecated. Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceComputerName
        • Now removed: coldStorageRows[].sourceComputerName is deprecated. Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceComputerService
        • Now removed: coldStorageRows[].fcuId is deprecated. Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
    • Computer resource
      • Error status code change
        • Scenario: non-existent computer is requested
          • 4.1.6: 500 Internal Server Error
          • 4.2.0: 404 Not Found
    • Plan
      • Output value
        • storageGuid
          • Now removed: storageGuid is deprecated. For storage information, see the Archive resource.

New deprecations

The following inputs, query parameters, and output values are newly deprecated in version 4.2 of the Code42 platform. See the 4.2 API Documentation Viewer for deprecation notices.

  • Archive resource
    • Query parameters
      • serverId
      • destinationId
      • userId
    • Output values
      • userId
  • Computer resource
    • Query parameters
      • orgId
      • userId
    • Output values
      • computerId
      • userId
      • orgId
      • parentComputerId
  • Destination resource
    • Output values
      • destinationId
      • computerCount
      • backupSessionCount
  • Org resource
    • Query parameters
      • parentOrgId
    • Output values
      • orgId
      • parentOrgId
      • externalId
      • reporting.orgManagers[].id
      • settings.destinations[].destinationId
      • settings.allDestinations[].destinationId
      • settingsInherited.allDestinations[].destinationId
      • settingsSummary.destinations[].destinationId
      • orgInheritDto.orgId
      • orgInheritDto.orgIdProvidingOrg
      • orgInheritDto.orgIdProvidingDestinations
      • orgInheritDto.orgIdProvidingDeviceDefaults
  • Plan resource
    • Query parameters
      • orgId
    • Output values
      • orgId
  • PlanDevice resource
    • Output values
      • computerId
  • Server resource
    • Output values
      • backupSessionCount
  • StorePoint resource
    • Output values
      • backupSessionCount
  • User resource
    • Query parameters
      • userId
      • orgId
    • Output values
      • userId
      • orgId
  • Was this article helpful?