Skip to main content
PATCH
Update Connection by ID and Organization ID

Authorizations

X-API-KEY
string
header
required

Headers

X-CONNECTION-INVITE-TOKEN
string | null

Path Parameters

organization_id
string<uuid>
required
connection_id
string<uuid>
required

Body

application/json
credentials
TenableCredentials · object

Connection credentials

identifier
string | null

An optional identifier for the connection, you can use this to reference the connection in your own system

state
enum<string> | null
default:ACTIVE
Available options:
PENDING,
ACTIVE,
PAUSED,
DELETED

Response

Successful Response

id
string<uuid>
required
vendor
string
required
is_active
boolean
required
refresh_interval_secs
integer
required
timeout_secs
integer
required
organization_id
string<uuid>
required
state
enum<string>
required
Available options:
PENDING,
ACTIVE,
PAUSED,
DELETED
created_at
string<date-time>
required
updated_at
string<date-time>
required
health
ConnectionHealthStatus · object
required
oauth2_authorize_url
string | null
identifier
string | null