SSH Certificate Authorities

Do not construct this object directly, instead access the ssh_certificate_authorities property of an ngrok.Client object.

class ngrok.services.SSHCertificateAuthoritiesClient(client)[source]

An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

create(description='', metadata='', private_key_type='', elliptic_curve='', key_size=0)[source]

Create a new SSH Certificate Authority

Parameters
  • description (str) – human-readable description of this SSH Certificate Authority. optional, max 255 bytes.

  • metadata (str) – arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.

  • private_key_type (str) – the type of private key to generate. one of rsa, ecdsa, ed25519

  • elliptic_curve (str) – the type of elliptic curve to use when creating an ECDSA key

  • key_size (int) – the key size to use when creating an RSA key. one of 2048 or 4096

https://ngrok.com/docs/api#api-ssh-certificate-authorities-create

Return type

SSHCertificateAuthority

delete(id)[source]

Delete an SSH Certificate Authority

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete

get(id)[source]

Get detailed information about an SSH Certficate Authority

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-ssh-certificate-authorities-get

Return type

SSHCertificateAuthority

list(before_id=None, limit=None)[source]

List all SSH Certificate Authorities on this account

Parameters
  • before_id (Optional[str]) –

  • limit (Optional[str]) –

https://ngrok.com/docs/api#api-ssh-certificate-authorities-list

Return type

SSHCertificateAuthorityList

update(id, description=None, metadata=None)[source]

Update an SSH Certificate Authority

Parameters
  • id (str) –

  • description (Optional[str]) – human-readable description of this SSH Certificate Authority. optional, max 255 bytes.

  • metadata (Optional[str]) – arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.

https://ngrok.com/docs/api#api-ssh-certificate-authorities-update

Return type

SSHCertificateAuthority