GET /
get_root
The site's login configuration, answered without a token. Read user_authentication_method here before choosing a grant type.
API
Params
| part | value |
|---|---|
| path | /api/v1, the versioned root itself |
| auth | none needed |
Sample requests
r = c.get("/api/v1")
On the probed site:
{
"data": {
"shotgun_version": "v8.89.0.9724 (build 47ec49f)",
"api_version": "1.0",
"unified_login_flow_enabled": true,
"authentication_app_session_launcher_enabled": true,
"user_authentication_method": "oxygen",
"site_id": "<id>",
"site_name": "<site>",
"os": "Amazon Linux"
}
}
Response codes
| status | when |
|---|---|
| 200 | always |
Edge cases
user_authentication_methoddecides whether a human grant is available at all.oxygenon the probed site means the identity provider owns the login, sopasswordwill not work for a person there even though the token endpoint accepts the grant type.authentication_app_session_launcher_enabledtrue means a person can sign in without a script key:POST /internal_api/app_session_request, approved in a browser (probe 052). On the probed site it is the only grant a person has, becauseoxygenrefusespassword.shotgun_versionis the only version string the API exposes. Anything conditioned on server version reads it here rather than inferring it from behaviour.