Rancher 1.6 Docs

UserPreference

Resource Fields

Writeable Fields

Field Type Create Update Default Notes
description string Optional Yes -  
name string Optional Yes -  
value string Optional Yes -  

Read Only Fields

Field Type Notes
all boolean  
data map[json]  
id int The unique identifier for the userPreference


Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.

Operations

CreatePOST: /v2-beta/projects/${PROJECT_ID}/userPreferences

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
-H 'Content-Type: application/json' \
-d '{
	"description": "string",
	"name": "string",
	"value": "string"
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/userPreferences'

DeleteDELETE: /v2-beta/projects/${PROJECT_ID}/userPreferences/${ID}

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X DELETE \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/userPreferences/${ID}'

UpdatePUT: /v2-beta/projects/${PROJECT_ID}/userPreferences/${ID}

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X PUT \
-H 'Content-Type: application/json' \
-d '{
	"description": "string",
	"name": "string",
	"value": "string"
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/userPreferences/${ID}'

Actions

activate POST: /v2-beta/projects/${PROJECT_ID}/userPreferences/${ID}?action=activate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/userPreferences/${ID}?action=activate'


Output: An updated copy of the userPreference resource

deactivate POST: /v2-beta/projects/${PROJECT_ID}/userPreferences/${ID}?action=deactivate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/userPreferences/${ID}?action=deactivate'


Output: An updated copy of the userPreference resource

Edit this page