How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Akeyless v2 API

The v2 API from Akeyless — 256 operation(s) for v2.

Akeyless v2 API is published by Akeyless on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include v2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 256 operations across 256 paths, and defines 614 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://api.akeyless.io/.

256 operations 256 paths 614 schemas 1 DELETE255 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.akeyless.io
Contact
Resource Areas
1

Paths & Operations 256

Across 256 paths, the API surfaces 256 operations — 1 DELETE, 255 POST. Each is listed below with its method, path, parameters, and response codes.

v2 256
POST
/assoc-role-am
assocRoleAuthMethod body → 200default
POST
/assoc-target-item
assocTargetItem body → 200default
POST
/auth
auth body → 200401default
POST
/configure
configure body → 200default
POST
/connect
Connect body → 200default
POST
/create-artifactory-target
createArtifactoryTarget body → 200default
POST
/create-auth-method
createAuthMethod body → 200default
POST
/create-auth-method-aws-iam
createAuthMethodAWSIAM body → 200default
POST
/create-auth-method-azure-ad
createAuthMethodAzureAD body → 200default
POST
/create-auth-method-cert
createAuthMethodCert body → 200default
POST
/create-auth-method-gcp
createAuthMethodGCP body → 200default
POST
/create-auth-method-huawei
createAuthMethodHuawei body → 200default
POST
/create-auth-method-k8s
createAuthMethodK8S body → 200default
POST
/create-auth-method-ldap
createAuthMethodLDAP body → 200default
POST
/create-auth-method-oauth2
createAuthMethodOAuth2 body → 200default
POST
/create-auth-method-oidc
createAuthMethodOIDC body → 200default
POST
/create-auth-method-saml
createAuthMethodSAML body → 200default
POST
/create-auth-method-universal-identity
createAuthMethodUniversalIdentity body → 200default
POST
/create-aws-target
createAWSTarget body → 200default
POST
/create-azure-target
createAzureTarget body → 200default
POST
/create-certificate
createCertificate body → 200default
POST
/create-classic-key
CreateClassicKey body → 201default
POST
/create-db-target
createDBTarget body → 200default
POST
/create-dfc-key
createDFCKey body → 200default
POST
/create-dockerhub-target
createDockerhubTarget body → 200default
POST
/create-dynamic-secret
createDynamicSecret body → 200default
POST
/create-eks-target
createEKSTarget body → 200default
POST
/create-event-forwarder
createEventForwarder body → 200default
POST
/create-gcp-target
createGcpTarget body → 200default
POST
/create-github-target
createGithubTarget body → 200default
POST
/create-gke-target
createGKETarget body → 200default
POST
/create-k8s-target
createNativeK8STarget body → 200default
POST
/create-key
createKey body → 200default
POST
/create-ldap-target
createldapTarget body → 200default
POST
/create-ping-target
createPingTarget body → 200default
POST
/create-pki-cert-issuer
CreatePKICertIssuer body → 200default
POST
/create-rabbitmq-target
createRabbitMQTarget body → 200default
POST
/create-role
createRole body → 200default
POST
/create-rotated-secret
createRotatedSecret body → 200default
POST
/create-salesforce-target
createSalesforceTarget body → 200default
POST
/create-secret
createSecret body → 200default
POST
/create-ssh-cert-issuer
createSSHCertIssuer body → 200default
POST
/create-ssh-target
createSSHTarget body → 200default
POST
/create-tokenizer
createTokenizer body → 200default
POST
/create-web-target
createWebTarget body → 200default
POST
/decrypt
decrypt body → 200default
POST
/decrypt-gpg
decryptGPG body → 200default
POST
/decrypt-pkcs1
decryptPKCS1 body → 200default
POST
/decrypt-with-classic-key
decryptWithClassicKey body → 200default
POST
/delete-assoc
deleteRoleAssociation body → 200default
POST
/delete-assoc-target-item
deleteTargetAssociation body → 200default
POST
/delete-auth-method
deleteAuthMethod body → 200default
POST
/delete-auth-methods
deleteAuthMethods body → 200default
POST
/delete-event-forwarder
deleteEventForwarder body → 200default
POST
/delete-item
deleteItem body → 200default
POST
/delete-items
deleteItems body → 200default
POST
/delete-role
deleteRole body → 200default
POST
/delete-role-rule
deleteRoleRule body → 200default
POST
/delete-roles
deleteRoles body → 200default
POST
/delete-target
deleteTarget body → 200default
POST
/delete-targets
deleteTargets body → 200default
POST
/describe-item
describeItem body → 200default
POST
/describe-permissions
describePermissions body → 200default
POST
/describe-sub-claims
describeSubClaims body → 200401default
POST
/detokenize
detokenize body → 200default
POST
/encrypt
encrypt body → 200default
POST
/encrypt-gpg
encryptGPG body → 200default
POST
/encrypt-with-classic-key
encryptWithClassicKey body → 200default
POST
/export-classic-key
ExportClassicKey body → 200default
POST
/gateway-create-k8s-auth-config
gatewayCreateK8SAuthConfig body → 201default
POST
/gateway-create-migration
gatewayCreateMigration body → 200default
POST
/gateway-create-producer-artifactory
gatewayCreateProducerArtifactory body → 201default
POST
/gateway-create-producer-aws
gatewayCreateProducerAws body → 201default
POST
/gateway-create-producer-azure
gatewayCreateProducerAzure body → 201default
POST
/gateway-create-producer-cassandra
gatewayCreateProducerCassandra body → 201default
POST
/gateway-create-producer-certificate-automation
gatewayCreateProducerCertificateAutomation body → 201default
POST
/gateway-create-producer-custom
gatewayCreateProducerCustom body → 200default
POST
/gateway-create-producer-dockerhub
gatewayCreateProducerDockerhub body → 201default
POST
/gateway-create-producer-eks
gatewayCreateProducerEks body → 201default
POST
/gateway-create-producer-gcp
gatewayCreateProducerGcp body → 201default
POST
/gateway-create-producer-github
gatewayCreateProducerGithub body → 201default
POST
/gateway-create-producer-gke
gatewayCreateProducerGke body → 201default
POST
/gateway-create-producer-hanadb
gatewayCreateProducerHanaDb body → 201default
POST
/gateway-create-producer-k8s
gatewayCreateProducerNativeK8S body → 201default
POST
/gateway-create-producer-ldap
gatewayCreateProducerLdap body → 201default
POST
/gateway-create-producer-mongo
gatewayCreateProducerMongo body → 201default
POST
/gateway-create-producer-mssql
gatewayCreateProducerMSSQL body → 201default
POST
/gateway-create-producer-mysql
gatewayCreateProducerMySQL body → 201default
POST
/gateway-create-producer-oracle
gatewayCreateProducerOracleDb body → 201default
POST
/gateway-create-producer-ping
gatewayCreateProducerPing body → 201default
POST
/gateway-create-producer-postgresql
gatewayCreateProducerPostgreSQL body → 201default
POST
/gateway-create-producer-rabbitmq
gatewayCreateProducerRabbitMQ body → 201default
POST
/gateway-create-producer-rdp
gatewayCreateProducerRdp body → 201default
POST
/gateway-create-producer-redshift
gatewayCreateProducerRedshift body → 201default
POST
/gateway-create-producer-snowflake
gatewayCreateProducerSnowflake body → 201default
POST
/gateway-delete-allowed-management-access
gatewayDeleteAllowedManagementAccess body → 200default
POST
/gateway-delete-k8s-auth-config
gatewayDeleteK8SAuthConfig body → 201default
POST
/gateway-delete-migration
gatewayDeleteMigration body → 200default
POST
/gateway-delete-producer
gatewayDeleteProducer body → 200default
POST
/gateway-get-config
gatewayGetConfig body → 200default
POST
/gateway-get-k8s-auth-config
gatewayGetK8SAuthConfig body → 201default
POST
/gateway-get-ldap-auth-config
gatewayGetLdapAuthConfig body → 201default
POST
/gateway-get-migration
gatewayGetMigration body → 200default
POST
/gateway-get-producer
gatewayGetProducer body → 200default
POST
/gateway-get-producer-tmp-creds
gatewayGetTmpUsers body → 200default
POST
/gateway-list-allowed-management-access
gatewayListAllowedManagementAccess body → 200default
POST
/gateway-list-migration
gatewayListMigration body → 200default
POST
/gateway-list-producers
gatewayListProducers body → 200default
POST
/gateway-migrate-personal-items
gatewayMigratePersonalItems body → 200default
POST
/gateway-migration-status
gatewayStatusMigration body → 200default
POST
/gateway-revoke-producer-tmp-creds
gatewayRevokeTmpUsers body → 200default
POST
/gateway-rotate-secret
rotateSecret body → 200default
POST
/gateway-start-producer
gatewayStartProducer body → 200default
POST
/gateway-stop-producer
gatewayStopProducer body → 200default
POST
/gateway-sync-migration
gatewaySyncMigration body → 200default
POST
/gateway-update-item
gatewayUpdateItem body → 201default
POST
/gateway-update-k8s-auth-config
gatewayUpdateK8SAuthConfig body → 201default
POST
/gateway-update-ldap-auth-config
GatewayUpdateLdapAuthConfig body → 201default
POST
/gateway-update-migration
gatewayUpdateMigration body → 200default
POST
/gateway-update-producer-artifactory
gatewayUpdateProducerArtifactory body → 201default
POST
/gateway-update-producer-aws
gatewayUpdateProducerAws body → 200default
POST
/gateway-update-producer-azure
gatewayUpdateProducerAzure body → 201default
POST
/gateway-update-producer-cassandra
gatewayUpdateProducerCassandra body → 201default
POST
/gateway-update-producer-certificate-automation
gatewayUpdateProducerCertificateAutomation body → 201default
POST
/gateway-update-producer-custom
gatewayUpdateProducerCustom body → 200default
POST
/gateway-update-producer-dockerhub
gatewayUpdateProducerDockerhub body → 201default
POST
/gateway-update-producer-eks
gatewayUpdateProducerEks body → 201default
POST
/gateway-update-producer-gcp
gatewayUpdateProducerGcp body → 201default
POST
/gateway-update-producer-github
gatewayUpdateProducerGithub body → 201default
POST
/gateway-update-producer-gke
gatewayUpdateProducerGke body → 201default
POST
/gateway-update-producer-hana
gatewayUpdateProducerHanaDb body → 201default
POST
/gateway-update-producer-k8s
gatewayUpdateProducerNativeK8S body → 201default
POST
/gateway-update-producer-ldap
gatewayUpdateProducerLdap body → 201default
POST
/gateway-update-producer-mongo
gatewayUpdateProducerMongo body → 201default
POST
/gateway-update-producer-mssql
gatewayUpdateProducerMSSQL body → 201default
POST
/gateway-update-producer-mysql
gatewayUpdateProducerMySQL body → 201default
POST
/gateway-update-producer-oracle
gatewayUpdateProducerOracleDb body → 201default
POST
/gateway-update-producer-ping
gatewayUpdateProducerPing body → 201default
POST
/gateway-update-producer-postgresql
gatewayUpdateProducerPostgreSQL body → 201default
POST
/gateway-update-producer-rabbitmq
gatewayUpdateProducerRabbitMQ body → 201default
POST
/gateway-update-producer-rdp
gatewayUpdateProducerRdp body → 201default
POST
/gateway-update-producer-redshift
gatewayUpdateProducerRedshift body → 201default
POST
/gateway-update-producer-snowflake
gatewayUpdateProducerSnowflake body → 201default
POST
/gateway-update-producer-tmp-creds
gatewayUpdateTmpUsers body → 200default
POST
/gateway-update-tls-cert
GatewayUpdateTlsCert body → 201default
POST
/get-account-logo
getAccountLogo → 200default
POST
/get-account-settings
getAccountSettings body → 200default
POST
/get-auth-method
getAuthMethod body → 200default
POST
/get-certificate-value
getCertificateValue body → 200default
POST
/get-dynamic-secret-value
getDynamicSecretValue body → 200default
POST
/get-event-forwarder
getEventForwarder body → 200default
POST
/get-kube-exec-creds
getKubeExecCreds body → 200default
POST
/get-pki-certificate
GetPKICertificate body → 200default
POST
/get-role
getRole body → 200default
POST
/get-rotated-secret-value
getRotatedSecretValue body → 200default
POST
/get-rsa-public
getRSAPublic body → 200default
POST
/get-secret-value
GetSecretValue body → 200default
POST
/get-ssh-certificate
getSSHCertificate body → 200default
POST
/get-tags
getTags body → 200default
POST
/get-target
getTarget body → 200default
POST
/get-target-details
getTargetDetails body → 200default
POST
/kmip-client-delete-rule
kmipClientDeleteRule body → 200default
POST
/kmip-client-set-rule
kmipClientSetRule body → 200default
POST
/kmip-create-client
kmipCreateClient body → 200default
POST
/kmip-create-environment
kmipServerSetup body → 200default
POST
/kmip-delete-client
kmipDeleteClient body → 200default
DELETE
/kmip-delete-environment
kmipDeleteServer body → 200default
POST
/kmip-get-client
kmipDescribeClient body → 200default
POST
/kmip-get-environment
kmipDescribeServer body → 200default
POST
/kmip-list-clients
kmipListClients body → 200default
POST
/kmip-move-environment
kmipMoveServer body → 200default
POST
/kmip-renew-client
kmipRenewClientCertificate body → 200default
POST
/kmip-renew-environment
kmipRenewServerCertificate body → 200default
POST
/kmip-set-environment-state
kmipSetServerState body → 200default
POST
/list-auth-methods
listAuthMethods body → 200default
POST
/list-gateways
listGateways body → 200default
POST
/list-items
listItems body → 200default
POST
/list-roles
listRoles body → 200default
POST
/list-shared-items
listSharedItems body → 200default
POST
/list-sra-bastions
listSRABastions body → 200default
POST
/list-targets
listTargets body → 200default
POST
/move-objects
moveObjects body → 200default
POST
/raw-creds
rawCreds body → 200default
POST
/refresh-key
refreshKey body → 200default
POST
/request-access
requestAccess body → 200default
POST
/reverse-rbac
reverseRBAC body → 200default
POST
/revoke-creds
revoke-creds → 200default
POST
/rollback-secret
rollbackSecret body → 200default
POST
/rotate-key
rotateKey body → 200default
POST
/set-item-state
setItemState body → 200default
POST
/set-role-rule
setRoleRule body → 200default
POST
/share-item
shareItem body → 200default
POST
/sign-gpg
signGPG body → 200default
POST
/sign-jwt-with-classic-key
signJWTWithClassicKey body → 200default
POST
/sign-pkcs1
signPKCS1 body → 200default
POST
/sign-pki-cert-with-classic-key
signPKICertWithClassicKey body → 200default
POST
/static-creds-auth
staticCredsAuth body → 200default
POST
/tokenize
tokenize body → 200default
POST
/uid-create-child-token
uidCreateChildToken body → 200default
POST
/uid-generate-token
uidGenerateToken body → 200default
POST
/uid-list-children
uidListChildren body → 200default
POST
/uid-revoke-token
uidRevokeToken body → 200default
POST
/uid-rotate-token
uidRotateToken body → 200default
POST
/update-account-settings
updateAccountSettings body → 200default
POST
/update-artifactory-target
updateArtifactoryTarget body → 200default
POST
/update-assoc
updateAssoc body → 200default
POST
/update-auth-method
updateAuthMethod body → 200default
POST
/update-auth-method-aws-iam
updateAuthMethodAWSIAM body → 200default
POST
/update-auth-method-azure-ad
updateAuthMethodAzureAD body → 200default
POST
/update-auth-method-cert
updateAuthMethodCert body → 200default
POST
/update-auth-method-gcp
updateAuthMethodGCP body → 200default
POST
/update-auth-method-k8s
updateAuthMethodK8S body → 200default
POST
/update-auth-method-ldap
updateAuthMethodLDAP body → 200default
POST
/update-auth-method-oauth2
updateAuthMethodOAuth2 body → 200default
POST
/update-auth-method-oidc
updateAuthMethodOIDC body → 200default
POST
/update-auth-method-saml
updateAuthMethodSAML body → 200default
POST
/update-auth-method-universal-identity
updateAuthMethodUniversalIdentity body → 200default
POST
/update-aws-target
updateAWSTarget body → 200default
POST
/update-aws-target-details
updateAWSTargetDetails body → 200default
POST
/update-azure-target
updateAzureTarget body → 200default
POST
/update-certificate-value
updateCertificateValue body → 200default
POST
/update-db-target
updateDBTarget body → 200default
POST
/update-db-target-details
updateDBTargetDetails body → 200default
POST
/update-dockerhub-target
updateDockerhubTarget body → 200default
POST
/update-eks-target
updateEKSTarget body → 200default
POST
/update-event-forwarder
updateEventForwarder body → 200default
POST
/update-gcp-target
updateGcpTarget body → 200default
POST
/update-github-target
updateGithubTarget body → 200default
POST
/update-gke-target
updateGKETarget body → 200default
POST
/update-item
updateItem body → 200default
POST
/update-k8s-target
updateNativeK8STarget body → 200default
POST
/update-ldap-target
updateLdapTarget body → 200default
POST
/update-ldap-target-details
updateLdapTargetDetails body → 200default
POST
/update-ping-target
updatePingTarget body → 200default
POST
/update-pki-cert-issuer
UpdatePKICertIssuer body → 200default
POST
/update-rabbitmq-target
updateRabbitMQTarget body → 200default
POST
/update-rabbitmq-target-details
updateRabbitMQTargetDetails body → 200default
POST
/update-rdp-target-details
updateRDPTargetDetails body → 200default
POST
/update-role
updateRole body → 200default
POST
/update-rotated-secret
updateRotatedSecret body → 200default
POST
/update-rotation-settingsrotate-key
updateRotationSettings → 200default
POST
/update-salesforce-target
updateSalesforceTarget body → 200default
POST
/update-secret-val
updateSecretVal body → 200default
POST
/update-ssh-cert-issuer
updateSSHCertIssuer body → 200default
POST
/update-ssh-target
updateSSHTarget body → 200default
POST
/update-ssh-target-details
updateSSHTargetDetails body → 200default
POST
/update-target
updateTarget body → 200default
POST
/update-target-details
updateTargetDetails body → 200default
POST
/update-web-target
updateWebTarget body → 200default
POST
/update-web-target-details
updateWebTargetDetails body → 200default
POST
/upload-rsa
uploadRSA body → 200default
POST
/validate-token
validateToken body → 200401default
POST
/verify-gpg
verifyGPG body → 200default
POST
/verify-jwt-with-classic-key
verifyJWTWithClassicKey body → 200default
POST
/verify-pkcs1
verifyPKCS1 body → 200default
POST
/verify-pki-cert-with-classic-key
verifyPKICertWithClassicKey body → 200default

