addPublicKey method

Future<Operation> addPublicKey(AddPublicKeyRequest request, String environment, { String? $fields, })

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH.

If a key with the same content already exists, this will error with ALREADY_EXISTS.

request - The metadata request object.

Request parameters:

environment - Environment this key should be added to, e.g. users/me/environments/default. Value must have pattern ^users/\[^/\]+/environments/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Operation.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Operation> addPublicKey(
  AddPublicKeyRequest request,
  core.String environment, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$environment') + ':addPublicKey';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}