Metaplay Docs

Appearance

metaplay debug admin-request ENVIRONMENT METHOD PATH [flags]

Make HTTP requests to the game server admin API

metaplay debug admin-request ENVIRONMENT METHOD PATH [flags] ​

Make HTTP requests to the game server admin API.

This command allows you to interact with the game server's admin API endpoint using various HTTP methods. You can pass a request body using either the --body flag for providing raw content directly or the --file flag to read content from a file.

Requests are automatically retried a few times to mitigate transient network errors.

Expected arguments:

  • ENVIRONMENT -- Target environment name or id, eg, 'lovely-wombats-build-nimbly'.
  • METHOD -- HTTP method to use: GET, POST, DELETE, PUT.
  • PATH -- Path for the admin API request, eg 'api/hello'.

Related commands:

  • 'metaplay debug server-status ...' checks the status of a game server deployment.

Examples ​

sh
# Get the server hello message.
metaplay debug admin-request nimbly GET api/hello
# Pipe JSON output to jq for colored rendering.
metaplay debug admin-request nimbly GET api/hello | jq
# Send a POST request with request body from command line.
metaplay debug admin-request nimbly POST api/some-endpoint --body '{"name":"test-resource"}'
# Send a POST request with request body containing json data from command line.
metaplay debug admin-request nimbly POST api/some-endpoint --content-type application/json --body '{"name":"test-resource"}'
# Send a PUT request with request payload from file.
metaplay debug admin-request nimbly PUT api/some-endpoint --file update.json
# Send a DELETE request.
metaplay debug admin-request nimbly DELETE api/some-endpoint
# Download a binary file (e.g., game config archive).
metaplay debug admin-request nimbly GET api/GameConfig/.../download -o gameconfig.mca

Flags ​

  • --body <string>: Raw content to use as the request body
  • --content-type <string>: Content-Type passed as header for the API request, e.g. application/json. If not specific, automatically determined based on the file or body parameter
  • --file <string>: Path to a file containing content to use as the request body
  • --output <string>: Save response to file (for binary/non-JSON downloads)

Inherited Flags ​

  • --color <string>: Should the output be colored (yes/no/auto)? [env: METAPLAYCLI_COLOR] (default: auto)
  • --project <string>: Path to the to project directory (where metaplay-project.yaml is located)
  • --skip-version-check: Skip the check for a new CLI version being available
  • --verbose: Enable verbose logging, useful for troubleshooting [env: METAPLAYCLI_VERBOSE]