Authentication - Polarix.io

Authenticate your account using your Polarix.io API user name and password to obtain a Polarix Authentication Token. Polarix limits the number of Authentication API calls based on the user name and the domain name used in the API call.

Request

Path Params

version

number

required

Target Polarix.io API version

Example:

Header Params

x-api-key

string

required

API Key generated from the Settings panel in Polarix.io

Example:

b062ab000e9456748b941cd5b1658899

string

required

application/json or application/xml

Example:

application/json

Body Params multipart/form-data

username

string

required

Example:

user@polarix.io

password

string

required

Example:

superSecretPassword1234@@

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success — JSON

application/json

Body

token

string

required

Authentication token needed for access to Polarix APIs

Example

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiZDNmYjk3OGI4Mzg5ZGRmYjczNjkyY2NhODExMWE2ZjdlZTEzOWRhMGRkY2FmNTUwZGI4ZTA3NDJmOWY4YzNkMzIzZTNlYWY5Nzc1MTYzNmEiLCJpYXQiOjE3MDc5MTk1MzAuODE0NTg1LCJuYmYiOjE3MDc5MTk1MzAuODE0NTg2LCJleHAiOjE3Mzk1NDE5MzAuODEyNDU5LCJzdWIiOiI3ODciLCJzY29wZXMiOltdfQ.VepDTAhM23Rn-NywwVelvhQouNOjm7pl1Bi2MXCK7d_YjO3xp8Sv1MN_NYdE7Gq7cDKredNe8uxeTnPaLnF4-7dRF37hv255wbzIasqRJvLgIg8WwjvYJpQ3nmvWPavj1xFW_uCsKPsnkrE21ZvpRrNypff9vHb9l6nwiSM8RKZLpOnGMbx7ozHz4KddA0nokhTxk2mO5hHwkDAZTCA6QKQCNSsm1ihRgK44MF55SOl91lr8Fq0K_NdjTQ4GZ1OCaiwNHqKyHeUSAdk6NPo_xw24_H6fxe5NkLTTf6PAByT1zMnl-z3F1zmCSza91BHPy4TeEZ6rZiFr83i1exfHumKCRO-dKxFGrXc4cczIOA1aWz17yHZLZKeUmG8bnan1NmGFY0Uj3NSJJC6Dut7Ep_c0emYixio1ci4g7PrixDYsQTN3WQe20rBf5JX4kNa091ajyQ_LGT4Th3Zj4eJRoMxBlj4ST0H4ZbfJ2DD-zv-6z5w-c0-bL21lejpINpLVV408U7HVX5cMYcdgYOVeQE8y4EE0Oj46MYftRKfRC5tqcEtRdmZfvZi2IlTKV9i0v1T6OXxjCjprXyy0Kqpnrk2SWeo4m03oiQXhwXfjAL8EYFbBbc0pHYsZ1GZHfLV71AHHaNMqLk1M2X88pPhM2vQXQYQxMU7Q-U-kgSjSGqE"
}

🟢200Success — XML

🟠401Unauthorized — JSON

🟠401Unauthorized — XML