Replace a service

PUT

https://api.agentmachines.app/apis/serving.agentmachines.app/v1/namespaces/:namespace/services/:service

PUT

/apis/serving.agentmachines.app/v1/namespaces/:namespace/services/:service

$ curl -X PUT https://api.agentmachines.app/apis/serving.agentmachines.app/v1/namespaces/project-123456/services/web \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "apiVersion": "serving.agentmachines.app/v1",
>   "kind": "Service",
>   "metadata": {
>     "name": "web",
>     "namespace": "project-123456",
>     "labels": {
>       "api.agentmachines.app/location": "us-central1"
>     },
>     "annotations": {
>       "api.agentmachines.app/custom-audiences": "[\"dashboard\",\"internal\"]",
>       "api.agentmachines.app/launch-stage": "GA",
>       "api.agentmachines.app/description": "Public web service",
>       "api.agentmachines.app/ingress": "all",
>       "api.agentmachines.app/binary-authorization": "default",
>       "api.agentmachines.app/binary-authorization-breakglass": "emergency rollout",
>       "api.agentmachines.app/minScale": "0",
>       "api.agentmachines.app/maxScale": "20",
>       "api.agentmachines.app/function-target": "handler",
>       "api.agentmachines.app/invoker-iam-disabled": "false",
>       "api.agentmachines.app/iap-enabled": "false",
>       "api.agentmachines.app/scalingMode": "automatic",
>       "api.agentmachines.app/manualInstanceCount": "0"
>     }
>   },
>   "spec": {
>     "template": {
>       "spec": {
>         "containers": [
>           {
>             "image": "registry.example.com/project/web:latest",
>             "name": "web",
>             "command": [
>               "/app/server"
>             ],
>             "args": [
>               "--port",
>               "8080"
>             ],
>             "workingDir": "/app",
>             "ports": [
>               {
>                 "containerPort": 8080,
>                 "name": "http1"
>               }
>             ],
>             "env": [
>               {
>                 "name": "ENVIRONMENT",
>                 "value": "production"
>               }
>             ],
>             "resources": {
>               "limits": {
>                 "cpu": "1",
>                 "memory": "512Mi",
>                 "nvidia.com/gpu": "1"
>               }
>             },
>             "volumeMounts": [
>               {
>                 "name": "cache",
>                 "mountPath": "/cache"
>               }
>             ],
>             "startupProbe": {
>               "httpGet": {
>                 "port": 8080,
>                 "path": "/healthz/startup",
>                 "httpHeaders": [
>                   {
>                     "name": "X-Probe",
>                     "value": "startup"
>                   }
>                 ]
>               },
>               "initialDelaySeconds": 2,
>               "timeoutSeconds": 5,
>               "failureThreshold": 6,
>               "periodSeconds": 10
>             },
>             "livenessProbe": {
>               "httpGet": {
>                 "port": 8080,
>                 "path": "/healthz/live"
>               },
>               "initialDelaySeconds": 5,
>               "timeoutSeconds": 5,
>               "failureThreshold": 3,
>               "periodSeconds": 10
>             },
>             "readinessProbe": {
>               "httpGet": {
>                 "port": 8080,
>                 "path": "/healthz/ready"
>               },
>               "timeoutSeconds": 5,
>               "successThreshold": 1,
>               "failureThreshold": 3,
>               "periodSeconds": 10
>             }
>           },
>           {
>             "image": "registry.example.com/project/proxy:latest",
>             "name": "proxy"
>           }
>         ],
>         "containerConcurrency": 80,
>         "timeoutSeconds": 300,
>         "nodeSelector": {
>           "api.agentmachines.app/accelerator": "nvidia-l4"
>         },
>         "serviceAccountName": "service-account@example.iam",
>         "volumes": [
>           {
>             "name": "app-secret",
>             "secret": {
>               "secretName": "api-token",
>               "items": [
>                 {
>                   "key": "latest",
>                   "path": "token"
>                 }
>               ]
>             }
>           },
>           {
>             "name": "cache",
>             "emptyDir": {
>               "sizeLimit": "512Mi",
>               "medium": "Memory"
>             }
>           },
>           {
>             "name": "assets",
>             "csi": {
>               "driver": "gcsfuse.api.agentmachines.app",
>               "readOnly": true,
>               "volumeAttributes": {
>                 "bucketName": "app-assets",
>                 "mountOptions": "implicit-dirs,uid=1000"
>               }
>             }
>           },
>           {
>             "name": "shared",
>             "nfs": {
>               "server": "10.0.0.10",
>               "path": "/exports/shared",
>               "readonly": true
>             }
>           }
>         ],
>         "runtimeClassName": "base-image-update"
>       },
>       "metadata": {
>         "name": "web-00001",
>         "annotations": {
>           "autoscaling.agentmachines.app/minScale": "0",
>           "autoscaling.agentmachines.app/maxScale": "10",
>           "api.agentmachines.app/scaling-cpu-target": "60",
>           "api.agentmachines.app/scaling-concurrency-target": "80",
>           "api.agentmachines.app/cpu-throttling": "true",
>           "api.agentmachines.app/startup-cpu-boost": "true",
>           "api.agentmachines.app/sessionAffinity": "false",
>           "api.agentmachines.app/cloudsql-instances": "project:region:instance",
>           "api.agentmachines.app/execution-environment": "gen2",
>           "api.agentmachines.app/vpc-access-connector": "connector-name",
>           "api.agentmachines.app/vpc-access-egress": "private-ranges-only",
>           "api.agentmachines.app/network-interfaces": "[{\"network\":\"default\",\"subnetwork\":\"default\"}]",
>           "api.agentmachines.app/encryption-key": "projects/project/locations/global/keyRings/ring/cryptoKeys/key",
>           "api.agentmachines.app/container-dependencies": "{\"web\":[\"proxy\"]}",
>           "api.agentmachines.app/base-images": "{\"\":\"debian12\"}",
>           "api.agentmachines.app/gpu-zonal-redundancy-disabled": "false"
>         }
>       }
>     },
>     "traffic": [
>       {
>         "percent": 90,
>         "latestRevision": true
>       },
>       {
>         "percent": 10,
>         "revisionName": "web-00001"
>       },
>       {
>         "revisionName": "web-00001",
>         "tag": "stable"
>       }
>     ]
>   }
> }'

