v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/gateway-create-migration

Request body

ServiceAccountKeyDecodedstring
ad-auto-rotatestring

Enable/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-instring[]

How 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-certificates-path-templatestring

Path location template for migrating certificates e.g.: /Certificates/{{COMMON_NAME}} (Relevant only for Active Directory migration with certificate discovery enabled)

ad-computer-base-dnstring

Distinguished 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-appstring

Enable/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-servicesstring

Enable/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-typesstring[]

Set migration discovery types (domain-users, computers, local-users). (Relevant only for Active Directory migration)

ad-domain-namestring

Active Directory Domain Name (Relevant only for Active Directory migration)

ad-domain-users-path-templatestring

Path location template for migrating domain users as Rotated Secrets e.g.: .../DomainUsers/{{USERNAME}} (Relevant only for Active Directory migration)

ad-local-users-ignorestring

Comma-separated list of Local Users which should not be migrated (Relevant only for Active Directory migration)

ad-local-users-path-templatestring

Path location template for migrating domain users as Rotated Secrets e.g.: .../LocalUsers/{{COMPUTER_NAME}}/{{USERNAME}} (Relevant only for Active Directory migration)

ad-os-filterstring

Filter by Operating System to run the migration, can be used with wildcards, e.g. SRV20* (Relevant only for Active Directory migration)

ad-rotation-hourinteger

The hour of the scheduled rotation in UTC (Relevant only for Active Directory migration)

ad-rotation-intervalinteger

The number of days to wait between every automatic rotation [1-365] (Relevant only for Active Directory migration)

ad-sra-enable-rdpstring

Enable/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-portstring

Set the SSH Port for further connection to the domain servers. Default is port 22 (Relevant only for Active Directory migration)

ad-target-formatstring

Relevant 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-namestring

Active Directory LDAP Target Name. Server type should be Active Directory (Relevant only for Active Directory migration)

ad-targets-path-templatestring

Path location template for migrating domain servers as SSH/Windows Targets e.g.: .../Servers/{{COMPUTER_NAME}} (Relevant only for Active Directory migration)

ad-targets-typestring

Set the target type of the domain servers [ssh/windows](Relevant only for Active Directory migration)

ad-user-base-dnstring

Distinguished 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-groupsstring

Comma-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-httpstring

Use WinRM over HTTP, by default runs over HTTPS

ad-winrm-portstring

Set the WinRM Port for further connection to the domain servers. Default is 5986 (Relevant only for Active Directory migration)

ad_discover_local_usersstring

Enable/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 AdDiscoverTypes

ai-certificate-discoverystring

Enable AI-assisted certificate discovery (only when AI Insight is enabled on the Gateway)

aws-keystring

AWS Secret Access Key (relevant only for AWS migration)

aws-key-idstring

AWS 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-regionstring

AWS region of the required Secrets Manager (relevant only for AWS migration)

azure-client-idstring

Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)

azure-kv-namestring

Azure Key Vault Name (relevant only for Azure Key Vault migration)

azure-secretstring

Azure Key Vault secret (relevant only for Azure Key Vault migration)

azure-tenant-idstring

Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)

conjur-accountstring

Conjur account name set on your Conjur server (relevant only for Conjur migration).

conjur-api-keystring

Conjur API Key for the specified user (relevant only for Conjur migration).

conjur-urlstring

Conjur 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-usernamestring

Conjur username used to authenticate (relevant only for Conjur migration).

delete-remoteboolean

Delete the secret from the remote target as well, relevant only when usc-name is not empty (relevant only for HasiCorp Vault migration)

expiration-event-instring[]

How many days before the expiration of the certificate would you like to be notified.

gcp-keystring

Base64-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-idstring

GCP Project ID (cross-project override)

hashi-jsonstring

Import secret key as json value or independent secrets (relevant only for HasiCorp Vault migration) [true/false]

hashi-metadata-modestring

Controls the amount of HashiCorp Vault secret metadata migrated with each secret value. Options: none|minimal|full

hashi-nsstring[]

HashiCorp 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-tokenstring

HashiCorp Vault access token with sufficient permissions to preform list & read operations on secrets objects (relevant only for HasiCorp Vault migration)

hashi-urlstring

HashiCorp Vault API URL, e.g. https://vault-mgr01:8200 (relevant only for HasiCorp Vault migration)

hostsstring required

A comma separated list of IPs, CIDR ranges, or DNS names to scan

jsonboolean

Set output format to JSON

k8s-ca-certificateinteger[]

For Certificate Authentication method K8s Cluster CA certificate (relevant only for K8s migration with Certificate Authentication method)

k8s-client-certificateinteger[]

K8s 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-keyinteger[]

K8s Client key (relevant only for K8s migration with Certificate Authentication method)

k8s-namespacestring

K8s 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-passwordstring

K8s Client password (relevant only for K8s migration with Password Authentication method)

k8s-skip-systemboolean

K8s Skip Control Plane Secrets, This option allows to avoid importing secrets from system namespaces (relevant only for K8s migration)

k8s-tokenstring

For 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-urlstring

K8s API Server URL, e.g. https://k8s-api.mycompany.com:6443 (relevant only for K8s migration)

k8s-usernamestring

For 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)

namestring required

Migration name

port-rangesstring

A comma separated list of port ranges Examples: "80,443" or "80,443,8080-8090" or "443"

protection-keystring

The name of the key that protects the classic key value (if empty, the account default key will be used)

si-auto-rotatestring

Enable/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-hourinteger

The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)

si-rotation-intervalinteger

The number of days to wait between every automatic rotation [1-365] (Relevant only for Server Inventory migration)

si-sra-enable-rdpstring

Enable/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-namestring required

SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)

si-user-groupsstring

Comma-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-ignorestring

Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)

si-users-path-templatestring required

Path location template for migrating users as Rotated Secrets e.g.: .../Users/{{COMPUTER_NAME}}/{{USERNAME}} (Relevant only for Server Inventory migration)

target-locationstring required

Target location in Akeyless for imported secrets

tokenstring

Authentication token (see /auth and /configure)

typestring

Migration type (hashi/aws/gcp/k8s/azure_kv/conjur/active_directory/server_inventory/certificate)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

usc-namestring

Universal Secret Connector name

use-gw-cloud-identityboolean

Use the GW's Cloud IAM

Response

gatewayMigrationCreateResponse wraps response body.

migration_idstring
migration_namestring