Skip to main content

Required Authorization

All REST API requests must be sent over the secure HTTPS protocol. Also, each REST API implementation needs to authenticate with valid user credentials to obtain a session cookie. To get a session cookie, execute an Initiate User Session command with your credentials. The response includes a "calypso-session-id" cookie. All API requests must be made with a valid session cookie in the request header. Web browsers and browser-based REST tools should handle cookie management automatically. Browser-less interactions may require cookie headers to be manually managed.

To terminate the session, execute a Delete a User Session. You can check if a session exists or is valid with a Get User Session Info command. See Authentication Resources for more details on these commands.

Also, each API command listed in REST API Reference includes an "Authorizations" heading that lists the permission necessary to execute the command. If you make an API call using a login that is not authorized to execute the command, a 403 Forbidden error response is returned, which is described in Errors.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.