In November 2020, the Apigee Edge API reference documentation will move to a new experience based on the Apigee integrated portal and visitors to this site will be redirected.

You are viewing the Apigee Edge API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Virtual hosts APIs


API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /virtualhosts
A named network configuration (including URL) for an environment (for example 'test' or 'prod') on API Services.
Provides the runtime network address for APIs managed by Apigee Edge.
Create a virtual host for an environment Detail
/environments/{environment_name}/virtualhosts
Verb: POST
Description: Creates a named virtual host
Media types:
application/json
text/xml
Auth: Basic Auth
Delete a virtual host from an environment Detail
/environments/{environment_name}/virtualhosts/{virtualhost_name}
Verb: DELETE
Description: Deletes a named virtual host
Media types:  
Auth: Basic Auth
Get a virtual host for an environment Detail
/environments/{environment_name}/virtualhosts/{virtualhost_name}
Verb: GET
Description: Gets details for a named virtual host
Media types:
application/json
text/xml
Auth: Basic Auth
List virtual hosts for an environment Detail
/environments/{environment_name}/virtualhosts
Verb: GET
Description: Get a list of named virtual hosts for an environment.
Media types:
application/json
text/xml
Auth: Basic Auth
Update virtual host for an environment Detail
/environments/{environment_name}/virtualhosts/{virtualhost_name}
Verb: PUT
Description: Updates a named virtual hosts in an environment.
Media types:
application/json
text/xml
Auth: Basic Auth

 

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)