Update one instance
const url = 'https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"config":{},"connection_id":null,"display_name":null,"enabled":null}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Content-Type: application/json' \ --data '{ "config": {}, "connection_id": null, "display_name": null, "enabled": null }'Omitted fields keep their stored value.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Provider slug
Connection identifier
Configuration identifier
Request Bodyrequired
Section titled “Request Bodyrequired”Changes to an existing instance. Omitted fields keep their value.
object
Complete replacement configuration value.
object
Replacement connection. Must name a sibling connection of the same provider in the same organization; the configuration runs with that connection’s credential afterwards. A configuration that has linked tickets does not move.
Replacement instance name.
Whether this configuration can execute.
Responses
Section titled “Responses”Updated instance
One instance under a connection.
object
Capability identifier.
Complete validated configuration value.
object
Connection whose credential this configuration runs with.
Creation time.
Instance name, unique across the organization ignoring case; the two halves of a ticket card share one. The instance’s integration user carries it, so it is what Opened by shows for imported records.
Whether the platform can execute this configuration.
Configuration identifier.
Service account this configuration acts as, named as the configuration. Both halves of a ticket card share one.
Last update time.
Example
{ "capability": "RISK_REGISTER"}Invalid instance
Unknown provider, connection, or configuration
Configuration name is already in use, or a move of a configuration that has linked tickets