Type Alias: DeploymentSsh
ts
type DeploymentSsh = object;SSH key management for a deployment's jobs, under deployment.ssh.
Properties
add()
ts
add: (publicKeys) => Promise<DeploymentSshKeysResult>;Grant one or more OpenSSH public keys access. Keys already present are left as they are: a key is identified by its type and material, so a differing comment does not add it twice.
Parameters
| Parameter | Type |
|---|---|
publicKeys | string | string[] |
Returns
Promise<DeploymentSshKeysResult>
keys()
ts
keys: () => Promise<string[]>;The SSH public keys currently granted access to the deployment's jobs.
Returns
Promise<string[]>
remove()
ts
remove: (publicKeys) => Promise<DeploymentSshKeysResult>;Revoke one or more OpenSSH public keys. A key is identified by its type and material, so a differing comment still revokes it; access is removed from every running job at once, not only when a job restarts.
Parameters
| Parameter | Type |
|---|---|
publicKeys | string | string[] |