Bulk Cluster Options by lookupKey
POST/clusters/:lookupKey/:lookupValue/options/bulk
The bulk endpoints offer an efficient way of importing/updating large amounts of cluster options with just a single API call. The same lookup key is used for the options as for the cluster. When using the bulk id
endpoint, the options are identified by Propeller option id
. If an option with such id
doesn't already exist, it will be created. If it does exist, the option will be updated.
Fields
Name | Required |
---|---|
names | no |
descriptions | no |
shortDescriptions | no |
language | no |
sourceId | no |
source | only when sourceId is provided |
isRequired | no |
Directives
Name | Description | Fields |
---|---|---|
skipIfNotEmpty | On update, skip updating fields of an existing option that are not empty | array of field names e.g. names, descriptions, etc. |
skipMoveOnUpdate | On update, skip moving an existing option in the parent cluster provided | empty array |
mergeTranslationsOnUpdate | On update, delete all translation for an option that are not provided in the payload | empty array |
skipCreate | Do not create new options, only update existing | empty array |
Request
Responses
- 200
- 404
Bulk Cluster Options by lookupKey - 200
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
x-request-id
Bulk Cluster Options by lookupKey - 404
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
x-request-id