X-API Keys
PlaceOS can generate API Keys for authenticated access.
The API keys can be used for:
- Administrator access to your PlaceOS Backoffice
- 1.Login to PlaceOS Backoffice
- 2.Navigate to the Admin Tab
- 3.
- 4.Select the domain the API Key will belong to
- 5.Any existing API Keys will be shown in the list
- 6.
- 7.Enter the required information:
- Name: Suitable name for the API Key
- Description: What the key will be used for (useful for other administrators)
- Scopes: Select from available scopes (see available scopes below)
- User: The user in which the API Key will emulate
- 8.Click Save
- 9.
Available Scopes for API Keys are:
public
A special scope that can access all routes (supports read and write modifiers)api_keys
ldap_authentication
saml_authentication
o_auth_authentication
o_auth_applications
brokers
cluster
domains
drivers
settings
modules
systems
control .read
: module class types, function list of a module, module state lookup.write
: control websocket, API execute requestedges
metadata
repositories
scope.read
scope.write
API Keys are typically passed in the header of the request, however can be used in the following ways
- 1.HTTP Header:
X-API-Key: <token>
- 2.URL param:
?api-key=<token>
- 3.A HTTP Cookie:
api-key=<token>
- 1.Navigate to the API Key Page in Backoffice located in the Admin Tab.
- 2.
Last modified 5mo ago