--- title: "POST /get-target-details" method: POST path: "/get-target-details" tags: ["Targets"] --- # POST /get-target-details `POST /get-target-details` ## Request - Base URL: `https://api.akeyless.io` - URL: `https://api.akeyless.io/get-target-details` - Auth: none declared ## Request body - GetTargetDetails: getTargetDetails is a command that returns target details. [Deprecated: Use target-get-details command] - `json` boolean: Set output format to JSON - `name` string, required: Target name - `show-versions` boolean: Include all target versions in reply - `target-version` integer: Target version - `token` string: Authentication token (see `/auth` and `/configure`) - `uid-token` string: The universal identity token, Required only for universal_identity authentication ## Response `200` getTargetDetailsResponse wraps response body. - GetTargetDetailsOutput - `target` Target - `access_date` string, date-time - `access_date_display` string - `access_request_status` string - `attributes` object: this is not "omitempty" since an empty value causes no update while an empty map will clear the attributes - `client_permissions` string[] - `comment` string - `creation_date` string, date-time - `delete_protection` boolean - `is_access_request_enabled` boolean - `last_access_request_status` string - `last_version` integer - `locking_info` LockingInfo - `actions` string[] - `expire_at` integer - `lock_origin` string - `locked_at` integer - `locked_by` string - `unique_identifier` string - `modification_date` string, date-time - `parent_target_name` string - `protection_key_name` string - `target_details` string - `target_id` integer - `target_items_assoc` TargetItemAssociation[] - `assoc_id` string - `attributes` object - `cluster_id` integer - `item_id` integer - `item_name` string - `item_type` string - `relationship` string - `target_name` string - `target_sub_type` string - `target_type` string - `target_versions` ItemVersion[] - `access_date` string, date-time - `access_date_display` string - `access_id` string - `certificate_version_info` CertificateVersionInfo - `not_after` string, date-time - `not_before` string, date-time - `status` string - `creation_date` string, date-time - `customer_fragment_id` string - `deletion_date` string, date-time - `item_version_state` string: ItemState defines the different states an Item can be in - `modification_date` string, date-time - `protection_key_name` string - `unique_identifier` string - `version` integer - `with_customer_fragment` boolean - `with_customer_fragment` boolean - `value` TargetTypeDetailsInput - `aerospike_target_details` AerospikeTargetDetails - `aerospike_admin_username` string - `aerospike_client_certificate` string - `aerospike_client_id` string - `aerospike_client_private_key` string - `aerospike_client_secret` string - `aerospike_cloud` boolean - `aerospike_cluster_id` string - `aerospike_db_server_name` string - `aerospike_enable_mtls` boolean - `aerospike_hostname` string - `aerospike_namespace` string - `aerospike_password` string - `aerospike_port` string - `aerospike_skip_server_name_validation` string - `aerospike_ssl_connection_certificate` string - `aerospike_ssl_connection_mode` boolean - `alicloud_target_details` AliCloudTargetDetails - `access_key` string - `access_key_id` string - `gw_cloud_identity_external_id_opt` AWSGatewayCloudIdentityExternalIdOpt - `generated_external_id` string - `is_enabled` boolean - `role_arn` string - `region` string - `session_token` string - `use_gw_cloud_identity` boolean - `anthropic_target_details` AnthropicTargetDetails: AnthropicTargetDetails defines details related to connecting to an Anthropic provider - `anthropic_url` string - `api_key` string - `artifactory_target_details` ArtifactoryTargetDetails - `artifactory_admin_apikey` string - `artifactory_admin_username` string - `artifactory_base_url` string - `aws_target_details` AWSTargetDetails - `aws_access_key_id` string - `aws_region` string - `aws_secret_access_key` string - `aws_session_token` string - `aws_user_name` string - `gw_cloud_identity_external_id_opt` AWSGatewayCloudIdentityExternalIdOpt - `generated_external_id` string - `is_enabled` boolean - `role_arn` string - `use_gw_cloud_identity` boolean - `azure_target_details` AzureTargetDetails - `azure_client_id` string - `azure_client_secret` string - `azure_cloud` string - `azure_resource_group_name` string - `azure_resource_name` string - `azure_subscription_id` string - `azure_tenant_id` string - `azure_username` string - `connection_type` string - `expiration_date` string, date-time - `grace_rotated_secret_key` string - `use_gw_cloud_identity` boolean - `bedrock_target_details` BedrockTargetDetails: BedrockTargetDetails defines details related to connecting to an Amazon Bedrock provider. Connectivity checks and model-listing reuse the OpenAI-compat-style `/openai/v1` and control-plane endpoints, but chat/ tool-calling generation uses the native Converse API instead of the OpenAI client (see go/src/ai_agents/bedrock/client.go), since Converse supports the full Bedrock model catalog. - `api_key` string - `bedrock_url` string - `chef_target_details` ChefTargetDetails: ChefTargetDetails - `chef_server_host_name` string - `chef_server_key` string - `chef_server_port` string - `chef_server_url` string - `chef_server_username` string - `chef_skip_ssl` boolean - `cloudflare_target_details` CloudflareTargetDetails: CloudflareTargetDetails - `account_id` string - `api_token` string - `custom_dns_target_details` CustomDnsTargetDetails - `parameters` object - `provider_type` string - `custom_target_details` CustomTargetDetails - `payload` string - `db_target_details` DbTargetDetails: DbTargetDetails - `client_certificate` string: (Optional) ClientCertificate defines the client certificate for mutual TLS. Must be base64 certificate loaded by UI using file loader field - `client_key_passphrase` string: (Optional) ClientKeyPassphrase defines the passphrase for the client private key - `client_private_key` string: (Optional) ClientPrivateKey defines the client private key for mutual TLS. Must be base64 private key loaded by UI using file loader field - `cloud_service_provider` string - `cluster_mode` boolean - `connection_type` string - `db_client_id` string - `db_client_secret` string - `db_host_name` string - `db_name` string - `db_port` string - `db_private_key` string: (Optional) Private Key in PEM format - `db_private_key_passphrase` string - `db_pwd` string - `db_server_certificates` string: (Optional) DBServerCertificates defines the set of root certificate authorities that clients use when verifying server certificates. If DBServerCertificates is empty, TLS uses the host's root CA set. - `db_server_name` string: (Optional) ServerName is used to verify the hostname on the returned certificates unless InsecureSkipVerify is given. It is also included in the client's handshake to support virtual hosting unless it is an IP address. - `db_tenant_id` string - `db_user_name` string - `enable_mtls` boolean: (Optional) EnableMTLS defines if mutual TLS will be used to connect to DB - `oracle_wallet_details` WalletDetails - `login_type` string - `p12_data_base64` string - `sso_data_base64` string - `sf_account` string - `skip_server_name_validation` string: (Optional) SkipServerNameValidation disables server name verification while still validating the certificate chain. Postgres treats empty as legacy "skip hostname validation"; MySQL treats empty as false. - `ssl_connection_certificate` string: (Optional) SSLConnectionCertificate defines the certificate for SSL connection. Must be base64 certificate loaded by UI using file loader field - `ssl_connection_mode` boolean: (Optional) SSLConnectionMode defines if SSL mode will be used to connect to DB - `digicert_target_details` DigiCertTargetDetails - `account_key_pem` string: ACME Account Private Key (PEM-encoded). Supports ECDSA (P-256, P-384, P-521), RSA (2048+), and Ed25519. Auto-generated as ECDSA P-256 during first certificate issuance bootstrap. Stored encrypted, required for certificate operations and revocation. - `account_url` string: ACME Account URL (returned after registration with DigiCert ACME). Used to retrieve existing account instead of re-registering. - `challenge_type` string: ACMEChallengeType defines ACME challenge type for Let's Encrypt - `digicert_directory_type` string - `dns_propagation_wait` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `dns_resolvers` string[]: Custom recursive DNS resolvers (ip:port) for propagation checks. - `dns_skip_precheck` boolean: Skip authoritative nameserver propagation pre-check. - `dns_target_name` string: Name of DNS target (transient field - not stored in DB). Used by CLI to pass DNS target name to SDK for creating target_object_assoc. Retrieved from target_object_assoc when reading target. Required when ChallengeType is dns. - `dns_target_type` string - `dns_timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `dns_zone` string: Cloudflare zone identifier. Required when DNSTargetType is Cloudflare. - `eab_hmac_key` string: External Account Binding HMAC key. Required until ACME account is bootstrapped on first issuance. - `eab_key_id` string: External Account Binding key identifier. Required until ACME account is bootstrapped on first issuance. - `email` string: Email address for ACME account registration. Required. - `gcp_project` string: GCP Cloud DNS: Project ID. Optional - can be derived from service account. - `hosted_zone` string: AWS Route53: Hosted zone ID. Required when DNSTargetType is AWS. - `resource_group` string: Azure DNS: Resource group name. Required when DNSTargetType is Azure. - `timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `dockerhub_target_details` DockerhubTargetDetails: DockerhubTargetDetails - `password` string - `user_name` string - `eks_target_details` EKSTargetDetails: EKSTargetDetails defines details related to connecting to a EKS (Elastic Container Service) target - `eks_access_key_id` string - `eks_cluster_ca_certificate` string - `eks_cluster_endpoint` string - `eks_cluster_name` string - `eks_region` string - `eks_secret_access_key` string - `use_gw_cloud_identity` boolean - `f5_big_ip_target_details` F5BigIpTargetDetails: F5BigIpTargetDetails defines details related to connecting to an F5 BIG-IP appliance - `password` string: F5 password - `url` string: F5 BIG-IP management URL - `username` string: F5 username with permission to manage certificates / users - `gcp_target_details` GcpTargetDetails - `gcp_service_account_email` string - `gcp_service_account_key` string - `gcp_service_account_key_base64` string - `gcp_service_account_key_id` string - `grace_rotated_secret_key` string - `use_gw_cloud_identity` boolean - `gemini_target_details` GeminiTargetDetails: GeminiTargetDetails defines details related to connecting to a Google Gemini provider - `api_key` string - `gemini_url` string - `github_target_details` GithubTargetDetails - `github_app_id` integer - `github_app_private_key` string - `github_base_url` string - `gitlab_target_details` GitlabTargetDetails: GitlabTargetDetails - `gitlab_access_token` string - `gitlab_certificate` string - `gitlab_url` string - `gke_target_details` GKETargetDetails: GKETargetDetails defines details related to connecting to a GKE (Google Kubernetes Engine) target - `gke_cluster_ca_certificate` string - `gke_cluster_endpoint` string - `gke_cluster_name` string - `gke_service_account_key` string - `gke_service_account_name` string - `use_gw_cloud_identity` boolean - `globalsign_atlas_target_details` GlobalSignAtlasTargetDetails: GlobalSignAtlasTargetDetails - `api_key` string - `api_secret` string - `mtls_cert` string - `mtls_key` string - `timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `globalsign_target_details` GlobalSignGCCTargetDetails: GlobalSignGCCTargetDetails - `email` string - `first_name` string: Contact Info - GlobalSign requires this to be sent with every certificate creation request - `last_name` string - `password` string - `phone` string - `profile_id` string - `timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `username` string - `godaddy_target_details` GodaddyTargetDetails: GodaddyTargetDetails - `imap_fqdn` string - `imap_password` string - `imap_port` string - `imap_user` string - `key` string - `secret` string - `shopper_id` string: Optional, used to find the certificate ID in GoDaddy's API - `timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `validation_email` string - `google_trust_target_details` GoogleTrustTargetDetails: GoogleTrustTargetDetails defines configuration for Google Trust Services ACME target - `account_key_pem` string: ACME Account Private Key (PEM-encoded) Supports ECDSA (P-256, P-384, P-521), RSA (2048+), and Ed25519 Auto-generated as ECDSA P-256 during target creation bootstrap Stored encrypted, required for certificate operations and revocation - `account_url` string: ACME Account URL (returned after registration with Google Trust Services) Used to retrieve existing account instead of re-registering - `acme_environment` string: ACMEEnvironment defines Let's Encrypt ACME directory environment - `challenge_type` string: ACMEChallengeType defines ACME challenge type for Let's Encrypt - `dns_propagation_wait` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `dns_resolvers` string[]: Custom recursive DNS resolvers (ip:port) for propagation checks. - `dns_skip_precheck` boolean: Skip authoritative nameserver propagation pre-check. - `dns_target_name` string: Name of DNS target (transient field - not stored in DB) Used by CLI to pass DNS target name to SDK for creating target_object_assoc Retrieved from target_object_assoc when reading target Required when ChallengeType is "dns" - `dns_target_type` string - `dns_timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `dns_zone` string: Cloudflare zone identifier Required when DNSTargetType is Cloudflare - `eab_hmac_key` string: External Account Binding HMAC key (required for ACME account bootstrap on target creation) Not persisted after bootstrap - `eab_key_id` string: External Account Binding key identifier (required for ACME account bootstrap on target creation) Not persisted after bootstrap - `email` string: Email address for ACME account registration Required - `gcp_project` string: GCP Cloud DNS: Project ID Optional - can be derived from service account - `hosted_zone` string: AWS Route53: Hosted zone ID Required when DNSTargetType is AWS - `resource_group` string: Azure DNS: Resource group name Required when DNSTargetType is Azure - `timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `grok_target_details` GrokTargetDetails: GrokTargetDetails defines details related to connecting to an xAI (Grok) provider. Grok exposes an OpenAI-compatible REST API, so the agent layer reuses the OpenAI client with a custom BaseURL. - `api_key` string - `grok_url` string - `team_id` string: TeamID is the xAI team this API key belongs to. Stored only; not sent to xAI by the gateway. - `hashi_vault_target_details` HashiVaultTargetDetails: HashiVaultTargetDetails - `vault_namespaces` string - `vault_token` string - `vault_url` string - `keycloak_target_details` KeycloakTargetDetails: KeycloakTargetDetails defines details for a Keycloak target - `keycloak_client_id` string - `keycloak_client_secret` string - `keycloak_realm` string - `keycloak_url` string - `ldap_target_details` LdapTargetDetails: LdapTargetDetails - `implementation_type` string - `ldap_audience` string - `ldap_bind_dn` string - `ldap_bind_password` string - `ldap_certificate` string - `ldap_token_expiration` string - `ldap_url` string - `ldap_username` string - `letsencrypt_target_details` LetsEncryptTargetDetails: LetsEncryptTargetDetails defines configuration for Let's Encrypt ACME target - `account_key_pem` string: ACME Account Private Key (PEM-encoded) Supports ECDSA (P-256, P-384, P-521), RSA (2048+), and Ed25519 Auto-generated as ECDSA P-256 on first certificate issuance if not provided Stored encrypted, required for certificate operations and revocation - `account_url` string: ACME Account URL (returned after registration with Let's Encrypt) Used to retrieve existing account instead of re-registering - `acme_environment` string: ACMEEnvironment defines Let's Encrypt ACME directory environment - `challenge_type` string: ACMEChallengeType defines ACME challenge type for Let's Encrypt - `dns_propagation_wait` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `dns_resolvers` string[]: Custom recursive DNS resolvers (ip:port) for propagation checks. - `dns_skip_precheck` boolean: Skip authoritative nameserver propagation pre-check. - `dns_target_name` string: Name of DNS target (transient field - not stored in DB) Used by CLI to pass DNS target name to SDK for creating target_object_assoc Retrieved from target_object_assoc when reading target Required when ChallengeType is "dns" - `dns_target_type` string - `dns_timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `dns_zone` string: Cloudflare zone identifier Required when DNSTargetType is Cloudflare - `email` string: Email address for ACME account registration Required - `gcp_project` string: GCP Cloud DNS: Project ID Optional - can be derived from service account - `hosted_zone` string: AWS Route53: Hosted zone ID Required when DNSTargetType is AWS - `resource_group` string: Azure DNS: Resource group name Required when DNSTargetType is Azure - `timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `linked_target_details` LinkedTargetDetails: LinkedTargetDetails - `hosts` object: key hostname, value description - `mongo_db_target_details` MongoDBTargetDetails - `mongodb_atlas_api_private_key` string - `mongodb_atlas_api_public_key` string - `mongodb_atlas_project_id` string: mongodb atlas fields - `mongodb_db_name` string: common fields - `mongodb_default_auth_db` string - `mongodb_host_port` string - `mongodb_is_atlas` boolean - `mongodb_password` string - `mongodb_uri_connection` string: mongodb fields - `mongodb_uri_options` string - `mongodb_username` string - `native_k8s_target_details` NativeK8sTargetDetails - `k8s_auth_type` string - `k8s_bearer_token` string - `k8s_client_cert_data` string: For K8s Client certificates authentication - `k8s_client_key_data` string - `k8s_cluster_ca_certificate` string - `k8s_cluster_endpoint` string - `k8s_cluster_name` string - `use_gw_service_account` boolean - `okta_target_details` OktaTargetDetails: OktaTargetDetails defines details for an Okta target - `okta_api_token` string - `okta_url` string - `openai_target_details` OpenAITargetDetails: OpenAITargetDetails defines details related to connecting to an OpenAI provider - `api_key` string - `api_key_id` string - `auth_mode` string: AuthMode selects how this target authenticates. Empty (default) uses ApiKey as a static bearer token against BaseURL, matching all pre-existing behavior. OpenAIAuthModeChatGPTOAuth instead uses the OAuth* fields below. - `oauth_access_token` string: OAuthAccessToken is the current ChatGPT-issued access token (the `tokens.access_token` field of the customer's local auth.json). Akeyless refreshes this automatically; do not treat it as long-lived. - `oauth_account_id` string: OAuthAccountID is the ChatGPT workspace/account id (`tokens.account_id` in auth.json), required on every request to the ChatGPT backend. - `oauth_last_refresh` string: OAuthLastRefresh is the RFC3339 timestamp of the last successful Akeyless-performed refresh; used as a fallback expiry heuristic when the access token's JWT exp claim can't be parsed. - `oauth_refresh_token` string: OAuthRefreshToken mints new access tokens. It rotates on every refresh - Akeyless persists the new value after each successful refresh, so the previous value becomes invalid. - `openai_url` string - `organization_id` string - `project_id` string - `ping_target_details` PingTargetDetails: PingTargetDetails - `administrative_port` string - `authorization_port` string - `ping_url` string - `privileged_user` string - `user_password` string - `rabbit_mq_target_details` RabbitMQTargetDetails - `rabbitmq_server_password` string - `rabbitmq_server_uri` string - `rabbitmq_server_user` string - `salesforce_target_details` SalesforceTargetDetails: SalesforceTargetDetails - `app_private_key` integer[]: params needed for jwt auth AppPrivateKey is the rsa private key in PEM format - `auth_flow` string - `ca_cert_data` integer[]: CACertData is the rsa 4096 certificate data in PEM format - `ca_cert_name` string: CACertName is the name of the certificate in SalesForce tenant - `client_id` string - `client_secret` string: params needed for password auth - `password` string - `security_token` string - `tenant_url` string - `user_name` string - `sectigo_target_details` SectigoTargetDetails: SectigoTargetDetails - `certificate_profile_id` integer - `customer_uri` string - `external_requester` string - `org_id` integer - `password` string - `timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `username` string - `splunk_target_details` SplunkTargetDetails: SplunkTargetDetails defines details related to connecting to a Splunk server - `audience` string: Token audience - `auth_mode` string: Authentication mode: "username" or "token" - `password` string - `splunk_payload` SplunkPayload - `audience` string - `expiration_date` string - `hec_token_name` string - `token` string - `token_id` string - `token_owner` string - `validity_period_days` integer - `splunk_url` string: Splunk server URL - `token` string: Token is used when AuthMode == "token" - `token_owner` string: Token owner (the Splunk user who owns the token, required for token rotation) - `use_tls` boolean: Use TLS certificate verification when connecting to the Splunk management API. - `username` string: Username & Password are used when AuthMode == "username" - `ssh_target_details` SSHTargetDetails - `host` string - `password` string - `port` string - `private_key` string - `private_key_password` string - `username` string - `venafi_target_details` VenafiTargetDetails - `venafi_api_key` string - `venafi_base_url` string - `venafi_tpp_access_token` string - `venafi_tpp_client_id` string - `venafi_tpp_password` string: Deprecated: VenafiAccessToken and VenafiRefreshToken should be used instead - `venafi_tpp_refresh_token` string - `venafi_tpp_username` string: Deprecated: VenafiAccessToken and VenafiRefreshToken should be used instead - `venafi_use_tpp` boolean - `venafi_zone` string - `web_target_details` WebTargetDetails - `url` string - `windows_target_details` WindowsTargetDetails: WindowsTargetDetails - `certificate` string - `connection_type` string - `domain_name` string - `hostname` string - `password` string - `port` string - `use_tls` boolean - `username` string - `zerossl_target_details` ZeroSSLTargetDetails: ZeroSSLTargetDetails - `api_key` string - `imap_fqdn` string - `imap_password` string - `imap_port` string - `imap_user` string - `timeout` integer: A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. - `validation_email` string ## Other responses - `default`: errorResponse wraps any error to return it as a JSON object with one "error" field. --- [API](https://skmtc.dev/akeyless/apis/infrastructure-connectivity.md) - [All operations](https://skmtc.dev/akeyless/apis/infrastructure-connectivity/llms.txt) - [OpenAPI document](https://skmtc.dev/akeyless/apis/infrastructure-connectivity/revisions/62dc62fea89d?raw)