Rancher 1.6 Docs

ExternalHandler

Resource Fields

Writeable Fields

Field Type Create Update Default Notes
description string Optional Yes -  
name string Optional Yes -  
priority int Optional Yes -  
processConfigs array[externalHandlerProcessConfig] Yes - -  
retries int Optional Yes -  
timeoutMillis int Optional Yes -  

Read Only Fields

Field Type Notes
data map[json]  
id int The unique identifier for the externalHandler


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}/externalHandlers

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
-H 'Content-Type: application/json' \
-d '{
	"description": "string",
	"name": "string",
	"priority": 0,
	"processConfigs": "array[externalHandlerProcessConfig]",
	"retries": 0,
	"timeoutMillis": 0
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/externalHandlers'

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

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

Actions

activate POST: /v2-beta/projects/${PROJECT_ID}/externalHandlers/${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}/externalHandlers/${ID}?action=activate'


Output: An updated copy of the externalHandler resource

deactivate POST: /v2-beta/projects/${PROJECT_ID}/externalHandlers/${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}/externalHandlers/${ID}?action=deactivate'


Output: An updated copy of the externalHandler resource

Edit this page