These docs are for Rancher 1.6, if you are looking for Rancher 2.x docs, see
here .
RegistryCredential
A registry credential is used to authenticate against a registry .
Resource Fields
Writeable Fields
Field
Type
Create
Update
Default
Notes
description
string
Optional
Yes
-
email
string
Yes
Yes
-
name
string
Optional
Yes
-
publicValue
string
Optional
Yes
-
The public value of the registryCredential
registryId
registry
Yes
-
-
secretValue
password
Optional
Yes
-
The secret value of the registryCredential
Read Only Fields
Field
Type
Notes
id
int
The unique identifier for the registryCredential
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
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
-H 'Content-Type: application/json' \
-d ' {
"description" : "string" ,
"email" : "string" ,
"name" : "string" ,
"publicValue" : "string" ,
"registryId" : "reference[registry]" ,
"secretValue" : "password"
} ' 'http://$ { RANCHER_URL } : 8080 /v 1 /registryCredentials'
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X DELETE \
'http://$ { RANCHER_URL } : 8080 /v 1 /registryCredentials/$ { ID } '
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X PUT \
-H 'Content-Type: application/json' \
-d ' {
"description" : "string" ,
"email" : "string" ,
"name" : "string" ,
"publicValue" : "string" ,
"secretValue" : "password"
} ' 'http://$ { RANCHER_URL } : 8080 /v 1 /registryCredentials/$ { ID } '
Actions
Input: This action has no inputs
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://$ { RANCHER_URL } : 8080 /v 1 /registryCredentials/$ { ID } ?action=activate'
Output: An updated copy of the credential resource
Input: This action has no inputs
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://$ { RANCHER_URL } : 8080 /v 1 /registryCredentials/$ { ID } ?action=deactivate'
Output: An updated copy of the credential resource