Retrieve a deployment log

GET

/deployment-manager/deployments/:migrationId

GET

/deployment-manager/deployments/:migrationId

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.metadata_deployment.fetch_deployment_logs(
    migration_id="migrationId",
)

200Metadata Deployment_FetchDeploymentLogs_example

{
  "id": "8039d54b-da6f-4d80-88d5-06220c42861f",
  "name": "Deploy - Product catalog",
  "description": "Deploy - Product catalog",
  "status": "PARTIALLY-DONE",
  "targetTenant": {
    "id": "9958",
    "name": "Test API sandbox",
    "environment": "US-API-Sandbox-Staging"
  },
  "deploymentDate": "2023-08-28 11:34:18.682000+00:00",
  "runBy": "Admin",
  "succeeded": [
    {
      "component": "Settings",
      "subComponent": "Billing",
      "key": "Currency"
    }
  ],
  "failed": [
    {
      "component": "Settings",
      "subComponent": "Finance",
      "key": "AllRevenueRecognitionModels",
      "errorInfo": "Error while updating the payload with path : /revenue-recognition-models --> You do not have permission to perform this operation."
    },
    {
      "component": "Settings",
      "subComponent": "Finance",
      "key": "AccountingRules",
      "errorInfo": "Error while updating the payload with path : /accounting-rules --> You do not have Currency Conversion permission. You can request permission from your administrator."
    },
    {
      "component": "Settings",
      "subComponent": "Billing",
      "key": "SubscriptionSettings",
      "errorInfo": "{\n  \"errorCode\" : \"REMOTE_HTTP_CLIENT_ERROR\",\n  \"remoteHttpStatus\" : 403,\n  \"messages\" : [ \"{\\\"error\\\":\\\"403 Forbidden\\\",\\\"processId\\\":\\\"A5EF7EA92B3B95B0\\\",\\\"message\\\":\\\"security.error.noPermission\\\"}\" ]\n}"
    }
  ],
  "skipped": [
    {
      "component": "Settings",
      "subComponent": "Billing",
      "key": "NumberAndSku",
      "reason": "RETRY-ABLE ERROR"
    },
    {
      "component": "Settings",
      "subComponent": "Administration",
      "key": "AuditTrailSettings",
      "reason": "RETRY-ABLE ERROR"
    }
  ]
}

Retrieve a deployment log.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

migrationIdstringRequired

The unique ID of a migration.

Response

idstringOptional

ID of the migration process.

namestringOptional

Name of the migration.

descriptionstringOptional

Description of the migration.

statusstringOptional

Migration status.

targetTenantobjectOptional

deploymentDatestringOptional

Deployment timestamp.

runBystringOptional

Name of the user who executed the migration.

succeededlist of objectsOptional

failedlist of objectsOptional

skippedlist of objectsOptional

Authentication

Path parameters

Headers

Response