Skip to content
adversarial

Update one capability configuration

PATCH
/v1/integrations/{provider}/{installation_id}/configs/{config_id}
curl --request PATCH \
  --url https://api.adversarial.com/api/v1/integrations/example/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/configs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "config": {}, "display_name": null, "enabled": null, "installation_id": null }'

Omitted fields keep their stored value.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
provider
required
string

Provider slug

installation_id
required
string format: uuid

Installation identifier

config_id
required
string format: uuid

Configuration identifier

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Changes to an existing capability configuration. Omitted fields keep their value.

object
config

Complete replacement configuration value.

object
display_name

Replacement instance name.

string | null
enabled

Whether this configuration can execute.

boolean | null
installation_id

Replacement installation. Must name a sibling installation of the same provider in the same organization; the configuration runs with that installation’s credential afterwards. A configuration that has linked tickets does not move.

string | null format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Updated capability configuration

Media typeapplication/json

One capability configuration under an installation.

object
capability
required

Capability identifier.

string
Allowed values: RISK_REGISTER INCIDENT_REGISTER RISK_TICKET INCIDENT_TICKET NOTIFICATION
config
required

Complete validated configuration value.

object
created_date
required

Creation time.

string format: date-time
display_name
required

Name that tells sibling configurations of one capability apart under one installation.

string
enabled
required

Whether the platform can execute this configuration.

boolean
id
required

Configuration identifier.

string format: uuid
installation_id
required

Installation whose credential this configuration runs with.

string format: uuid
updated_date
required

Last update time.

string format: date-time
Example
{
  "capability": "RISK_REGISTER"
}

400

Section titled “400”

Invalid capability configuration

404

Section titled “404”

Unknown provider, installation, or configuration

409

Section titled “409”

Configuration name is already in use, or a move of a configuration that has linked tickets