Set a Deployment’s resource metadataedit
Advanced use only. Sets the internal metadata, in free-form JSON, for the resource. Only use the parameter to set the modified JSON that is returned from the get version of the metadata.
Requestedit
POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource |
|
|
Y |
The kind of resource |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
If specified, checks for conflicts against the metadata version (returned in 'x-cloud-resource-version' of the GET request) |
Request bodyedit
(string) (required) The freeform JSON for the cluster (should always be based on the current version retrieved from the GET)
Responsesedit
-
200 -
(
string) The resource metadata was successfully changed (the updated JSON is returned)Headers
-
x-cloud-resource-created(string) - The date-time when the resource was created (ISO format relative to UTC)
-
x-cloud-resource-last-modified(string) - The date-time when the resource was last modified (ISO format relative to UTC)
-
x-cloud-resource-version(string) - The resource version, which is used to avoid update conflicts with concurrent operations
-
-
400 -
(
BasicFailedReply) The metadata is invalid. (code:deployments.invalid_metadata)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.invalid_metadata]) - The error codes associated with the response
-
-
404 -
(
BasicFailedReply) A resource with the given refId cannot be found in the deployment. (code:deployments.deployment_resource_not_found)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_resource_not_found]) - The error codes associated with the response
-
-
449 -
(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
-
500 -
(
BasicFailedReply) We have failed you. (code:deployments.metadata_internal_error)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.metadata_internal_error]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw \
-H "Authorization: ApiKey $ECE_API_KEY"