REST API - update

esx kms providers: update

Update an existing Key Provider.

Request:

HTTP request

PATCH https://{server}/api/esx/kms/providers/{provider}
{
    "key_server"{
        "proxy_server"{
            "hostname""string",
            "port"1
        },
        "description""string",
        "kmip_server"{
            "servers"[
                {
                    "address"{
                        "hostname""string",
                        "port"1
                    },
                    "name""string"
                },
                {
                    "address"{
                        "hostname""string",
                        "port"1
                    },
                    "name""string"
                }
            ],
            "username""string"
        },
        "type""KMIP",
        "connection_timeout"1
    },
    "master_key_id""string"
}

Path Parameters

Name Type Description
Required
provider string Identifier of the provider.

Body Parameters:

Name Type Description
bold = required
- update_spec Provider information.
-.master_key_id string Master key identifier created for the provider.

A unique Key identifier.

Optional. If unset, masterKeyId will remain unchanged.

-.key_server key_server_update_spec Key server associated with this provider.

Optional. If unset, key server configuration will remain unchanged.

-.key_server.type string Type of the key server.

Optional. If unset, key server type will remain unchanged.

-.key_server.description string Description of the key server.

Optional. If unset, description will remain unchanged.

-.key_server.proxy_server network_address Proxy server configuration.

Optional. If unset, proxy server configuration will remain unchanged.

-.key_server.proxy_server.hostname string The IP address or the hostname.

-.key_server.proxy_server.port long The port for the connection.

Optional. If unset, a default port depending on the server type will be used or 443 if it's not explicitly specified.

-.key_server.connection_timeout long Connection timeout in seconds.

Optional. If unset, connection timeout will remain unchanged..

-.key_server.kmip_server kmip_server_update_spec Key Server configuration detail for KMIP based KMS.

Optional. It is only relevant when type has value KMIP. If unset, KMIP server configuration will remain unchanged.

-.key_server.kmip_server.servers server[] List of KMIP compliant key servers.

Key Servers must be configured for active-active replication. If the server port is unset, a default value of 5696 will be used.

Optional. If unset, server configuration will remain unchanged.

-.key_server.kmip_server.servers[].name string Name of the server.

A unique string chosen by the client.

-.key_server.kmip_server.servers[].address network_address The server's address.

-.key_server.kmip_server.servers[].address.hostname string The IP address or the hostname.

-.key_server.kmip_server.servers[].address.port long The port for the connection.

Optional. If unset, a default port depending on the server type will be used or 443 if it's not explicitly specified.

-.key_server.kmip_server.username string Username for authentication.

Optional. If unset, username will remain unchanged.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code Type Description
400 invalid_argument if the spec is invalid.
404 not_found if the provider is not found.
401 unauthenticated if the caller is not authenticated.
403 unauthorized if the caller is not authorized.
500 error if any other error occurs.