Authentication

Authentication is required to access the Halo Security API. This section details how to manage your account API keys and submit a request.

API Keys

The x-apikey header must be submitted with all requests to API endpoints.

To access and manage your account's API keys, please visit the Account/API section of the website at https://app.halosecurity.com/user/account/api

Example Request

To verify that your API key is properly configured, submit a curl request such as the following, replacing <APIKEY> with the one retrieved from your Account/API dashboard.

curl --header "x-apikey: <APIKEY>" https://api.halosecurity.com/api/v1/user/me.json

If everything is working properly, you should receive a JSON response like the one below:

{
    "user": {
        "role": 1,
        "user_id": 12345,
        "phone": "1-555-111-2222",
        "last_name": "Last",
        "title": "Title",
        "first_name": "First",
        "email": "[e-mail]"
    }
}

If you receive an authentication failure verify that you are using the correct API key, and contact Halo Security Support if you remain unable to submit a valid request.