1 {
2   "apiVersion": "serving.agentmachines.app/v1",
3   "kind": "Service",
4   "metadata": {
5     "name": "web",
6     "namespace": "project-123456",
7     "labels": {
8       "api.agentmachines.app/location": "us-central1"
9     },
10     "annotations": {
11       "api.agentmachines.app/custom-audiences": "[\"dashboard\",\"internal\"]",
12       "api.agentmachines.app/launch-stage": "GA",
13       "api.agentmachines.app/description": "string",
14       "api.agentmachines.app/ingress": "all",
15       "api.agentmachines.app/binary-authorization": "string",
16       "api.agentmachines.app/binary-authorization-breakglass": "string",
17       "api.agentmachines.app/minScale": "string",
18       "api.agentmachines.app/maxScale": "string",
19       "api.agentmachines.app/function-target": "string",
20       "api.agentmachines.app/invoker-iam-disabled": "true",
21       "api.agentmachines.app/iap-enabled": "true",
22       "api.agentmachines.app/scalingMode": "automatic",
23       "api.agentmachines.app/manualInstanceCount": "string"
24     },
25     "generateName": "string",
26     "uid": "string",
27     "resourceVersion": "string",
28     "generation": 1,
29     "creationTimestamp": "2024-01-15T09:30:00Z",
30     "deletionTimestamp": "2024-01-15T09:30:00Z",
31     "finalizers": [
32       "string"
33     ]
34   },
35   "spec": {
36     "template": {
37       "spec": {
38         "containers": [
39           {
40             "image": "registry.example.com/project/web:latest",
41             "name": "web",
42             "command": [
43               "string"
44             ],
45             "args": [
46               "string"
47             ],
48             "workingDir": "string",
49             "ports": [
50               {
51                 "containerPort": 1,
52                 "name": "http1"
53               }
54             ],
55             "env": [
56               {
57                 "name": "string",
58                 "value": "string",
59                 "valueFrom": {
60                   "secretKeyRef": {
61                     "name": "string",
62                     "key": "string",
63                     "optional": true
64                   }
65                 }
66               }
67             ],
68             "resources": {
69               "limits": {
70                 "cpu": "1",
71                 "memory": "512Mi",
72                 "nvidia.com/gpu": "1"
73               }
74             },
75             "volumeMounts": [
76               {
77                 "name": "string",
78                 "mountPath": "string"
79               }
80             ],
81             "startupProbe": {
82               "httpGet": {
83                 "port": 1,
84                 "path": "/",
85                 "httpHeaders": [
86                   {
87                     "name": "string",
88                     "value": "string"
89                   }
90                 ]
91               },
92               "tcpSocket": {
93                 "port": 1
94               },
95               "grpc": {
96                 "port": 1,
97                 "service": "string"
98               },
99               "initialDelaySeconds": 1,
100               "timeoutSeconds": 1,
101               "successThreshold": 1,
102               "failureThreshold": 1,
103               "periodSeconds": 1
104             },
105             "livenessProbe": {
106               "httpGet": {
107                 "port": 1,
108                 "path": "/",
109                 "httpHeaders": [
110                   {
111                     "name": "string",
112                     "value": "string"
113                   }
114                 ]
115               },
116               "tcpSocket": {
117                 "port": 1
118               },
119               "grpc": {
120                 "port": 1,
121                 "service": "string"
122               },
123               "initialDelaySeconds": 1,
124               "timeoutSeconds": 1,
125               "successThreshold": 1,
126               "failureThreshold": 1,
127               "periodSeconds": 1
128             },
129             "readinessProbe": {
130               "httpGet": {
131                 "port": 1,
132                 "path": "/",
133                 "httpHeaders": [
134                   {
135                     "name": "string",
136                     "value": "string"
137                   }
138                 ]
139               },
140               "tcpSocket": {
141                 "port": 1
142               },
143               "grpc": {
144                 "port": 1,
145                 "service": "string"
146               },
147               "initialDelaySeconds": 1,
148               "timeoutSeconds": 1,
149               "successThreshold": 1,
150               "failureThreshold": 1,
151               "periodSeconds": 1
152             }
153           }
154         ],
155         "containerConcurrency": 1,
156         "timeoutSeconds": 1,
157         "nodeSelector": {
158           "api.agentmachines.app/accelerator": "nvidia-l4"
159         },
160         "serviceAccountName": "string",
161         "volumes": [
162           {
163             "name": "string",
164             "secret": {
165               "secretName": "string",
166               "items": [
167                 {
168                   "key": "string",
169                   "path": "string"
170                 }
171               ]
172             },
173             "emptyDir": {
174               "sizeLimit": "512Mi",
175               "medium": "Memory"
176             },
177             "csi": {
178               "driver": "gcsfuse.api.agentmachines.app",
179               "readOnly": true,
180               "volumeAttributes": {
181                 "bucketName": "string",
182                 "mountOptions": "implicit-dirs,uid=1000"
183               }
184             },
185             "nfs": {
186               "server": "string",
187               "path": "string",
188               "readonly": true
189             }
190           }
191         ],
192         "runtimeClassName": "string"
193       },
194       "metadata": {
195         "name": "web-00001",
196         "labels": {},
197         "annotations": {
198           "autoscaling.agentmachines.app/minScale": "string",
199           "autoscaling.agentmachines.app/maxScale": "string",
200           "api.agentmachines.app/scaling-cpu-target": "string",
201           "api.agentmachines.app/scaling-concurrency-target": "string",
202           "api.agentmachines.app/cpu-throttling": "true",
203           "api.agentmachines.app/startup-cpu-boost": "true",
204           "api.agentmachines.app/sessionAffinity": "true",
205           "api.agentmachines.app/cloudsql-instances": "string",
206           "api.agentmachines.app/execution-environment": "gen1",
207           "api.agentmachines.app/vpc-access-connector": "string",
208           "api.agentmachines.app/vpc-access-egress": "all-traffic",
209           "api.agentmachines.app/network-interfaces": "string",
210           "api.agentmachines.app/encryption-key": "string",
211           "api.agentmachines.app/container-dependencies": "string",
212           "api.agentmachines.app/base-images": "string",
213           "api.agentmachines.app/gpu-zonal-redundancy-disabled": "true"
214         }
215       }
216     },
217     "traffic": [
218       {
219         "percent": 1,
220         "latestRevision": true,
221         "revisionName": "string",
222         "tag": "string",
223         "url": "string"
224       }
225     ]
226   },
227   "status": {
228     "observedGeneration": 1,
229     "conditions": [
230       {
231         "type": "string",
232         "status": "True",
233         "reason": "string",
234         "message": "string",
235         "lastTransitionTime": "2024-01-15T09:30:00Z"
236       }
237     ],
238     "url": "string",
239     "address": {
240       "url": "string"
241     },
242     "latestCreatedRevisionName": "string",
243     "latestReadyRevisionName": "string",
244     "traffic": [
245       {
246         "percent": 1,
247         "latestRevision": true,
248         "revisionName": "string",
249         "tag": "string",
250         "url": "string"
251       }
252     ]
253   }
254 }

Replaces the full desired state of a service from a manifest.

Authentication

AuthorizationBearer

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

Path parameters

namespacestringRequired>=1 character

Project, organization, or tenant namespace that owns the service.

servicestringRequired>=1 character

Service resource name.

Request

This endpoint expects an object.

apiVersionenumRequired

Agent Machines service API version.

kindenumRequired

Resource kind.

metadataobjectRequired

Metadata common to persisted Agent Machines resources.

specobjectRequired

Desired service state.

statusobjectOptional

Observed state of a service.

Response

The replaced service.

apiVersionenum

Agent Machines service API version.

kindenum

Resource kind.

metadataobject

Metadata common to persisted Agent Machines resources.

specobject

Desired service state.

statusobject

Observed state of a service.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error