Skip to main content
Code42 Support

Changes To The Code42 API For Private 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. This article is applies to all private cloud environments upgrading from 4.1.6 to 4.2.

Changing resources

  • UIDs or GUIDs are now preferred as inputs or query parameters, rather than IDs. 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
  • 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

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 its archiveGuid instead of a guid+targetComputerId pair.
      • targetComputerId
        • Now removed: To identify an archive, use its 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: Use archiveGuid.
      • sourceGuid
        • Now removed: Use archiveGuid.
      • targetGuid
        • Now removed: Use archiveGuid.
  • BalancingActivity resource
    • Output value: guid
      • Now removed: Use archiveGuid.
  • BalancingCommand resource
    • Query parameters:
      • guid
        • Now removed: Use archiveGuid.
      • guids
        • Now removed: 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: Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceUserId
        • Now removed: Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans
      • sourceUserFirstName
        • Now removed: Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceUserLastName
        • Now removed: Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceUserEmail
        • Now removed: Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceComputerId
        • Now removed: Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceComputerName
        • Now removed: Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
      • sourceComputerService
        • Now removed: Use coldStorageRows[].archiveGuid to look up computers associated with archives or plans.
    • Plan
      • Output value
        • storageGuid
          • Now removed: For storage information, see the Archive resource.
    • QSFile resource
      • GET method
        • Query parameter: pin is discontinued.
          • If the shared link is PIN-protected, the PIN must be provided in a "C42-QSAuth-Pin" header.

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
  • ArchiveMetadata resource
    • GET method
      • Output values
        • data[i].timestamp is deprecated: Use versionTime which observes the standard ISO date/time format.
        • data[i].sourceLastModified is deprecated: Use sourceLastModifiedTime which observes the standard ISO date/time format.
  • Computer resource
    • Query parameters
      • guid is deprecated. Use the path parameter format Computer/<guid>?idType=guid instead.
      • 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?