---
title: "Get a specific  connection"
slug: "get-a-specific-connection"
updated: 2025-10-18T04:50:53Z
published: 2025-10-18T04:50:58Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.fortanix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a specific  connection

Get/api/v1/discovery/connections/{id}

Get a specific connection

SecurityOAuth

OAuth 2.0 client credential flow, see [https://datatracker.ietf.org/doc/html/rfc6749#section-4.4](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4).

FlowClient Credentials Token URLhttps://api.armor.fortanix.com/api/v1/iam/session/oauth2/token
		

Path parametersidstring (uuid) Required

Responses2XX

Success result

<select class='api-response-data' aria-label='Media type'><option value='142f7a2d-5e15-48e6-9e51-e5f61635b9d6'>application/json</option>
</select>Expand Allobject  acct_idstring  (uuid)    

Uuid of the account that the connection belongs to

connection_configOneOfobjectobject$typestring    Valid values[
  "aws"
]
aws_scope

The scope that current AWS credentials should have access to

OneOfobjectobject$typestring    Valid values[
  "account"
]
account_idstring   | null  

objectobject$typestring    Valid values[
  "organization"
]

credsOneOfobjectobject$typestring    Valid values[
  "access_and_secret_key"
]
access_keystring    
secret_keystring   | null  

objectobject$typestring    Valid values[
  "open_id_connect"
]
auth_config_idstring  (uuid)    

Uuid for the AuthConfig object within Account

endpointstring  (url)   | null  
role_arnstring   | null  

ARN for AWS Role configured for scanning AWS account/organization

objectobject$typestring    Valid values[
  "azure"
]
azure_scope

The scope that current Azure credentials should have access to

OneOfobjectobject$typestring    Valid values[
  "management_group"
]
management_group_idstring    

objectobject$typestring    Valid values[
  "subscription"
]
subscription_idstring  (uuid)    

credentialsOneOfobjectobject$typestring    Valid values[
  "client_id_and_secret"
]
client_idstring    
client_secretstring   | null  

objectobject$typestring    Valid values[
  "open_id_connect"
]
auth_config_idstring  (uuid)    

Uuid for the AuthConfig object within Account

client_idstring    

tenant_idstring  (uuid)    

objectobject$typestring    Valid values[
  "on_prem"
]
configobject  authOneOfobjectobject$typestring    Valid values[
  "certificate"
]
$valuestring  (byte)    

objectobject$typestring    Valid values[
  "secret"
]
$valuestring    

previous_credentialobject  credentialOneOfobjectobject$typestring    Valid values[
  "certificate"
]
$valuestring  (byte)    

objectobject$typestring    Valid values[
  "secret"
]
$valuestring    

valid_untilstring    Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$Example20170509T070912Z

on_prem_detailsobject  hostnamestring    
resource_summaryobject  database_countinteger    
fs_known_agents_countinteger   | null  
source_code_repo_countinteger   | null  

stateobject  last_polled_atstring    

The time this OnPremConnection was last polled

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$Example20170509T070912Z
statusstring    Valid values[
  "pending",
  "connected",
  "disconnected"
]

objectobject$typestring    Valid values[
  "dsm"
]
active_credential_idstring   | null  
credentialsobject | null  property*OneOfobjectobject$typestring    Valid values[
  "dsm_certificate"
]
app_idstring  (uuid)   | null  
certificate_chain Array of string  | null  string  (byte)    
created_atstring    Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$Example20170509T070912Z
credential_idstring    
private_keystring  (byte)    

objectobject$typestring    Valid values[
  "dsm_agent"
]
credentialOneOfobjectobject$typestring    Valid values[
  "secret"
]
created_atstring    Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$Example20170509T070912Z
credential_idstring  (uuid)    
valuestring    

deploymentOneOfobjectobject$typestring    Valid values[
  "saas"
]
regionstring    Valid values[
  "north_america",
  "european_union",
  "united_kingdom",
  "asia_pacific",
  "australia",
  "saudi_arabia"
]

objectobject$typestring    Valid values[
  "other"
]
urlstring  (url)    

objectobject$typestring    Valid values[
  "dsm_agent"
]
credentialsobject  property*OneOfobjectobject$typestring    Valid values[
  "dsm_certificate"
]
app_idstring  (uuid)   | null  
certificate_chain Array of string  | null  string  (byte)    
created_atstring    Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$Example20170509T070912Z
credential_idstring    
private_keystring  (byte)    

objectobject$typestring    Valid values[
  "dsm_agent"
]
credentialOneOfobjectobject$typestring    Valid values[
  "secret"
]
created_atstring    Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$Example20170509T070912Z
credential_idstring  (uuid)    
valuestring    

detailsobject  agent_hostnamestring   | null  
app_idstring  (uuid)   | null  
dsm_account_idstring  (uuid)   | null  
dsm_urlstring  (url)    

stateobject  last_polled_atstring    

The time this DsmAgentConnection was last polled

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$Example20170509T070912Z
statusstring    Valid values[
  "pending",
  "connected",
  "disconnected"
]

connection_idstring  (uuid)    

An internally generated Uuid for the Connection type

created_atstring    

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_idstring  (uuid)    

Uuid of the group to which the connection object belongs

namestring    

Name of the Connection

Max length4096Pattern^[^\n]*[^\s\n][^\n]*$
policiesobject  crypto_policystring  (uuid)   | null  

scan_filter

The scan filter representing which cloud service provider entities to scan
