List services

GET

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

GET

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

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

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

Lists Agent Machines services in a namespace.

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.

Query parameters

limitintegerOptional1-1000

Maximum number of services to return.

continuestringOptional

Continuation token returned by a previous list request.

Response

A page of services.

apiVersionstring

kindstring

metadataobject

Metadata for paginated list responses.

itemslist of objects

unreachablelist of strings

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error