Configuration
Configure the CLI or REST API to use an API Key to access resources in Bindplane
Using your API Key with the CLI
You can set the API Key value in your configuration by using the bindplane profile
command. e.g.
This sets your "default" profile to use the API key you just received. You may also need to set your remote-url
to the correct endpoint, for app.bindplane.com users:
Make sure you are using the default
profile
Now verify you can retrieve resources, say Source Types
To set named profiles run
To use custom remote URLs run
Configure a profile
with a user and password
Using your API Key with the REST API
You can use your API with the REST API by setting the X-Bindplane-Api-Key
header. An example using curl with Bindplane Cloud: