Set-Integration

Prev Next

Summary

Updates an existing integration.

Set-Integration
    -Entry

Returns a integration object.

Parameters

Parameter

Type

Required?

Notes

Entry

Integration Object

Yes


Examples

Disable an existing integration

# Retrieve an integration
$integration = Get-Integration -Id 3

# Update the enabled property to false
$integration.Enabled = $false

# Save changes for the integration
$integration = Set-Integration -Entry $integration

# Convert the integration to output as JSON
$jsonOutput = $integration | ConvertTo-Json -Depth 10

# For debug purposes, convert the integration to output as JSON so we can see the available fields
Write-Output ""
Write-Output "JSON Results:"

# Output the JSON results
Write-Output $jsonOutput

JSON results:

{
  "IntegrationId": 3,
  "Name": "Relativity",
  "Identifier": "https://my-company.relativity.one",
  "Description": "Allows Agility Blue the ability to communicate and interract with Relativity",
  "Enabled": false,
  "Visible": true,
  "ConfigurationIsValid": false,
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2025-02-28T17:09:17.7986307+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "John Dough",
  "LastUpdatedById": "25a34a2f-e3d8-4690-88f5-6b399cf88c4c",
  "LastUpdatedOn": "2025-02-28T17:19:46.8471991+00:00",
  "LastUpdatedBy": null
}