Apigee emulator API documentation

Hi!

Is there anywhere Apigee emulator API documentation available?

Apigee emulator docker container is running something on a Control port (which is by default 8080). What kind of API does it expose? I could find these endpoints:

  • GET /v1/emulator/version
  • GET /v1/emulator/tree
  • GET /v1/emulator/test/products
  • GET /v1/emulator/test/developers
  • GET /v1/emulator/test/developerapps
  • GET /v1/emulator/test/maps

But is there any documentation for the API? What other endpoints are available?

Solved Solved
3 3 746
1 ACCEPTED SOLUTION

The /v1/emulator set of APIs are tightly coupled to the VSCode extension to provide the necessary functionality for the VSCode extension to work. This is not intended to be used directly, nor is it guaranteed to be stable. That all said, it's running on your machine so you're free to poke around if you'd like. 

You've found almost the entire emulator API already, but here's another for you: 
DELETE /v1/emulator/reset - undeploys everything and deletes any test data.

View solution in original post

3 REPLIES 3

I would also like to know that. Ideally the emulator would expose the same API as the hosted version https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/ (of course some limitations can be accepted)

This would enable further automation can help CI setups.

Yeah. Unfortunately, the emulator has a different API than the hosted version.

The /v1/emulator set of APIs are tightly coupled to the VSCode extension to provide the necessary functionality for the VSCode extension to work. This is not intended to be used directly, nor is it guaranteed to be stable. That all said, it's running on your machine so you're free to poke around if you'd like. 

You've found almost the entire emulator API already, but here's another for you: 
DELETE /v1/emulator/reset - undeploys everything and deletes any test data.