Get a service

GET

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

GET

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

$ curl https://api.agentmachines.app/apis/serving.agentmachines.app/v1/namespaces/project-123456/services/web \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

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": "Primary web service handling user requests",
14       "api.agentmachines.app/ingress": "all",
15       "api.agentmachines.app/binary-authorization": "prod-binary-auth-policy",
16       "api.agentmachines.app/binary-authorization-breakglass": "Emergency override for deployment",
17       "api.agentmachines.app/minScale": "2",
18       "api.agentmachines.app/maxScale": "10",
19       "api.agentmachines.app/function-target": "HandleRequest",
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": "0"
24     },
25     "generateName": "web-",
26     "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
27     "resourceVersion": "123456",
28     "generation": 3,
29     "creationTimestamp": "2024-01-15T09:30:00Z",
30     "deletionTimestamp": "2024-01-20T10:00:00Z",
31     "finalizers": [
32       "foregroundDeletion"
33     ]
34   },
35   "spec": {
36     "template": {
37       "spec": {
38         "containers": [
39           {
40             "image": "registry.example.com/project/web:1.4.2",
41             "name": "web",
42             "command": [
43               "/start-web-server"
44             ],
45             "args": [
46               "--port=8080",
47               "--env=production"
48             ],
49             "workingDir": "/app",
50             "ports": [
51               {
52                 "containerPort": 8080,
53                 "name": "http1"
54               }
55             ],
56             "env": [
57               {
58                 "name": "DATABASE_URL",
59                 "value": "postgres://user:password@db-host:5432/webdb"
60               },
61               {
62                 "name": "API_KEY",
63                 "valueFrom": {
64                   "secretKeyRef": {
65                     "name": "web-api-secrets",
66                     "key": "api_key",
67                     "optional": true
68                   }
69                 }
70               }
71             ],
72             "resources": {
73               "limits": {
74                 "cpu": "2",
75                 "memory": "1024Mi",
76                 "nvidia.com/gpu": "1"
77               }
78             },
79             "volumeMounts": [
80               {
81                 "name": "config-volume",
82                 "mountPath": "/etc/config"
83               }
84             ],
85             "startupProbe": {
86               "httpGet": {
87                 "port": 8080,
88                 "path": "/healthz/startup",
89                 "httpHeaders": [
90                   {
91                     "name": "X-Startup-Probe",
92                     "value": "true"
93                   }
94                 ]
95               },
96               "initialDelaySeconds": 10,
97               "timeoutSeconds": 5,
98               "successThreshold": 1,
99               "failureThreshold": 3,
100               "periodSeconds": 10
101             },
102             "livenessProbe": {
103               "httpGet": {
104                 "port": 8080,
105                 "path": "/healthz/live",
106                 "httpHeaders": [
107                   {
108                     "name": "X-Liveness-Probe",
109                     "value": "true"
110                   }
111                 ]
112               },
113               "initialDelaySeconds": 30,
114               "timeoutSeconds": 5,
115               "successThreshold": 1,
116               "failureThreshold": 3,
117               "periodSeconds": 15
118             },
119             "readinessProbe": {
120               "httpGet": {
121                 "port": 8080,
122                 "path": "/healthz/ready",
123                 "httpHeaders": [
124                   {
125                     "name": "X-Readiness-Probe",
126                     "value": "true"
127                   }
128                 ]
129               },
130               "initialDelaySeconds": 5,
131               "timeoutSeconds": 3,
132               "successThreshold": 1,
133               "failureThreshold": 3,
134               "periodSeconds": 10
135             }
136           }
137         ],
138         "containerConcurrency": 80,
139         "timeoutSeconds": 300,
140         "nodeSelector": {
141           "api.agentmachines.app/accelerator": "nvidia-l4"
142         },
143         "serviceAccountName": "web-service-account@project-123456.iam.gserviceaccount.com",
144         "volumes": [
145           {
146             "name": "config-volume",
147             "secret": {
148               "secretName": "web-config-secret",
149               "items": [
150                 {
151                   "key": "config.yaml",
152                   "path": "config.yaml"
153                 }
154               ]
155             }
156           },
157           {
158             "name": "cache-volume",
159             "emptyDir": {
160               "sizeLimit": "512Mi",
161               "medium": "Memory"
162             }
163           },
164           {
165             "name": "gcs-mount",
166             "csi": {
167               "driver": "gcsfuse.api.agentmachines.app",
168               "readOnly": true,
169               "volumeAttributes": {
170                 "bucketName": "project-123456-web-bucket",
171                 "mountOptions": "implicit-dirs,uid=1000"
172               }
173             }
174           },
175           {
176             "name": "nfs-storage",
177             "nfs": {
178               "server": "10.0.0.5",
179               "path": "/exports/web-data",
180               "readonly": true
181             }
182           }
183         ],
184         "runtimeClassName": "gvisor"
185       },
186       "metadata": {
187         "name": "web-00001",
188         "labels": {},
189         "annotations": {
190           "autoscaling.agentmachines.app/minScale": "2",
191           "autoscaling.agentmachines.app/maxScale": "10",
192           "api.agentmachines.app/scaling-cpu-target": "75",
193           "api.agentmachines.app/scaling-concurrency-target": "100",
194           "api.agentmachines.app/cpu-throttling": "true",
195           "api.agentmachines.app/startup-cpu-boost": "true",
196           "api.agentmachines.app/sessionAffinity": "true",
197           "api.agentmachines.app/cloudsql-instances": "project-123456:us-central1:db-instance",
198           "api.agentmachines.app/execution-environment": "gen1",
199           "api.agentmachines.app/vpc-access-connector": "projects/project-123456/locations/us-central1/connectors/vpc-connector-1",
200           "api.agentmachines.app/vpc-access-egress": "all-traffic",
201           "api.agentmachines.app/network-interfaces": "[{\"name\":\"eth0\",\"subnet\":\"default\"}]",
202           "api.agentmachines.app/encryption-key": "projects/project-123456/locations/us/keyRings/my-keyring/cryptoKeys/my-key",
203           "api.agentmachines.app/container-dependencies": "{\"web\": [\"init\"]}",
204           "api.agentmachines.app/base-images": "{\"web\": \"gcr.io/project-123456/base-image:latest\"}",
205           "api.agentmachines.app/gpu-zonal-redundancy-disabled": "true"
206         }
207       }
208     },
209     "traffic": [
210       {
211         "percent": 100,
212         "latestRevision": true,
213         "revisionName": "web-00001",
214         "tag": "stable",
215         "url": "https://web.project-123456.agentmachines.app"
216       }
217     ]
218   },
219   "status": {
220     "observedGeneration": 3,
221     "conditions": [
222       {
223         "type": "Ready",
224         "status": "True",
225         "reason": "ServiceReady",
226         "message": "Service is ready to serve traffic",
227         "lastTransitionTime": "2024-01-15T09:45:00Z"
228       }
229     ],
230     "url": "https://web.project-123456.agentmachines.app",
231     "address": {
232       "url": "https://web.project-123456.agentmachines.app"
233     },
234     "latestCreatedRevisionName": "web-00001",
235     "latestReadyRevisionName": "web-00001",
236     "traffic": [
237       {
238         "percent": 100,
239         "latestRevision": true,
240         "revisionName": "web-00001",
241         "tag": "stable",
242         "url": "https://web.project-123456.agentmachines.app"
243       }
244     ]
245   }
246 }

Gets a single Agent Machines service 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.

Response

The requested 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

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error