Set a Deployment’s resource metadata
editSet a Deployment’s resource metadata
editAdvanced 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.
Request
editPOST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one) |
|
|
Y |
The kind of resource |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
If specified, checks for conflicts against the metadata version (returned in 'x-cloud-resource-version' of the GET request) |
Request body
edit(string
) (required) The freeform JSON for the cluster (should always be based on the current version retrieved from the GET)
Responses
edit-
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
-
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
-
-
The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found
) -
The Resource specified by {ref_id} cannot be found. (code:
deployments.deployment_resource_not_found
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
,deployments.deployment_resource_not_found
]) - The error codes associated with the response
-
The Deployment specified by {deployment_id} cannot be found. (code:
-
449
-
Please retry. (code:
deployments.metadata_internal_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.metadata_internal_error
]) - The error codes associated with the response
-
-
500
-
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
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json'