Skip to main content
Use connection commands to create or confirm your connection with your Blnk Core instance before you run resource commands.

​
blnk connect

Point the CLI at a Core instance, store your API key locally, and confirm the instance responds before you run resource commands. Run this after install or whenever you switch environments (sandbox, staging, production). 
blnk connect [url]
Arguments
ArgumentTypeRequiredDescription
urlstringNoThe URL of the Blnk Core instance to connect to. Include the protocol (http or https).
Options
OptionTypeDescription
-h, --helpbooleanShow help for this command.
Usage Run the command with or without the URL argument. If the URL is not provided, the CLI prompts for it.
1

Enter the instance URL and API key

If you did not pass a URL argument, the CLI prompts for the instance URL, then the API key:
url >
api key >
Press Enter at the API key prompt to skip if your instance does not require a key.
2

Verify health

While the CLI checks connectivity, you see a spinner such as Testing connection health.
3

You're good to go!

Once done, the CLI prints the success or error message.
success:
  Successfully connected to "https://api.example.com"
If the API key is wrong, verify the key and run connect again.If the instance is unreachable, confirm it is running and reachable from your machine, then try again.

​
blnk info

Confirm which Core URL the CLI is using and whether the last health check succeeded, without re-entering credentials. Use it when a command fails with auth or connectivity errors and you need to verify you are on the right instance. 
blnk info
Options
OptionTypeDescription
-h, --helpbooleanShow help for this command.
Usage
1

Check connection status

Run the command to see which instance the CLI is configured to use:
blnk info
The CLI prints the current server connection and whether it is connected.
Current server connection:
  https://api.example.com [+] connected