/gateway-create-migration

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string

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-in
array of strings

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-cert-expiration-event-in
string

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

string

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)

string
Defaults to false

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)

string
Defaults to false

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-types
array of strings

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

ad-discovery-types
string

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

string

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

string

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

string

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

string

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

int32

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

int32

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

string

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)

string
Defaults to 22

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

string
Defaults to linked

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.

string

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

string

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

string
Defaults to windows

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

string

Distinguished Name of User objects to search in Active Directory, e.g.: CN=Users,DC=example,DC=com (Relevant only for Active Directory migration)

string

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)

string
Defaults to false

Use WinRM over HTTP, by default runs over HTTPS

string
Defaults to 5986

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

string

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

string

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

string

AWS Secret Access Key (relevant only for AWS migration)

string

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)

string
Defaults to us-east-2

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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.

string

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

boolean

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-in
array of strings

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

expiration-event-in
string

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)

string

GCP Project ID (cross-project override)

string
Defaults to true

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

hashi-ns
array of strings

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-ns
string

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

string

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

string
required

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

boolean
Defaults to false

Set output format to JSON

k8s-ca-certificate
array of uint8s

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

k8s-ca-certificate
k8s-client-certificate
array of uint8s

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-certificate
k8s-client-key
array of uint8s

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

k8s-client-key
string

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)

string

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

boolean

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

string

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)

string

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

string

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)

string
required

Migration name

string
Defaults to 443

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

string

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

string

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)

int32

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

int32

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

string
Defaults to false

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)

string
required

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

string

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)

string

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

string
required

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

string
required

Target location in Akeyless for imported secrets

string

Authentication token (see /auth and /configure)

string

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

string

The universal identity token, Required only for universal_identity authentication

string

Universal Secret Connector name

boolean

Use the GW's Cloud IAM

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Footer Section