Advanced API

Switch Profile

GET /profile/switch

Switches the profile

Query parameters

  • profileid string Required

    The id of the profile to switch to. This id can be retrieved using show with active=false

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 409 application/json

    Profile not found

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /profile/switch 
curl \
 --request GET 'http://localhost:1888/v2/api/profile/switch?profileid=string'
Response examples (200) 
{
  "Response": "Successfully switched profile",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (409) 
{
  "Response": "string",
  "Error": "No profile with specified id found!",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}