Get
/api/v1/discovery/connections
Get all connections
Security
OAuth
OAuth 2.0 client credential flow, see https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.
FlowClient Credentials
Token URLhttps://api.armor.fortanix.com/api/v1/iam/session/oauth2/token
Query parameters
DiscoveryGetAllConnectionsParams
object
filter
string
limit
integer
offset
integer
previous_id
string (uuid)
sort_by
string
Responses
2XX
Success result
object
items
Array of object (DiscoveryConnection)
object
acct_id
string (uuid)
Uuid of the account that the connection belongs to
connection_config
OneOf
object
object
$type
string
Valid values[
"aws"
]
aws_scope
The scope that current AWS credentials should have access to
OneOf
object
object
$type
string
Valid values[
"account"
]
account_id
string | null
object
object
$type
string
Valid values[
"organization"
]
creds
OneOf
object
object
$type
string
Valid values[
"access_and_secret_key"
]
access_key
string
secret_key
string | null
object
object
$type
string
Valid values[
"open_id_connect"
]
auth_config_id
string (uuid)
Uuid for the AuthConfig object within Account
endpoint
string (url) | null
role_arn
string | null
ARN for AWS Role configured for scanning AWS account/organization
object
object
$type
string
Valid values[
"azure"
]
azure_scope
The scope that current Azure credentials should have access to
OneOf
object
object
$type
string
Valid values[
"management_group"
]
management_group_id
string
object
object
$type
string
Valid values[
"subscription"
]
subscription_id
string (uuid)
credentials
OneOf
object
object
$type
string
Valid values[
"client_id_and_secret"
]
client_id
string
client_secret
string | null
object
object
$type
string
Valid values[
"open_id_connect"
]
auth_config_id
string (uuid)
Uuid for the AuthConfig object within Account
client_id
string
tenant_id
string (uuid)
object
object
$type
string
Valid values[
"on_prem"
]
config
object
auth
OneOf
object
object
$type
string
Valid values[
"certificate"
]
$value
string (byte)
object
object
$type
string
Valid values[
"secret"
]
$value
string
previous_credential
object
credential
OneOf
object
object
$type
string
Valid values[
"certificate"
]
$value
string (byte)
object
object
$type
string
Valid values[
"secret"
]
$value
string
valid_until
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
on_prem_details
object
hostname
string
resource_summary
object
database_count
integer
fs_known_agents_count
integer | null
source_code_repo_count
integer | null
state
object
last_polled_at
string
The time this OnPremConnection was last polled
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
status
string
Valid values[
"pending",
"connected",
"disconnected"
]
object
object
$type
string
Valid values[
"dsm"
]
active_credential_id
string | null
credentials
object | null
property*
OneOf
object
object
$type
string
Valid values[
"dsm_certificate"
]
app_id
string (uuid) | null
certificate_chain
Array of string | null
string (byte)
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
credential_id
string
private_key
string (byte)
object
object
$type
string
Valid values[
"dsm_agent"
]
credential
OneOf
object
object
$type
string
Valid values[
"secret"
]
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
credential_id
string (uuid)
value
string
deployment
OneOf
object
object
$type
string
Valid values[
"saas"
]
region
string
Valid values[
"north_america",
"european_union",
"united_kingdom",
"asia_pacific",
"australia",
"saudi_arabia"
]
object
object
$type
string
Valid values[
"other"
]
url
string (url)
object
object
$type
string
Valid values[
"dsm_agent"
]
credentials
object
property*
OneOf
object
object
$type
string
Valid values[
"dsm_certificate"
]
app_id
string (uuid) | null
certificate_chain
Array of string | null
string (byte)
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
credential_id
string
private_key
string (byte)
object
object
$type
string
Valid values[
"dsm_agent"
]
credential
OneOf
object
object
$type
string
Valid values[
"secret"
]
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
credential_id
string (uuid)
value
string
details
object
agent_hostname
string | null
app_id
string (uuid) | null
dsm_account_id
string (uuid) | null
dsm_url
string (url)
state
object
last_polled_at
string
The time this DsmAgentConnection was last polled
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
status
string
Valid values[
"pending",
"connected",
"disconnected"
]
connection_id
string (uuid)
An internally generated Uuid for the Connection type
created_at
string
The time this Connection object was created
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
external_key_sources
Array of string | null
External key source
string (uuid)
group_id
string (uuid)
Uuid of the group to which the connection object belongs
name
string
Name of the Connection
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
policies
object
crypto_policy
string (uuid) | null
scan_filter
The scan filter representing which cloud service provider entities to scan
metadata
object
filtered_count
integer
The amount returned with the filter applied
Minimum0
Maximum4294967295
total_count
integer
The total number of Connection objects that exist
Minimum0
Maximum4294967295