Method: organizations.hostQueries.create

Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, thestate of "enqueued" means that the request succeeded.

HTTP request

POST https://apigee.googleapis.com/v1/{parent=organizations/*}/hostQueries

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name. Must be of the formorganizations/{org}.

Authorization requires the followingIAM permission on the specified resourceparent:

  • apigee.hostqueries.create

Request body

The request body contains an instance ofQuery.

Response body

If successful, the response body contains a newly created instance ofAsyncQuery.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.