Skip to main content
PATCH
Update a shadow experiment target

Authorizations

Authorization
string
header
default:default
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string
required

Project identifier.

endpointId
string
required

Endpoint identifier.

experimentId
string
required

Shadow experiment identifier.

id
string
required

Shadow experiment target identifier.

Query Parameters

updateMask
string
required

Comma-separated fields to update. Supported fields are name, targetDeploymentId, and description.

Body

application/json

Mutable name, deployment, and description for a shadow experiment target.

name
string

Updated human-readable target name.

targetDeploymentId
string

Replacement deployment under the parent endpoint. Exclude it from the endpoint's live traffic split.

description
string

Updated free-form target description.

etag
string

Opaque version tag from a prior read for optimistic concurrency.

Response

OK

Deployment that receives mirrored traffic for a shadow experiment.

id
string
required
read-only

Output only. Unique shadow experiment target identifier.

experimentId
string
required
read-only

Output only. Shadow experiment this target belongs to.

name
string
required

Human-readable target name, unique within the shadow experiment. At most 256 characters.

targetDeploymentId
string
required

Deployment under the parent endpoint that receives mirrored traffic. Shadow targets should be excluded from the endpoint's live traffic split.

createdAt
string<date-time>
required
read-only

Output only. Timestamp when the target was created.

updatedAt
string<date-time>
required
read-only

Output only. Timestamp when the target was last updated.

etag
string
required

Opaque version tag for optimistic concurrency control. Returned on read; set it on update or delete requests for consistent read-modify-write.

description
string

Optional free-form target description.