Sign in
Index

Get site and API information

Get site and API information.

get/index/

Response

OK

version_idinteger

XenForo version ID

site_titlestring

Title of the site this API relates to

base_urlstring

The base URL of the XenForo install this API relates to

api_urlstring

The base API URL

key[type]string

Type of the API key accessing the API (guest, user or super)

key[user_id]integer nullable

If a user key, the ID of the user the key is for; null otherwise

key[allow_all_scopes]boolean

If true, all scopes can be accessed

key[scopes]string[]

A list of scopes this key can access (if not allowed to access all scopes)

Changes

Changed in 2 of the 7 revisions of this API.48

  • e271d0e41f6d5See the full diff
    • ○

      api operation id get_index_ removed and replaced with getIndex

      api-operation-id-removed

    • ○

      the endpoint scheme security XF-Api-Key was added to the API

      api-security-added

    • ○

      the endpoint scheme security XF-OAuth2 was added to the API

      api-security-added

    • ○

      added the new optional header request parameter XF-Api-User to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      added the new optional query request parameter api_bypass_permissions to all path's operations

      new-optional-request-default-parameter-to-existing-path

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fc0a40f3b85943See the full diff
    • ●

      the optional response header XF-Latest-Api-Version removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header XF-Request-User removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header XF-Request-User-Extras removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header XF-Used-Api-Version removed for the status 200

      optional-response-header-removed

    • ○

      api operation id getIndex removed and replaced with get_index_

      api-operation-id-removed

    • ○

      the endpoint scheme security XF-Api-Key was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security XF-OAuth2 was removed from the API

      api-security-removed

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog