Skip to main content

Meet the Logz.io API

If you've never used the Logz.io API before—or any API, for that matter—the whoami endpoint is a great way to dip your toes in.

Unfortunately, Logz.io can't respond to whoami with existential answers, like who you really are and your purpose in life. But the good news is you'll receive a response with the account name.

You can use whoami to test connectivity with Logz.io or to confirm you're using an API token from the right account.

Finding the account name​

You can access the whoami endpoint with a simple curl request.

Sample request​

In the code block below:

  • Replace <<API-TOKEN>> with an API token from the account you want to use
  • Replace <<API-URL>> with your region’s base API URL. For more information on finding your account’s region, see Account region.
curl -X GET \
  https://<<API-URL>>/v2/whoami \
  -H 'Content-Type: application/json' \
  -H 'X-API-TOKEN: <<API-TOKEN>>'
Read More

This API endpoint is documented in Retrieve this account in the API docs.

...and the response​

{
  "accountId": 12345,
  "accountName": "Jean Valjean"
}

If you see a status of 200 and a response body that includes accountId and accountName, congratulations! 🎉 You just made your first API call.

If you didn't receive the expected response, continue to the troubleshooting steps below. 👇

Troubleshooting​

If you didn't receive the expected response, there could be a few reasons for that. Let's see if we can figure this out together.

1. Check the status code​

The status code indicates whether you sent the request to a valid Logz.io API endpoint.

If the status code is 200​

You sent the request to a valid endpoint. Continue to the next step.

If the status code is something else​

You might have sent the request to an invalid endpoint. Double-check the API URL, and make sure it matches an endpoint in the Logz.io [API docs

2. Check the response body​

Check the response body for an error message.

If you see {"code":403,"message":"Insufficient privileges"}​

You might be using an invalid API token. Copy a valid API token from Logz.io and try again.

If you see Account region xx differs from current server region yy​

You're using a valid API token, but you sent the request to the wrong account region. Change the API region to your account region and try again.

For more information on finding your account's region, see Account region.