Sign in
Environments

Compare resources between environments

Compares workflows and other resources between the source and target environments, returning detailed diff information including additions, modifications, and deletions.

post/v2/environments/{targetEnvironmentId}/diff

Path parameters

targetEnvironmentIdstring required

Target environment ID (MongoDB ObjectId) to compare against

Request body

sourceEnvironmentIdstring

Source environment ID to compare from. Defaults to the Development environment if not provided.

Example request

{
  "sourceEnvironmentId": "507f1f77bcf86cd799439011"
}

Response

OK

sourceEnvironmentIdstring required

Source environment ID

targetEnvironmentIdstring required

Target environment ID

Example response

{
  "resources": [
    {
      "sourceResource": {
        "updatedAt": "2024-01-15T10:30:00.000Z"
      },
      "targetResource": {
        "updatedAt": "2024-01-15T10:30:00.000Z"
      },
      "changes": [
        {
          "sourceResource": {
            "updatedAt": "2024-01-15T10:30:00.000Z"
          },
          "targetResource": {
            "updatedAt": "2024-01-15T10:30:00.000Z"
          }
        }
      ]
    }
  ]
}

Changes

Changed in 1 of the 13 revisions of this API.2

  • 798a5a42d4c62See the full diff
    • ●

      added the new AGENT_EXISTS_IN_TARGET enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new AGENT_REQUIRED_FOR_WORKFLOW enum value to the //// response property for the response status

      response-property-enum-value-added