Skip to content

Update one instance

PATCH
/v1/integrations/{provider}/connections/{connection_id}/instances/{instance_id}
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.

provider
required
string

Provider slug

connection_id
required
string format: uuid

Connection identifier

instance_id
required
string format: uuid

Configuration identifier

Media typeapplication/json

Changes to an existing instance. Omitted fields keep their value.

object
config

Complete replacement configuration value.

object
connection_id

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.

string | null format: uuid
display_name

Replacement instance name.

string | null
enabled

Whether this configuration can execute.

boolean | null

Updated instance

Media typeapplication/json

One instance under a connection.

object
capability
required

Capability identifier.

string
Allowed values: RISK_REGISTER INCIDENT_REGISTER RISK_TICKET INCIDENT_TICKET NOTIFICATION AGENT_CONTEXT
config
required

Complete validated configuration value.

object
connection_id
required

Connection whose credential this configuration runs with.

string format: uuid
created_date
required

Creation time.

string format: date-time
display_name
required

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.

string
enabled
required

Whether the platform can execute this configuration.

boolean
id
required

Configuration identifier.

string format: uuid
integration_user
required

Service account this configuration acts as, named as the configuration. Both halves of a ticket card share one.

string format: uuid
updated_date
required

Last update time.

string format: date-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