Skip to main content

api

Make adhoc calls to the Vendor API v3. Uses your local credentials and prints the response unmodified. For more information, see the Vendor API v3 documentation.

Usage

replicated api [command]

Pass the PATH of the request as the final argument. Do not include the host or version. Replicated recommends piping the output to jq for easier reading.

Available Commands

CommandDescription
getMake adhoc GET API calls to the Vendor API v3
postMake adhoc POST API calls to the Vendor API v3
putMake adhoc PUT API calls to the Vendor API v3

Flags

FlagType (if applicable)Description
-h, --helpHelp for the command.

Examples

replicated api get /v3/apps
replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z3Mk4aXTPyZ -b '{"name":"put-example"}'
replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"post-example"}'