Schemas 614

The contract defines 614 schemas that model the data the API accepts and returns. The most detailed are DSProducerDetails (202 properties), TargetTypeDetailsInput (100 properties), gatewayUpdateMigration (49 properties), gatewayCreateMigration (48 properties). Each schema is shown below with its type and property counts.

updateAuthMethodOAuth2
object
updateAuthMethodOAuth2 is a command that updates a new auth method that will be able to authenticate using Oauth2.
15 properties 3 required
createGcpTarget
object
9 properties 1 required
gatewayCreateProducerNativeK8SOutput
object
1 property
gatewayUpdateProducerCustomOutput
object
1 property
uidGenerateToken
object
uidGenerateToken is a command that generates a new token using Akeyless Universal Identity.
4 properties 1 required
createDFCKeyOutput
object
1 property
KMIPClientUpdateResponse
object
1 property
updateLdapTargetOutput
object
1 property
gatewayCreateK8SAuthConfig
object
gatewayCreateK8SAuth is a command that creates k8s auth config
16 properties 4 required
kmipCreateClient
object
6 properties 1 required
gatewayCreateProducerSnowflakeOutput
object
1 property
updateAWSTargetOutput
object
gatewayStatusMigration
object
gatewayStatusMigration is a command that get migration status
5 properties
signPKCS1
object
signPKCS1 is a command that calculates the signature of hashed data using RSASSA-PKCS1-V15-SIGN from RSA PKCS1 v1.5.
7 properties 1 required
gatewayMigratePersonalItemsOutput
object
1 property
RotatedSecretOutput
object
1 property
ListAuthMethodsOutput
object
2 properties
gatewayCreateProducerArtifactory
object
gatewayCreateProducerArtifactory is a command that creates artifactory producer
14 properties 3 required
ExtKeyUsage
integer
Each of the ExtKeyUsage constants define a unique action.
verifyJWTOutput
object
1 property
gatewayListProducers
object
gatewayListProducers is a command that returns producer
3 properties
updateSSHCertIssuer
object
20 properties 4 required
listItems
object
11 properties
getKubeExecCredsOutput
object
3 properties
RoleAuthMethodAssociation
object
RoleAuthMethodAssociation includes details of an association between a role and an auth method.
5 properties
gatewayUpdateProducerPingOutput
object
1 property
createAuthMethodHuawei
object
createAuthMethodHuawei is a command that creates a new auth method that will be able to authenticate using Huawei credentials.
16 properties 1 required
encryptGPGOutput
object
1 property
AWSPayload
object
3 properties
Producer
object
6 properties
gatewayUpdateProducerRedshiftOutput
object
1 property
gatewayStopProducer
object
gatewayStopProducer is a command that stops producer
4 properties 1 required
gatewayStartProducerOutput
object
1 property
GCPAccessRules
object
8 properties
verifyGPG
object
8 properties 2 required
describeSubClaims
object
describe-sub-claims Get the sub-claims associated with the provided token or authentication profile
3 properties
kmipDeleteClientOutput
object
signGPGOutput
object
1 property
getRSAPublic
object
getRSAPublic is a command that obtains the public key from a specific RSA private key.
4 properties 1 required
ReverseRBACOutput
object
1 property
KMIPEnvironmentCreateResponse
object
2 properties
gatewayUpdateProducerMySQL
object
gatewayUpdateProducerMySQL is a command that updates mysql producer
24 properties 1 required
AzureKeyVaultMigration
object
2 properties
decryptPKCS1Output
object
1 property
gatewayDeleteSubAdminsOutput
object
updateAccountSettingsOutput
object
1 property
updateEventForwarder
object
13 properties 1 required
KMIPClient
object
6 properties
decryptPKCS1
object
7 properties 2 required
getKubeExecCreds
object
getKubeExecCreds is a command that gets credentials for authentication with Kubernetes cluster based on a PKI cert issuer.
11 properties 1 required
gatewayCreateProducerCustom
object
15 properties 3 required
gatewayCreateProducerLdap
object
gatewayCreateProducerLdap is a command that creates ldap producer
17 properties 1 required
gatewayUpdateProducerLdapOutput
object
1 property
createCertificateOutput
object
1 property
ActiveDirectoryPayload
object
15 properties
gatewayCreateProducerEks
object
gatewayCreateProducerEks is a command that creates eks producer
21 properties 1 required
HashiPayload
object
4 properties
K8SPayload
object
9 properties
uidListChildren
object
uidListChildren is a command that lists child token ids of Akeyless Universal Identity.
4 properties
assocRoleAuthMethod
object
assocRoleAuthMethod is a command that creates an association between role and auth method.
7 properties 2 required
gatewayDeleteProducer
object
gatewayDeleteProducer is a command that deletes producer
4 properties 1 required
gatewayCreateProducerSnowflake
object
GatewayCreateProducerSnowflakeCmd is a command that creates a Snowflake producer
16 properties 1 required
updateAuthMethodOutput
object
1 property
verifyPKICertOutput
object
1 property
getSSHCertificateOutput
object
2 properties
CreateClassicKeyOutput
object
3 properties
gatewayUpdateProducerAwsOutput
object
1 property
AllowedAccess
object
9 properties
getAccountSettings
object
3 properties
CFConfigPart
object
1 property
gatewayCreateProducerMongo
object
gatewayCreateProducerMongo is a command that creates either mongodb producer or mongodb atlas producer
25 properties 1 required
GetTargetDetailsOutput
object
2 properties
kmipSetServerState
object
kmipSetServerState is a command that sets the environment state to active/inactive.
4 properties 1 required
createDynamicSecret
object
9 properties 1 required
createAzureTarget
object
14 properties 1 required
GatewayUpdateTlsCert
object
gatewayUpdateTlsCert is a command that updates Gateway TLS certificate
5 properties
createTokenizerOutput
object
1 property
updateRotationSettings
object
updateRotationSettings is a command that updates rotations settings of an existing key
6 properties 2 required
GeneralConfigPart
object
11 properties
PasswordPolicyInfo
object
5 properties
LogzIoLogForwardingConfig
object
2 properties
deleteTargetAssociationOutput
object
gatewayUpdateProducerPostgreSQLOutput
object
1 property
shareItem
object
9 properties 2 required
createGcpTargetOutput
object
1 property
createAWSTarget
object
12 properties 1 required
updateAuthMethodAWSIAM
object
updateAuthMethodAWSIAM is a command that updates a new Auth Method that will be able to authenticate using AWS IAM credentials.
18 properties 2 required
ObjectVersionSettingsOutput
object
2 properties
signPKICertWithClassicKey
object
19 properties 4 required
LeadershipConfigPart
object
1 property
gatewayGetLdapAuthConfig
object
gatewayGetLdapAuth is a command that gets ldap auth config
3 properties
CreateRotatedSecretOutput
object
1 property
getRotatedSecretValue
object
6 properties 1 required
SystemAccessCredsSettings
object
SystemAccessCredsSettings describes system access credential settings for account by minutes
3 properties
gatewayUpdateItemOutput
object
1 property
createCertificate
object
12 properties 1 required
staticCredsAuth
object
staticCredsAuth is a command that creates a temporary access profile using the provided static credentials.
4 properties
CertificateChainInfo
object
3 properties
updateRabbitMQTargetDetails
object
10 properties 1 required
createAuthMethodAzureAD
object
createAuthMethodAzureAD is a command that creates a new auth method that will be able to authenticate using Azure Active Directory credentials.
21 properties 2 required
GetCertificateValueOutput
object
2 properties
SAMLAccessRules
object
5 properties
tokenizeOutput
object
2 properties
validateToken
object
validate-token is a command that validaties token
2 properties
updateNativeK8STargetOutput
object
1 property
TokenizerInfo
object
1 property
gatewayCreateProducerRedshift
object
gatewayCreateProducerRedshift is a command that creates redshift producer
18 properties 1 required
createAzureTargetOutput
object
1 property
gatewayMigratePersonalItems
object
gatewayMigratePersonalItems is a command that migrate personal items from external vault
11 properties
ConfigHash
object
17 properties
updateWebTargetDetails
object
8 properties 1 required
AuthMethod
object
9 properties
AzureADAccessRules
object
AzureADAccessRules contains access rules specific to Azure Active Directory authentication.
12 properties
GatewayMigrationDeleteOutput
object
1 property
getPKICertificateOutput
object
3 properties
gatewayUpdateProducerPostgreSQL
object
gatewayUpdateProducerPostgreSQL is a command that updates postgresql producer
23 properties 1 required
BastionsList
object
1 property
gatewayGetMigration
object
gatewayGetMigration is a command that get migration
4 properties
createAuthMethodOAuth2
object
createAuthMethodOAuth2 is a command that creates a new auth method that will be able to authenticate using Oauth2.
14 properties 3 required
validateTokenOutput
object
3 properties
MockPayload
object
1 property
gatewayListAllowedManagementAccess
object
gatewayListAllowedManagementAccess is a command that returns list sub admins
3 properties
CacheConfigPart
object
5 properties
gatewayMigrationListOutput
object
1 property
deleteAuthMethodOutput
object
1 property
TargetItemVersion
object
11 properties
createAuthMethod
object
9 properties 1 required
deleteItems
object
4 properties 1 required
gatewayUpdateK8SAuthConfig
object
gatewayUpdateK8SAuth is a command that updates k8s auth config
17 properties 5 required
createDBTarget
object
27 properties 2 required
deleteEventForwarderOutput
object
gatewayUpdateMigration
object
gatewayUpdateMigration is a command that update migration
49 properties 1 required
gatewayCreateProducerOracleDbOutput
object
1 property
OAuth2CustomClaim
object
OAuth2CustomClaim is a custom claim specific to OAuth2 authentication method.
2 properties
kmipRenewClientCertificateOutput
object
3 properties
kmipDeleteServer
object
kmipDeleteServer is a command that the kmip server (allowed only if it has no clients nor associated items)
3 properties
gatewayUpdateProducerSnowflakeOutput
object
1 property
KMIPConfigPart
object
4 properties
createLdapTarget
object
13 properties 4 required
updateAuthMethodAWSIAMOutput
object
uidRevokeToken
object
6 properties 2 required
OIDCAccessRules
object
OIDCAccessRules contains access rules specific to Open Id Connect authentication method.
10 properties
deleteTarget
object
6 properties 1 required
decryptWithClassicKeyOutput
object
1 property
kmipServerSetup
object
6 properties 1 required
rawCreds
object
2 properties
gatewayUpdateProducerRedshift
object
gatewayUpdateProducerRedshift is a command that updates redshift producer
19 properties 1 required
setItemStateOutput
object
updateAuthMethodSAML
object
updateAuthMethodSAML is a command that updates a new auth method that will be available to authenticate using SAML.
14 properties 2 required
NotiForwarder
object
20 properties
updateItemOutput
object
1 property
updateAuthMethodOIDCOutput
object
RotateKeyOutput
object
RotateKeyOutput defines output of RotateKey operation
4 properties
gatewayCreateProducerLdapOutput
object
1 property
createDockerhubTarget
object
9 properties 1 required
uidGenerateTokenOutput
object
1 property
Connect
object
Connect is a command that performs secure remote access
17 properties
listSharedItems
object
listSharedItems is a command to list all the items been shared
4 properties
gatewayCreateProducerArtifactoryOutput
object
1 property
updateEKSTarget
object
17 properties 6 required
gatewayDeleteK8SAuthConfig
object
gatewayDeleteK8SAuth is a command that deletes k8s auth config
4 properties 1 required
updateAuthMethodK8SOutput
object
1 property
gatewayUpdateProducerEks
object
gatewayUpdateProducerEks is a command that updates eks producer
22 properties 1 required
gatewayCreateProducerMSSQL
object
gatewayCreateProducerMSSQL is a command that creates mssql producer
21 properties 1 required
createAuthMethodK8S
object
createAuthMethodK8S is a command that creates a new auth method that will be able to authenticate using K8S.
15 properties 1 required
createGithubTarget
object
10 properties 1 required
gatewayCreateProducerDockerhubOutput
object
1 property
createKeyOutput
object
3 properties
EmailEntry
object
2 properties
gatewayUpdateK8SAuthConfigOutput
object
3 properties
MigrationStatusReplyObj
object
10 properties
uploadRSAOutput
object
GatewayMigrationUpdateOutput
object
1 property
AzurePayload
object
4 properties
verifyJWTWithClassicKey
object
7 properties 4 required
kmipDescribeClient
object
5 properties
gatewayUpdateProducerAzure
object
gatewayUpdateProducerAzure is a command that updates azure producer
25 properties 1 required
Role
object
8 properties
createWebTargetOutput
object
1 property
moveObjectsOutput
object
K8SAuthsConfigPart
object
1 property
detokenizeOutput
object
1 property
gatewayUpdateProducerCertificateAutomation
object
gatewayUpdateProducerCertificateAutomation is a command that updates a Certificate Automation dynamic secret producer to dynamically update certificates genera…
25 properties 1 required
gatewayUpdateProducerDockerhub
object
gatewayUpdateProducerDockerhub is a command that updates a DOCKERHUB producer
13 properties 1 required
gatewayUpdateProducerGithubOutput
object
1 property
detokenize
object
detokenize is a command that decrypts text with a tokenizer
6 properties 2 required
SSHCertificateIssueDetails
object
8 properties
gatewayUpdateProducerSnowflake
object
GatewayUpdateProducerSnowflakeCmd is a command that updates a Snowflake producer
17 properties 1 required
kmipClientDeleteRule
object
6 properties 1 required
gatewayUpdateProducerGithub
object
gatewayUpdateProducerGithub is a command that updates github producer
14 properties 1 required
deleteRole
object
4 properties 1 required
createEKSTargetOutput
object
1 property
KubernetesAccessRules
object
7 properties
createWebTarget
object
8 properties 1 required
GwClusterIdentity
object
12 properties
gatewayCreateProducerRabbitMQ
object
gatewayCreateProducerRabbitMQ is a command that creates rabbitmq producer
22 properties 1 required
updateRabbitMQTargetOutput
object
1 property
PathRule
object
9 properties
MockMigration
object
2 properties
gatewayCreateProducerAws
object
gatewayCreateProducerAws is a command that creates aws producer
27 properties 1 required
gatewayCreateK8SAuthConfigOutput
object
3 properties
createGithubTargetOutput
object
1 property
updateSSHTargetOutput
object
1 property
createSalesforceTarget
object
17 properties 5 required
GetPKICertificate
object
11 properties 1 required
DescribePermissionsOutput
object
1 property
gatewayUpdateProducerCassandraOutput
object
1 property
createAuthMethodGCP
object
createAuthMethodGCP is a command that creates a new auth method that will be able to authenticate using GCP IAM Service Account credentials or GCE instance cre…
17 properties 3 required
gatewayCreateProducerCustomOutput
object
1 property
createAuthMethodLDAPOutput
object
2 properties
decryptGPG
object
9 properties 2 required
updateAssoc
object
updateAssoc is a command that updates the sub-claims of an association between role and auth method.
6 properties 1 required
GetAccountSettingsCommandOutput
object
10 properties
AuthMethodRoleAssociation
object
AuthMethodRoleAssociation includes details of an association between an auth method and a role.
5 properties
CertAccessRules
object
9 properties
updateSSHTargetDetails
object
13 properties 1 required
GetSecretValue
object
8 properties 1 required
createRabbitMQTargetOutput
object
1 property
createRabbitMQTarget
object
10 properties 1 required
gatewayCreateProducerRedshiftOutput
object
1 property
gatewayUpdateProducerMySQLOutput
object
1 property
auth
object
18 properties
AccountObjectVersionSettingsOutput
object
2 properties
gatewayUpdateProducerGke
object
gatewayUpdateProducerGke is a command that updates gke producer
20 properties 1 required
UpdatePKICertIssuer
object
28 properties 3 required
updateGithubTarget
object
13 properties 1 required
updateAzureTargetOutput
object
1 property
uidRevokeTokenOutput
object
deleteItemsOutput
object
1 property
Name
object
Name represents an X.509 distinguished name. This only includes the common elements of a DN. Note that Name is only an approximation of the X.509 structure. If…
6 properties
deleteTargetAssociation
object
deleteTargetAssociation is a command that deletes an association between target and item.
6 properties 1 required
createSalesforceTargetOutput
object
1 property
LastStatusInfo
object
2 properties
deleteTargets
object
5 properties 1 required
createPingTargetOutput
object
1 property
gatewayCreateProducerPostgreSQL
object
gatewayCreateProducerPostgreSQL is a command that creates postgresql producer
22 properties 1 required
tokenize
object
tokenize is a command that encrypts text with a tokenizer
6 properties 2 required
gatewayUpdateProducerGcp
object
gatewayUpdateProducerGcp is a command that updates a GCP producer
17 properties 2 required
Rotator
object
5 properties
SmInfo
object
2 properties
updateAuthMethodUniversalIdentityOutput
object
updateAuthMethod
object
10 properties 1 required
UniversalIdentityDetails
object
3 properties
gatewayDeleteProducerOutput
object
1 property
CreateTargetItemAssocOutput
object
CreateTargetItemAssocOutput defines output of CreateTargetItemAssoc operation.
1 property
OAuth2AccessRules
object
OAuth2AccessRules contains access rules specific to OAuth2 authentication method.
6 properties
updateAuthMethodLDAPOutput
object
1 property
updateEventForwarderOutput
object
deleteRoleOutput
object
deleteAuthMethodsOutput
object
1 property
createKey
object
createKey is a command that creates a new key. [Deprecated: Use command create-dfc-key]
11 properties 2 required
createAuthMethodOIDC
object
createAuthMethodOIDC is a command that creates a new auth method that will be available to authenticate using OIDC.
17 properties 2 required
signPKCS1Output
object
1 property
SecureRemoteAccess
object
28 properties
rotateSecret
object
4 properties 1 required
createSSHCertIssuer
object
19 properties 4 required
updateAuthMethodSAMLOutput
object
ExportClassicKeyOutput
object
2 properties
deleteRoleRule
object
6 properties 2 required
DataProtectionSection
object
We need the fields to be pointers as we use the same struct for partial updates as well
1 property
UIDTokenDetails
object
10 properties
MigrationItems
object
4 properties
updateSalesforceTargetOutput
object
1 property
gatewayCreateProducerCertificateAutomationOutput
object
1 property
gatewayUpdateProducerCertificateAutomationOutput
object
1 property
createEventForwarder
object
17 properties 4 required
createDynamicSecretOutput
object
gatewayCreateProducerPingOutput
object
1 property
getRSAPublicOutput
object
3 properties
gatewayCreateProducerRabbitMQOutput
object
1 property
OIDCCustomClaim
object
OIDCCustomClaim is a custom claim specific to OIDC authentication method.
2 properties
updatePKICertIssuerOutput
object
1 property
gatewayCreateProducerHanaDb
object
gatewayCreateProducerHanaDb is a command that creates hanadb producer
21 properties 1 required
uidRotateToken
object
uidRotateToken is a command that rotates an Akeyless Universal Identity token.
5 properties
gatewayUpdateProducerCassandra
object
gatewayUpdateProducerCassandra is a command that updates a Cassandra producer
15 properties 1 required
Duration
integer
A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to appro…
ClassicKeyDetailsInfo
object
11 properties
revokeCredsOutput
object
rollbackSecret
object
5 properties 2 required
decryptGPGOutput
object
1 property
PKICertificateIssueDetails
object
22 properties
kmipDeleteClient
object
5 properties
updateAuthMethodAzureAD
object
updateAuthMethodAzureAD is a command that updates a new auth method that will be able to authenticate using Azure Active Directory credentials.
22 properties 2 required
createAuthMethodHuaweiOutput
object
1 property
VaultlessTokenizerInfo
object
6 properties
listRoles
object
5 properties
Rules
object
2 properties
updateRoleOutput
object
1 property
createLdapTargetOutput
object
1 property
updatePingTargetOutput
object
gatewayGetConfig
object
gatewayGetConfig is a command that returns gateway configuration
3 properties
signJWTWithClassicKey
object
7 properties 4 required
kmipMoveServer
object
kmipMoveServer is a command that Moves the root location of the kmip server and all associated items to a new root location
4 properties
ClassicKeyTargetInfo
object
5 properties
gatewayRevokeTmpUsers
object
gatewayRevokeTmpUsers is a command that revoke producer tmp user
8 properties 2 required
UpdateSecretValOutput
object
1 property
createEventForwarderOutput
object
1 property
RequiredActivity
object
1 property
updateGcpTargetOutput
object
1 property
AttributeTypeAndValue
object
AttributeTypeAndValue mirrors the ASN.1 structure of the same name in RFC 5280, Section 4.1.2.4.
2 properties
deleteRolesOutput
object
createSSHTargetOutput
object
1 property
kmipRenewServerCertificateOutput
object
1 property
gatewayGetTmpUsers
object
gatewayGetTmpUsers is a command that returns gateway configuration
4 properties 1 required
AWSIAMAccessRules
object
8 properties
gatewayCreateProducerGkeOutput
object
1 property
K8SAuthsConfigLastChange
object
3 properties
RuleAssigner
object
2 properties
LdapConfigPart
object
14 properties
deleteTargetOutput
object
gatewaySyncMigration
object
gatewaySyncMigration is a command that sync migration
5 properties 1 required
MigrationStatus
object
3 properties
K8SAuth
object
16 properties
K8SMigration
object
2 properties
LogForwardingConfigPart
object
13 properties
gatewayCreateProducerHanaDbOutput
object
1 property
MigrationsConfigLastChange
object
3 properties
updateTarget
object
7 properties 1 required
gatewayUpdateTmpUsers
object
gatewayUpdateTmpUsers is a command that returns gateway configuration
6 properties 3 required
gatewayUpdateProducerArtifactory
object
gatewayUpdateProducerArtifactory is a command that updates artifactory producer
15 properties 3 required
createPKICertIssuerOutput
object
1 property
deleteRoleAssociation
object
deleteRoleAssociation is a command that deletes an association between role and auth method.
4 properties 1 required
deleteRoleRuleOutput
object
2 properties
CreateRoleAuthMethodAssocOutput
object
CreateRoleAuthMethodAssocOutput defines output of CreateRoleAuthMethodAssoc operation.
1 property
decryptOutput
object
1 property
createEKSTarget
object
14 properties 6 required
updateDBTarget
object
30 properties 2 required
updateAWSTargetDetails
object
11 properties 1 required
verifyPKCS1Output
object
gatewayCreateProducerAzure
object
gatewayCreateProducerAzure is a command that creates azure producer
24 properties 1 required
gatewayCreateProducerEksOutput
object
1 property
gatewayGetK8SAuthConfigOutput
object
16 properties
kmipDescribeServerOutput
object
6 properties
GetSubAdminsListReplyObj
object
1 property
updateDBTargetOutput
object
1 property
getRole
object
4 properties 1 required
createAuthMethodOIDCOutput
object
1 property
DSProducerDetails
object
202 properties
uploadRSA
object
14 properties 2 required
signPKICertOutput
object
1 property
ItemGeneralInfo
object
12 properties
createArtifactoryTargetOutput
object
1 property
GatewayUpdateLdapAuthConfig
object
gatewayUpdateLdapAuth is a command that updates ldap auth config
16 properties
gatewayUpdateProducerRdpOutput
object
1 property
LogstashLogForwardingConfig
object
2 properties
gatewayDeleteMigration
object
gatewayDeleteMigration is a command that delete migration
4 properties 1 required
getTags
object
4 properties 1 required
KMIPServer
object
7 properties
EmailPassAccessRules
object
3 properties
getTargetDetails
object
6 properties 1 required
Target
object
17 properties
moveObjects
object
6 properties 2 required
kmipRenewClientCertificate
object
5 properties
AuthMethodAccessInfo
object
20 properties
listGateways
object
3 properties
describeItem
object
7 properties 1 required
gatewayDeleteK8SAuthConfigOutput
object
3 properties
gatewayUpdateProducerOracleDbOutput
object
1 property
gatewayUpdateProducerRdp
object
gatewayUpdateProducerRdp is a command that updates rdp producer
23 properties 1 required
gatewayCreateProducerOracleDb
object
gatewayCreateProducerOracleDb is a command that creates oracle db producer
21 properties 1 required
setItemState
object
6 properties 2 required
updateAccountSettings
object
21 properties
gatewayMigrationGetOutput
object
1 property
updateGcpTarget
object
12 properties 1 required
gatewayCreateProducerMSSQLOutput
object
1 property
SAMLAttribute
object
2 properties
updateRDPTargetDetails
object
11 properties 1 required
createNativeK8STargetOutput
object
1 property
updateAzureTarget
object
17 properties 1 required
verifyPKICertWithClassicKey
object
6 properties 3 required
setRoleRule
object
8 properties 3 required
GetProducersListReplyObj
object
2 properties
gatewayCreateProducerMySQLOutput
object
1 property
updateRotatedSecret
object
updateRotatedSecret is a command that updates rotated secret. [Deprecated: Use gateway-update-item command]
41 properties 1 required
createGKETarget
object
13 properties 1 required
CreateSecretOutput
object
1 property
RegexpTokenizerInfo
object
RegexpTokenizerInfo represents a general Regexp tokenization template
4 properties
gatewayUpdateProducerNativeK8S
object
gatewayUpdateProducerNativeK8S is a command that updates k8s producer
23 properties 1 required
deleteAuthMethods
object
deleteAuthMethods is a command that deletes multiple auth methods from a given path.
4 properties 1 required
listAuthMethods
object
listAuthMethods is a command that returns a list of all auth methods in the account.
6 properties
createAuthMethodUniversalIdentity
object
createAuthMethodUniversalIdentity is a command that creates a new auth method that will be able to authenticate using Akeyless Universal Identity.
12 properties 1 required
gatewayGetK8SAuthConfig
object
gatewayGetK8SAuth is a command that gets k8s auth config
4 properties 1 required
updateSSHCertIssuerOutput
object
1 property
GatewayMessageQueueInfo
object
3 properties
createAuthMethodSAML
object
createAuthMethodSAML is a command that creates a new auth method that will be available to authenticate using SAML.
13 properties 2 required
verifyPKCS1
object
8 properties 3 required
createAuthMethodGCPOutput
object
1 property
updateAuthMethodCertOutput
object
1 property
gatewayCreateProducerCassandraOutput
object
1 property
gatewayUpdateProducerGkeOutput
object
1 property
gatewayCreateProducerGcp
object
gatewayCreateProducerGcp is a command that creates a GCP producer
16 properties 2 required
KMIPClientGetResponse
object
1 property
rollbackSecretOutput
object
2 properties
CertificateExpirationEvent
object
1 property
GatewayMigrationCreateOutput
object
1 property
encrypt
object
9 properties 1 required
DynamicSecretProducerInfo
object
DynamicSecretProducerInfo The dynamic secret producer info This parameter relevant and required only in case of create update dynamic secret.
6 properties
staticCredsAuthOutput
object
1 property
gatewayUpdateProducerAws
object
gatewayUpdateProducerAws is a command that Updates aws producer
28 properties 1 required
refreshKeyOutput
object
1 property
ActiveDirectoryMigration
object
2 properties
updateNativeK8STarget
object
13 properties 4 required
RotatorsConfigPart
object
1 property
APIKeyAccessRules
object
2 properties
updateAuthMethodLDAP
object
updateAuthMethodLDAP is a command that updates a new auth method that will be able to authenticate using LDAP.
13 properties 1 required
deleteItem
object
8 properties 1 required
CreatePKICertIssuer
object
27 properties 3 required
requestAccess
object
7 properties 2 required
gatewayUpdateProducerLdap
object
gatewayUpdateProducerLdap is a command that updates ldap producer
18 properties 1 required
gatewayUpdateItem
object
gatewayUpdateItem is a command that updates classic key
24 properties 2 required
ItemTargetAssociation
object
ItemTargetAssociation includes details of an association between an item and a target.
5 properties
uidCreateChildToken
object
uidCreateChildToken is a command that creates a new child token using Akeyless Universal Identity.
10 properties
getEventForwarder
object
4 properties 1 required
gatewayUpdateProducerOracleDb
object
gatewayUpdateProducerOracleDb is a command that updates oracle db producer
22 properties 1 required
ElasticsearchLogForwardingConfig
object
8 properties
GCPSecretsMigration
object
2 properties
updateGithubTargetOutput
object
1 property
updateRole
object
11 properties 1 required
configure
object
11 properties
AzureLogAnalyticsForwardingConfig
object
2 properties
createDBTargetOutput
object
1 property
EmailTokenizerInfo
object
EmailTokenizerInfo represents a tokenizer that specifically tokenizes emails
3 properties
createAuthMethodAWSIAM
object
createAuthMethodAWSIAM is a command that creates a new Auth Method that will be able to authenticate using AWS IAM credentials.
17 properties 2 required
createArtifactoryTarget
object
10 properties 4 required
updateTargetDetails
object
1 property
CertificateIssueInfo
object
4 properties
createSecret
object
25 properties 2 required
gatewayListMigration
object
gatewayListMigration is a command that list migration
3 properties
gatewayUpdateProducerDockerhubOutput
object
1 property
updateArtifactoryTargetOutput
object
1 property
GatewayMigrationSyncOutput
object
1 property
encryptGPG
object
8 properties 2 required
encryptOutput
object
1 property
CreateClassicKey
object
CreateClassicKey is a command that creates classic key
13 properties 2 required
createRotatedSecret
object
44 properties 3 required
updateAuthMethodGCPOutput
object
TargetTypeDetailsInput
object
100 properties
getAuthMethod
object
4 properties 1 required
gatewayUpdateProducerArtifactoryOutput
object
1 property
clientData
object
3 properties
ReverseRBACClient
object
2 properties
SystemAccessCredentialsReplyObj
object
5 properties
gatewayCreateProducerMongoOutput
object
1 property
EventType
string
gatewayStartProducer
object
gatewayStartProducer is a command that starts producer
4 properties 1 required
JSONError
object
1 property
updateCertificateValue
object
8 properties 1 required
updateAuthMethodCert
object
updateAuthMethodCert is a command that updates a new auth method that will be able to authenticate using a client certificae
19 properties 2 required
createGKETargetOutput
object
1 property
createAuthMethodOutput
object
3 properties
ExportClassicKey
object
ExportClassicKey is a command that returns the classic key material
6 properties 1 required
gatewayCreateProducerGcpOutput
object
1 property
AdminsConfigPart
object
1 property
ClassicKeyPurpose
string
ClassicKeyPurpose defines purpose for classic keys
createAuthMethodK8SOutput
object
2 properties
deleteRoles
object
4 properties 1 required
StaticSecretDetailsInfo
object
3 properties
updateAuthMethodAzureADOutput
object
TmpUserData
object
7 properties
gatewayCreateProducerCertificateAutomation
object
gatewayCreateProducerCertificateAutomation is a command that creates a Certificate Automation dynamic secret producer to dynamically create certificates genera…
24 properties 1 required
createAuthMethodLDAP
object
createAuthMethodLDAP is a command that creates a new auth method that will be able to authenticate using LDAP.
12 properties 1 required
updateAuthMethodOIDC
object
updateAuthMethodOIDC is a command that updates a new auth method that will be available to authenticate using OIDC.
18 properties 2 required
createAWSTargetOutput
object
1 property
createAuthMethodAWSIAMOutput
object
1 property
updateLdapTarget
object
16 properties 1 required
uidCreateChildTokenOutput
object
1 property
createAuthMethodCertOutput
object
1 property
kmipRenewServerCertificate
object
3 properties
setRoleRuleOutput
object
createAuthMethodCert
object
createAuthMethodCert is a command that creates a new auth method that will be able to authenticate using a client certificae
18 properties 2 required
GatewaysListResponse
object
GatewaysListResponse Gateway cluster identity list
1 property
encryptWithClassicKey
object
6 properties 3 required
MigrationsConfigPart
object
8 properties
updateLdapTargetDetails
object
13 properties 1 required
decryptWithClassicKey
object
6 properties 3 required
updateItem
object
36 properties 1 required
deleteRoleAssociationOutput
object
ConfigChange
object
5 properties
updateRabbitMQTarget
object
13 properties 1 required
ExternalKMSKeyId
object
2 properties
SplunkLogForwardingConfig
object
5 properties
gatewayUpdateProducerGcpOutput
object
1 property
createAuthMethodOAuth2Output
object
1 property
gatewayUpdateProducerHanaDb
object
gatewayUpdateProducerHanaDb is a command that updates hanadb producer
22 properties 1 required
updateSalesforceTarget
object
20 properties 5 required
listTargets
object
6 properties
gatewayUpdateProducerMSSQLOutput
object
1 property
TargetItemAssociation
object
TargetItemAssociation includes details of an association between a target and an item.
6 properties
getDynamicSecretValue
object
8 properties 1 required
createDFCKey
object
11 properties 2 required
gatewayUpdateProducerRabbitMQ
object
gatewayUpdateProducerRabbitMQ is a command that updates rabbitmq producer
23 properties 1 required
getSSHCertificate
object
8 properties 2 required
updateAuthMethodOAuth2Output
object
LDAPAccessRules
object
4 properties
ListRolesOutput
object
2 properties
gatewayUpdateProducerEksOutput
object
1 property
gatewayUpdateProducerCustom
object
16 properties 3 required
kmipDeleteServerOutput
object
AwsS3LogForwardingConfig
object
6 properties
gatewayCreateProducerDockerhub
object
gatewayCreateProducerDockerhub is a command that creates a DOCKERHUB producer
12 properties 1 required
createRoleOutput
object
gatewayCreateProducerPing
object
gatewayCreateProducerPing is a command that creates ping producer
25 properties 1 required
updateSecretVal
object
14 properties 2 required
Extension
object
3 properties
ClassicKeyStatusInfo
object
4 properties
gatewayGetLdapAuthConfigOutput
object
14 properties
decrypt
object
decrypt is a command that decrypts ciphertext into plaintext by using an AES key.
9 properties 1 required
gatewayUpdateProducerMongo
object
gatewayUpdateProducerMongo is a command that updates either mongodb producer or mongodb atlas producer
26 properties 1 required
BastionListEntry
object
7 properties
updateRotatedSecretOutput
object
1 property
gatewayCreateProducerAzureOutput
object
1 property
createAuthMethodSAMLOutput
object
1 property
createPingTarget
object
12 properties 1 required
assocTargetItem
object
assocTargetItem is a command that creates an association between target and item.
16 properties 2 required
updateCertificateOutput
object
1 property
CustomerFullAddress
object
4 properties
kmipListClients
object
3 properties
gatewayCreateProducerGithub
object
gatewayCreateProducerGithub is a command that creates github producer
13 properties 1 required
DatadogForwardingConfig
object
5 properties
getTarget
object
5 properties 1 required
updateAuthMethodGCP
object
updateAuthMethodGCP is a command that updates a new auth method that will be able to authenticate using GCP IAM Service Account credentials or GCE instance cre…
18 properties 3 required
deleteAuthMethod
object
4 properties 1 required
KMIPClientListResponse
object
1 property
ProducersConfigPart
object
1 property
gatewayCreateProducerCassandra
object
gatewayCreateProducerCassandra is a command that creates a Cassandra producer
14 properties 1 required
OnePasswordMigration
object
2 properties
updateGKETargetOutput
object
1 property
createNativeK8STarget
object
10 properties 4 required
ListTargetsOutput
object
2 properties
createSSHCertIssuerOutput
object
1 property
updateWebTargetOutput
object
1 property
gatewayStopProducerOutput
object
1 property
createRole
object
10 properties 1 required
DeleteItemOutput
object
4 properties
kmipSetServerStateOutput
object
1 property
requestAccessOutput
object
1 property
createAuthMethodUniversalIdentityOutput
object
1 property
gatewayCreateProducerAwsOutput
object
1 property
gatewayCreateProducerRdpOutput
object
1 property
MigrationGeneral
object
7 properties
LastConfigChange
object
2 properties
updatePingTarget
object
15 properties 1 required
gatewayUpdateProducerRabbitMQOutput
object
1 property
createTokenizer
object
createTokenizer is a command that creates a tokenizer item
16 properties 3 required
AkeylessGatewayConfig
object
16 properties
refreshKey
object
4 properties 1 required
verifyGPGOutput
object
createDockerhubTargetOutput
object
1 property
gatewayUpdateProducerPing
object
gatewayUpdateProducerPing is a command that updates Ping producer
26 properties 1 required
ImporterInfo
object
2 properties
updateDockerhubTargetOutput
object
1 property
kmipCreateClientOutput
object
3 properties
updateAuthMethodK8S
object
updateAuthMethodK8S is a command that updates a new auth method that will be able to authenticate using K8S.
16 properties 1 required
updateGKETarget
object
16 properties 1 required
SyslogLogForwardingConfig
object
4 properties
ListItemsInPathOutput
object
3 properties
listSRABastions
object
4 properties
gatewayCreateProducerGke
object
gatewayCreateProducerGke is a command that creates gke producer
19 properties 1 required
updateAuthMethodUniversalIdentity
object
updateAuthMethodUniversalIdentity is a command that updates a new auth method that will be able to authenticate using Akeyless Universal Identity.
13 properties 1 required
gatewayGetProducer
object
gatewayGetProducer is a command that returns producer
4 properties 1 required
GatewayUpdateTlsCertOutput
object
1 property
gatewayUpdateProducerAzureOutput
object
1 property
updateSSHTarget
object
16 properties 1 required
getCertificateValue
object
5 properties 1 required
SraInfo
object
3 properties
configureOutput
object
2 properties
getEventForwarderOutput
object
1 property
gatewayUpdateProducerMongoOutput
object
1 property
OnePasswordPayload
object
5 properties
updateAssocOutput
object
HuaweiAccessRules
object
7 properties
describePermissions
object
describePermissions is a command that shows which permissions your have to a particular path.
5 properties 2 required
gatewayCreateProducerNativeK8S
object
gatewayCreateProducerNativeK8S is a command that creates k8s producer
22 properties 1 required
createAuthMethodAzureADOutput
object
1 property
updateArtifactoryTarget
object
13 properties 4 required
reverseRBAC
object
reverseRBAC is a command that shows which auth methods have access to a particular object.
5 properties 2 required
kmipDescribeServer
object
3 properties
kmipMoveServerOutput
object
2 properties
createSSHTarget
object
13 properties 1 required
gatewayCreateMigration
object
gatewayCreateMigration is a command that create migration
48 properties 2 required
updateAWSTarget
object
15 properties 1 required
CertificateInfo
object
23 properties
gatewayUpdateProducerHanaDbOutput
object
1 property
GCPPayload
object
1 property
gatewayCreateProducerGithubOutput
object
1 property
HashiMigration
object
2 properties
gatewayCreateProducerPostgreSQLOutput
object
1 property
AccountGeneralSettings
object
AccountGeneralSettings describes general settings for an account
3 properties
deleteEventForwarder
object
4 properties 1 required
updateDBTargetDetails
object
14 properties 1 required
deleteTargetsOutput
object
DefaultConfigPart
object
4 properties
updateTargetOutput
object
1 property
signJWTOutput
object
1 property
gatewayUpdateProducerMSSQL
object
gatewayUpdateProducerMSSQL is a command that updates mssql producer
22 properties 1 required
gatewayUpdateProducerNativeK8SOutput
object
1 property
AWSSecretsMigration
object
2 properties
ItemVersion
object
9 properties
updateWebTarget
object
11 properties 1 required
signGPG
object
8 properties 2 required
kmipClientSetRule
object
7 properties 2 required
connectOutput
object
updateEKSTargetOutput
object
1 property
Item
object
36 properties
UniversalIdentityAccessRules
object
3 properties
gatewayCreateProducerRdp
object
gatewayCreateProducerRdp is a command that creates rdp producer
22 properties 1 required
updateDockerhubTarget
object
12 properties 1 required
gatewayCreateProducerMySQL
object
gatewayCreateProducerMySQL is a command that creates mysql producer
23 properties 1 required
gatewayDeleteAllowedManagementAccess
object
gatewayDeleteAllowedManagementAccess is a command that deletes sub-admins
4 properties 1 required
GatewayUpdateLdapAuthConfigOutput
object
1 property
describeSubClaimsOutput
object
1 property
RotatedSecretDetailsInfo
object
RotatedSecretDetailsInfo The rotated secret rotator info
10 properties
uidRotateTokenOutput
object
1 property
AuthOutput
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

akeyless-v2-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Akeyless v2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.