/gateway-create-migrationAsk AIpost https://api.akeyless.io/gateway-create-migrationRecent RequestsLog in to see full request historyTimeStatusUser Agent Retrieving recent requests…LoadingLoading…Body ParamsServiceAccountKeyDecodedstringad-auto-rotatestringEnable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with --ad-rotation-interval and --ad-rotation-hour parameters (Relevant only for Active Directory migration)ad-cert-expiration-event-inarray of stringsHow many days before the expiration of discovered certificates would you like to be notified (Relevant only for Active Directory migration with certificate discovery enabled)ad-cert-expiration-event-inADD stringad-certificates-path-templatestringPath location template for migrating certificates e.g.: /Certificates/{{COMMON_NAME}} (Relevant only for Active Directory migration with certificate discovery enabled)ad-computer-base-dnstringDistinguished Name of Computer objects (servers) to search in Active Directory e.g.: CN=Computers,DC=example,DC=com (Relevant only for Active Directory migration)ad-discover-iis-appstringDefaults to falseEnable/Disable discovery of IIS application from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration)ad-discover-servicesstringDefaults to falseEnable/Disable discovery of Windows services from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration)ad-discovery-typesarray of stringsSet migration discovery types (domain-users, computers, local-users). (Relevant only for Active Directory migration)ad-discovery-typesADD stringad-domain-namestringActive Directory Domain Name (Relevant only for Active Directory migration)ad-domain-users-path-templatestringPath location template for migrating domain users as Rotated Secrets e.g.: .../DomainUsers/{{USERNAME}} (Relevant only for Active Directory migration)ad-local-users-ignorestringComma-separated list of Local Users which should not be migrated (Relevant only for Active Directory migration)ad-local-users-path-templatestringPath location template for migrating domain users as Rotated Secrets e.g.: .../LocalUsers/{{COMPUTER_NAME}}/{{USERNAME}} (Relevant only for Active Directory migration)ad-os-filterstringFilter by Operating System to run the migration, can be used with wildcards, e.g. SRV20* (Relevant only for Active Directory migration)ad-rotation-hourint32The hour of the scheduled rotation in UTC (Relevant only for Active Directory migration)ad-rotation-intervalint32The number of days to wait between every automatic rotation [1-365] (Relevant only for Active Directory migration)ad-sra-enable-rdpstringEnable/Disable RDP Secure Remote Access for the migrated local users rotated secrets. Default is false: rotated secrets will not be created with SRA (Relevant only for Active Directory migration)ad-ssh-portstringDefaults to 22Set the SSH Port for further connection to the domain servers. Default is port 22 (Relevant only for Active Directory migration)ad-target-formatstringDefaults to linkedRelevant only for ad-discovery-types=computers. For linked, all computers will be migrated into a linked target(s). if set with regular, the migration will create a target for each computer.ad-target-namestringActive Directory LDAP Target Name. Server type should be Active Directory (Relevant only for Active Directory migration)ad-targets-path-templatestringPath location template for migrating domain servers as SSH/Windows Targets e.g.: .../Servers/{{COMPUTER_NAME}} (Relevant only for Active Directory migration)ad-targets-typestringDefaults to windowsSet the target type of the domain servers [ssh/windows](Relevant only for Active Directory migration)ad-user-base-dnstringDistinguished Name of User objects to search in Active Directory, e.g.: CN=Users,DC=example,DC=com (Relevant only for Active Directory migration)ad-user-groupsstringComma-separated list of domain groups from which privileged domain users will be migrated. If empty, migrate all users based on the --ad-user-base-dn (Relevant only for Active Directory migration)ad-winrm-over-httpstringDefaults to falseUse WinRM over HTTP, by default runs over HTTPSad-winrm-portstringDefaults to 5986Set the WinRM Port for further connection to the domain servers. Default is 5986 (Relevant only for Active Directory migration)ad_discover_local_usersstringEnable/Disable discovery of local users from each domain server and migrate them as SSH/Windows Rotated Secrets. Default is false: only domain users will be migrated. Discovery of local users might require further installation of SSH on the servers, based on the supplied computer base DN. This will be implemented automatically as part of the migration process (Relevant only for Active Directory migration) Deprecated: use AdDiscoverTypesai-certificate-discoverystringEnable AI-assisted certificate discovery (only when AI Insight is enabled on the Gateway)aws-keystringAWS Secret Access Key (relevant only for AWS migration)aws-key-idstringAWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/*]' (relevant only for AWS migration)aws-regionstringDefaults to us-east-2AWS region of the required Secrets Manager (relevant only for AWS migration)azure-client-idstringAzure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)azure-kv-namestringAzure Key Vault Name (relevant only for Azure Key Vault migration)azure-secretstringAzure Key Vault secret (relevant only for Azure Key Vault migration)azure-tenant-idstringAzure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)conjur-accountstringConjur account name set on your Conjur server (relevant only for Conjur migration).conjur-api-keystringConjur API Key for the specified user (relevant only for Conjur migration).conjur-urlstringConjur server base URL (relevant only for Conjur migration). If conjur-url is HTTPS and Conjur uses a private CA/self-signed certificate, make the CA bundle available on the Gateway and set CONJUR_SSL_CERT_PATH to its path.conjur-usernamestringConjur username used to authenticate (relevant only for Conjur migration).delete-remotebooleanDelete the secret from the remote target as well, relevant only when usc-name is not empty (relevant only for HasiCorp Vault migration)truefalseexpiration-event-inarray of stringsHow many days before the expiration of the certificate would you like to be notified.expiration-event-inADD stringgcp-keystringBase64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)gcp-project-idstringGCP Project ID (cross-project override)hashi-jsonstringDefaults to trueImport secret key as json value or independent secrets (relevant only for HasiCorp Vault migration) [true/false]hashi-nsarray of stringsHashiCorp Vault Namespaces is a comma-separated list of namespaces which need to be imported into Akeyless Vault. For every provided namespace, all its child namespaces are imported as well, e.g. nmsp/subnmsp1/subnmsp2,nmsp/anothernmsp. By default, import all namespaces (relevant only for HasiCorp Vault migration)hashi-nsADD stringhashi-tokenstringHashiCorp Vault access token with sufficient permissions to preform list & read operations on secrets objects (relevant only for HasiCorp Vault migration)hashi-urlstringHashiCorp Vault API URL, e.g. https://vault-mgr01:8200 (relevant only for HasiCorp Vault migration)hostsstringrequiredA comma separated list of IPs, CIDR ranges, or DNS names to scanjsonbooleanDefaults to falseSet output format to JSONtruefalsek8s-ca-certificatearray of uint8sFor Certificate Authentication method K8s Cluster CA certificate (relevant only for K8s migration with Certificate Authentication method)k8s-ca-certificateADD uint8k8s-client-certificatearray of uint8sK8s Client certificate with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Certificate Authentication method)k8s-client-certificateADD uint8k8s-client-keyarray of uint8sK8s Client key (relevant only for K8s migration with Certificate Authentication method)k8s-client-keyADD uint8k8s-namespacestringK8s Namespace, Use this field to import secrets from a particular namespace only. By default, the secrets are imported from all namespaces (relevant only for K8s migration)k8s-passwordstringK8s Client password (relevant only for K8s migration with Password Authentication method)k8s-skip-systembooleanK8s Skip Control Plane Secrets, This option allows to avoid importing secrets from system namespaces (relevant only for K8s migration)truefalsek8s-tokenstringFor Token Authentication method K8s Bearer Token with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Token Authentication method)k8s-urlstringK8s API Server URL, e.g. https://k8s-api.mycompany.com:6443 (relevant only for K8s migration)k8s-usernamestringFor Password Authentication method K8s Client username with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Password Authentication method)namestringrequiredMigration nameport-rangesstringDefaults to 443A comma separated list of port ranges Examples: "80,443" or "80,443,8080-8090" or "443"protection-keystringThe name of the key that protects the classic key value (if empty, the account default key will be used)si-auto-rotatestringEnable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with --si-rotation-interval and --si-rotation-hour parameters (Relevant only for Server Inventory migration)si-rotation-hourint32The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)si-rotation-intervalint32The number of days to wait between every automatic rotation [1-365] (Relevant only for Server Inventory migration)si-sra-enable-rdpstringDefaults to falseEnable/Disable RDP Secure Remote Access for the migrated local users rotated secrets. Default is false: rotated secrets will not be created with SRA (Relevant only for Server Inventory migration)si-target-namestringrequiredSSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)si-user-groupsstringComma-separated list of groups to migrate users from. If empty, all users from all groups will be migrated (Relevant only for Server Inventory migration)si-users-ignorestringComma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)si-users-path-templatestringrequiredPath location template for migrating users as Rotated Secrets e.g.: .../Users/{{COMPUTER_NAME}}/{{USERNAME}} (Relevant only for Server Inventory migration)target-locationstringrequiredTarget location in Akeyless for imported secretstokenstringAuthentication token (see /auth and /configure)typestringMigration type (hashi/aws/gcp/k8s/azure_kv/conjur/active_directory/server_inventory/certificate)uid-tokenstringThe universal identity token, Required only for universal_identity authenticationusc-namestringUniversal Secret Connector nameuse-gw-cloud-identitybooleanUse the GW's Cloud IAMtruefalseResponses 200gatewayMigrationCreateResponse wraps response body. defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.Updated 7 months ago