User Authenticator

This authentication scheme is used when Natterly users wish to authenticate with the API.

Authentication Headers

The following headers are used to identify yourself to the API client. These should be sent as standard HTTP headers with any API request.

Header Example


The API token for a user that you wish to authenticate with.



The errors listed below may be raised if any issues occur when verifying your identity with the API.

Error Attributes


The API token provided in X-API-Token was not valid.

  • token

    The token that was looked up


The associated account has been suspended

  • billing

    Whether or not the suspension is due to billing issues


The network you are accessing the API from is not permitted to access this account

  • ip

    The source IP