How to locate the API v2 documentation bundled inside HipChat Server/Data Center

Still need help?

The Atlassian Community is here for you.

Ask the community

Platform notice: Server and Data Center only. This article only applies to Atlassian products on the Server and Data Center platforms.

Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

Due to the HipChat Cloud shutdown in February 2019, all references for the HipChat API v2 documentation will redirect to a migration page. This may be frustrating for HipChat Server and Data Center customers who have bookmarked these pages for reference.

However, the API v2 documentation is embedded within all HipChat Server/Data Center deployments.

How to access the API v2 documentation on your HipChat Server or Data Center.

There are two ways to access to the embedded API documentation - via the user profile page or via a direct URL.

Via your user profile (HipChat Server)

    • Log into your HipChat user account.

    • Select 'Edit Profile'.
    • In the left sidebar, select 'API Access'.
    • Enter in your password.
    • On the next page, select the link on the third sentence that says 'API version 2 documentation'.

Via your user profile (HipChat Data Center)

    • Log into your HipChat user account.

    • Select 'API Tokens' link on the top navigation.
    • Enter in your password.
    • On the next page, select the link on the third sentence that says 'API version 2 documentation'.

Via direct URL (HipChat Server and HipChat Data Center)


Last modified on Apr 3, 2019

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.