You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Release and deploy accept `--config <path>` and `--environment <env>`.
257
257
258
-
### Raw API Requests
258
+
### API Discovery and Requests
259
259
260
-
Make authenticated requests to any GoDaddy API endpoint:
260
+
Use `godaddy api` for endpoint discovery and authenticated API calls:
261
261
262
262
```bash
263
-
# GET request
264
-
godaddy api /v1/commerce/catalog/products
265
-
266
-
# POST with inline fields
267
-
godaddy api /v1/some/endpoint -X POST -f "name=value" -f "count=5"
268
-
269
-
# POST with body from file
270
-
godaddy api /v1/some/endpoint -X POST -F body.json
271
-
272
-
# Custom headers
273
-
godaddy api /v1/some/endpoint -H "X-Custom: value"
263
+
# List domains and endpoints
264
+
godaddy api list
265
+
godaddy api list --domain commerce
266
+
267
+
# Describe one endpoint (operation ID or path)
268
+
godaddy api describe commerce.location.verify-address
269
+
godaddy api describe /location/addresses
270
+
271
+
# Search endpoints by keyword
272
+
godaddy api search address
273
+
godaddy api search catalog
274
+
275
+
# Call endpoint (explicit form)
276
+
godaddy api call /v1/commerce/catalog/products
277
+
godaddy api call /v1/some/endpoint -X POST -f "name=value" -f "count=5"
278
+
godaddy api call /v1/some/endpoint -X POST -F body.json
279
+
godaddy api call /v1/some/endpoint -H "X-Custom: value"
280
+
godaddy api call /v1/some/endpoint -q ".data[0].id"
281
+
godaddy api call /v1/some/endpoint -i
282
+
godaddy api call /v1/commerce/orders -s commerce.orders:read
283
+
```
274
284
275
-
# Extract a field from the response
276
-
godaddy api /v1/some/endpoint -q ".data[0].id"
285
+
Compatibility behavior:
286
+
-`godaddy api <endpoint>` still works. If the token after `api` is not one of `list`, `describe`, `search`, or `call`, the CLI treats it as an endpoint and executes `api call`.
287
+
- This means legacy usage like `godaddy api /v1/commerce/location/addresses` remains supported.
277
288
278
-
# Include response headers in output
279
-
godaddy api /v1/some/endpoint -i
289
+
As with other large result sets, `api list` may be truncated in the inline JSON response. When `truncated: true`, read the `full_output` file path for complete results.
280
290
281
-
# Auto re-auth on 403 with specific scope
282
-
godaddy api /v1/commerce/orders -s commerce.orders:read
283
-
```
291
+
Address task rule:
292
+
- For requests like "find/search/verify an address", start with:
293
+
`godaddy api search address`
294
+
`godaddy api list --domain location`
295
+
`godaddy api describe /location/addresses`
296
+
- Do not use `godaddy actions describe` for generic API endpoint discovery.
284
297
285
298
### Actions
286
299
300
+
`godaddy actions` is only for developers discovering action hook contracts they can integrate with as providers (or consume as a contract in app configuration). It is not for API endpoint discovery or API calls.
Use `godaddy actions list` to discover current action names and then `godaddy actions describe <action>` to inspect request/response schemas for that hook contract.
0 commit comments