XExenforo-ltd
Index

Get site and API information

Changed on

Get site and API information.

get/index/

Request

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

  • e271d0e41f6dRevision changes
    • info

      api operation id get_index_ removed and replaced with getIndex

    • info

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

    • info

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

    • info

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

    • info

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

  • fc0a40f3b859Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      api operation id getIndex removed and replaced with get_index_

    • info

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

    • info

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