Introduction

Ngrok Rock is an API for storing ngrok domains.

Register

Getting Started

The easiest way to use Ngrok Rock is the command line client. With Node.js installed, run:

npm install -g ngrokrock

More detailed instructions can be found on npm.

Documentation

Authentication is done with an application password over basic auth. Go here to get an API key.

You can go to /domains/ to see a list of domains after you've added a least one. If there's only one domain you'll be redirected to it. Expired ngrok domains will be removed.

Domains

Resources related to domains.

Domains Collection

 List All Domains (/api/v1/domains)

Response  200
Headers
Content-Type: application/json
Body
[
  "fakedomain.ngrok.io"
]

 Create a New Domain (/api/v1/domains)

Add new domains. This endpoint supports posting domains as form data, or as query strings.

Response  201
Headers
Content-Type: application/json
Body
{
  "success": true
}