enumeray api

Call a documented management API endpoint on the selected origin.

Use when: You are integrating with a documented endpoint or need a management operation without a typed command.

Role and prerequisites: Account with the endpoint’s required scope and resource authority. Install enumeray, configure the API and log in. Use an account or delegated token with the required permissions. Example IDs must be replaced with IDs from your service.

Example

enumeray api GET '/api/v1/models?limit=10'
cat > state-change.json <<'JSON'
{"expected_generation":1,"draining":true}
JSON
enumeray api PUT /api/v1/connectors/lab-worker/state --file state-change.json

Inputs and options

Input	Meaning and use
<METHOD>	HTTP method: GET to read, POST to create/perform an action, PUT/PATCH to update, DELETE to revoke/delete, as documented for the endpoint.
<PATH>	API-relative path beginning /api/v1/, including any query string. Full URLs and paths outside the configured API prefix are refused.
--file <FILE>	Optional JSON request body file matching the endpoint schema. For raw multipart upload or streaming events, use the documented HTTP client examples instead.
--idempotency-key <IDEMPOTENCY_KEY>	Explicit request key only for endpoints that document idempotency. Persist the same key and exact body before sending, and reuse after uncertainty; the option does not make every endpoint retry-safe.

Every command also accepts the profile, API, JSON and timeout options.

Result and next step

Sends the selected method/path and optional JSON body using the profile/token’s existing authority. The escape hatch does not support arbitrary external URLs or credential forwarding.

Use HTTP integration examples and the endpoint reference for response and recovery contracts. Start ordinary CLI executions with analysis directories.

Exact syntax, defaults and accepted values

Explicit HTTP escape hatch for new management APIs; limited to this API origin

Usage: enumeray api [OPTIONS] <METHOD> <PATH>

Arguments:
  <METHOD>  HTTP method supported by the target API endpoint [possible values: GET, POST, PUT, PATCH, DELETE]
  <PATH>    API-relative path beginning /api/v1/, including any query string; full URLs are refused

Options:
      --api <API>
          User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
      --file <FILE>
          Optional JSON request body file matching the endpoint schema
      --idempotency-key <IDEMPOTENCY_KEY>
          Persisted request key for endpoints that document idempotency; reuse with the exact same body
      --profile <PROFILE>
          Named local user API/login profile; host/runner commands use explicit configuration [default: default]
      --config <CONFIG>
          Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json
      --json
          Emit user API results as JSON (NDJSON for following logs) and runtime errors on stderr; host/runner output follows its own protocol
      --timeout <TIMEOUT>
          User API HTTP timeout in seconds; live logs use it for read inactivity. Does not limit execution time [default: 60]
  -h, --help
          Print help