Githubconfig

Resource Fields

Writeable Fields

Field Type Create Update Default Notes
accessMode enum Yes - unrestricted The options are restricted, unrestricted, required.
allowedIdentities array[identity] Optional - -  
clientId string Optional - -  
clientSecret string Optional - -  
enabled boolean Optional - -  
hostname string Optional - -  
name string Optional Yes -  
scheme string Optional - -  


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: /v1/projects/${PROJECT_ID}/githubconfigs

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
-H 'Content-Type: application/json' \
-d '{
	"accessMode": "unrestricted",
	"allowedIdentities": "array[identity]",
	"clientId": "string",
	"clientSecret": "string",
	"enabled": false,
	"hostname": "string",
	"name": "string",
	"scheme": "string"
}' 'http://${RANCHER_URL}:8080/v1/projects/${PROJECT_ID}/githubconfigs'

UpdatePUT: /v1/projects/${PROJECT_ID}/githubconfigs/${ID}

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X PUT \
-H 'Content-Type: application/json' \
-d '{
	"name": "string"
}' 'http://${RANCHER_URL}:8080/v1/projects/${PROJECT_ID}/githubconfigs/${ID}'
Edit this page