Shadow Experiment Service

Update a shadow experiment

PATCH
/projects/{projectId}/endpoints/{endpointId}/shadowExperiments/{id}

Updates a shadow experiment's description or source sampling strategy. updateMask is required; source changes also require the current etag in the request body.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Project identifier.

endpointId*string

Endpoint identifier.

id*string

Shadow experiment identifier.

Query Parameters

updateMask*string

Required fields to update, such as description or source.

Request Body

application/json

Mutable description and source sampling strategy for a shadow experiment.

description?string

Updated free-form description.

source?

Updated endpoint sampling configuration. Source updates require etag in the request body.

etag?string

Opaque version tag from a prior read for optimistic concurrency.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/projects/string/endpoints/string/shadowExperiments/string?updateMask=string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "projectId": "string",  "endpointId": "string",  "name": "string",  "description": "string",  "source": {    "endpoint": {      "sampling": {        "uniform": {          "rate": 0        }      }    }  },  "targets": [    {      "id": "string",      "experimentId": "string",      "name": "string",      "targetDeploymentId": "string",      "description": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "etag": "string"    }  ],  "createdBy": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "etag": "string",  "state": "SHADOW_EXPERIMENT_STATE_ACTIVE"}