NGngrok
SSHCredentials

Create

Changed on

Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.

post/ssh_credentials

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/ssh_credentials
  • Auth
    HTTP bearer

Headers

ngrok-versioninteger required

Request body

descriptionstring

human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.

aclstring[]

optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

public_keystring required

the PEM-encoded public key of the SSH keypair that will be used to authenticate

owner_idstring

If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

Response

Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.

idstring

unique ssh credential resource identifier

uristring

URI of the ssh credential API resource

created_atstring

timestamp when the ssh credential was created, RFC 3339 format

descriptionstring

human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.

public_keystring

the PEM-encoded public key of the SSH keypair that will be used to authenticate

aclstring[]

optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

owner_idstring

If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

Changes