Skip to content

Create an instance

POST
/v1/integrations/{provider}/connections/{connection_id}/instances
curl --request POST \
--url https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances \
--header 'Content-Type: application/json' \
--data '{ "capability": "RISK_REGISTER", "config": {}, "display_name": "example", "enabled": true }'

Adds a named configuration of one capability under the connection. Two configurations of one capability under one connection cannot have the same name.

provider
required
string

Provider slug

connection_id
required
string format: uuid

Connection identifier

Media typeapplication/json

A new instance under a connection.

object
capability
required

Capability selected from the provider catalog.

string
Allowed values: RISK_REGISTER INCIDENT_REGISTER RISK_TICKET INCIDENT_TICKET NOTIFICATION AGENT_CONTEXT
config

Complete configuration value. Omitted means an empty configuration.

object
display_name
required

Instance name shown wherever this configuration appears. Unique among the capability’s configurations under one connection.

string
enabled
required

Whether this configuration can execute.

boolean

Instance created

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"
}

Unsupported capability or invalid configuration

Unknown provider or connection

Configuration name is already in use