api show

Displays information about the Dev Proxy REST API endpoints.

Synopsis

devproxy api show [options]

Options:
  --output <format>   Output format: text|json (default: text)
  -h, --help          Show help

Usage

devproxy api show

Options

Name Description Allowed values Default
--output <format> Output format text, json text
-?, -h, --help Show help and usage information n/a n/a

Examples

Show Dev Proxy API information

devproxy api show

Get API information as JSON

devproxy api show --output json

Remarks

Dev Proxy exposes an authenticated REST API at http://{api-ip-address}:{api-port} (default http://127.0.0.1:8897). All endpoints require the instance bearer token in the Authorization request header. To retrieve the token, use the api token command.

The api show command lists the API base URL, authentication requirements, and available REST API endpoints. With --output json, it also includes the token file pattern. The base URL reflects the configured API address and port. To get the actual API URL of a running instance, for example when you use --api-port 0, use the status command. The API is available while Dev Proxy is running. Use the CLI for lifecycle operations (start, stop, configure), and use the REST API for runtime operations (proxy state, recording, mock management).

The following endpoints are available:

Method Endpoint Description
GET /proxy Get proxy status
POST /proxy Update proxy status (for example, start or stop recording)
POST /proxy/mockRequest Send a mock request
POST /proxy/stopProxy Stop the proxy
POST /proxy/jwtToken Create a JSON Web Token (JWT)
GET /proxy/rootCertificate Get the root certificate
GET /proxy/logs Get Dev Proxy logs (detached mode only)

For the full API reference, see Proxy API.

  • Last updated on