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

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v2/environments/{targetEnvironmentId}/diff
  • Auth: API key in header Authorization

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

Example response

{
  "data": {
    "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

No recorded changes to this operation across all 1 revision of this API.