openapi: 3.1.0 info: title: Apigee API description: 'Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.' contact: {} version: 'v1' jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema servers: - url: https://apigee.googleapis.com/ variables: {} paths: /v1/{project}:provisionOrganization: post: tags: - projects summary: ProvisionOrganizationV1ProvisionOrganizationByProject description: Provisions a new Apigee organization with a functioning runtime. This is the standard way to create trial organizations for a free Apigee trial. operationId: ProvisionOrganizationV1ProvisionOrganizationByProject parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: project in: path description: Required. Name of the GCP project with which to associate the Apigee organization. required: true style: simple schema: pattern: ^projects/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ProvisionOrganizationRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}: get: tags: - issuers summary: ListV1ByName description: Lists hybrid services and its trusted issuers service account ids. This api is authenticated and unauthorized(allow all the users) and used by runtime authn-authz service to query control plane's issuer service account ids. operationId: ListV1ByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: Required. Must be of the form `hybrid/issuers`. required: true style: simple schema: pattern: ^hybrid/issuers$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform delete: tags: - attachments summary: DeleteV1ByName description: Deletes an environment group attachment. operationId: DeleteV1ByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the environment group attachment to delete in the following format: `organizations/{org}/envgroups/{envgroup}/attachments/{attachment}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/envgroups/[^/]+/attachments/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform patch: tags: - envgroups summary: PatchV1ByName description: Updates an environment group. operationId: PatchV1ByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the environment group to update in the format: `organizations/{org}/envgroups/{envgroup}.' required: true style: simple schema: pattern: ^organizations/[^/]+/envgroups/[^/]+$ type: string - name: updateMask in: query description: List of fields to be updated. style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - attributes summary: UpdateDeveloperAttributeV1ByName description: "Updates a developer attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds." operationId: UpdateDeveloperAttributeV1ByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the developer attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/attributes/{attribute}`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform put: tags: - apiproducts summary: UpdateV1ByName description: Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names. operationId: UpdateV1ByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`' required: true style: simple schema: pattern: ^organizations/[^/]+/apiproducts/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/attachments: get: tags: - attachments summary: ListV1AttachmentsByParent description: Lists all attachments of an environment group. operationId: ListV1AttachmentsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageToken in: query description: Page token, returned by a previous ListEnvironmentGroupAttachments call, that you can use to retrieve the next page. style: form explode: true schema: type: string - name: pageSize in: query description: Maximum number of environment group attachments to return. The page size defaults to 25. style: form explode: true schema: type: integer contentEncoding: int32 - name: parent in: path description: 'Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/envgroups/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - attachments summary: CreateV1AttachmentsByParent description: Creates a new attachment of an environment to an environment group. operationId: CreateV1AttachmentsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. EnvironmentGroup under which to create the attachment in the following format: `organizations/{org}/envgroups/{envgroup}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/envgroups/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/envgroups: post: tags: - envgroups summary: CreateV1EnvgroupsByParent description: Creates a new environment group. operationId: CreateV1EnvgroupsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization in which to create the environment group in the following format: `organizations/{org}`.' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: name in: query description: ID of the environment group. Overrides any ID in the environment_group resource. style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - envgroups summary: ListV1EnvgroupsByParent description: Lists all environment groups. operationId: ListV1EnvgroupsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageToken in: query description: Page token, returned from a previous ListEnvironmentGroups call, that you can use to retrieve the next page. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization for which to list environment groups in the following format: `organizations/{org}`.' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: pageSize in: query description: Maximum number of environment groups to return. The page size defaults to 25. style: form explode: true schema: type: integer contentEncoding: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/hostQueries: get: tags: - hostQueries summary: ListV1HostQueriesByParent description: Return a list of Asynchronous Queries at host level. operationId: ListV1HostQueriesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: dataset in: query description: 'Filter response list by dataset. Example: `api`, `mint`' style: form explode: true schema: type: string - name: submittedBy in: query description: Filter response list by user who submitted queries. style: form explode: true schema: type: string - name: inclQueriesWithoutReport in: query description: Flag to include asynchronous queries that don't have a report denifition. style: form explode: true schema: type: string - name: from in: query description: Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent resource name. Must be of the form `organizations/{org}`. required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: envgroupHostname in: query description: Required. Filter response list by hostname. style: form explode: true schema: type: string - name: status in: query description: Filter response list by asynchronous query status. style: form explode: true schema: type: string - name: to in: query description: Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - hostQueries summary: CreateV1HostQueriesByParent description: 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, the `state` of "enqueued" means that the request succeeded. operationId: CreateV1HostQueriesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent resource name. Must be of the form `organizations/{org}`. required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Query' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/apicategories: get: tags: - apicategories summary: ListV1ApicategoriesByParent description: Lists the categories on the portal. operationId: ListV1ApicategoriesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`' required: true style: simple schema: pattern: ^organizations/[^/]+/sites/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - apicategories summary: CreateV1ApicategoriesByParent description: Creates a new category on the portal. operationId: CreateV1ApicategoriesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`' required: true style: simple schema: pattern: ^organizations/[^/]+/sites/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryData' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:credit: post: tags: - balance summary: CreditV1CreditByName description: Credits the account balance for the developer. operationId: CreditV1CreditByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+/balance$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:adjust: post: tags: - balance summary: AdjustV1AdjustByName description: Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged. operationId: AdjustV1AdjustByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+/balance$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/attributes: get: tags: - attributes summary: ListV1AttributesByParent description: Returns a list of all developer attributes. operationId: ListV1AttributesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Email address of the developer for which attributes are being listed. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - developers summary: AttributesV1AttributesByParent description: "Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds." operationId: AttributesV1AttributesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Email address of the developer for which attributes are being updated. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}/attributes: post: tags: - apiproducts summary: AttributesV1AttributesByName description: "Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds." operationId: AttributesV1AttributesByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`' required: true style: simple schema: pattern: ^organizations/[^/]+/apiproducts/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/apiproducts: get: tags: - apiproducts summary: ListV1ApiproductsByParent description: Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. operationId: ListV1ApiproductsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: startKey in: query description: Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the `count` query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using `startKey`). Product name is case sensitive. style: form explode: true schema: type: string - name: count in: query description: Enter the number of API products you want returned in the API call. The limit is 1000. style: form explode: true schema: type: string - name: expand in: query description: Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API. style: form explode: true schema: type: boolean - name: parent in: path description: 'Required. Name of the organization. Use the following structure in your request: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: attributevalue in: query description: Value of the attribute used to filter the search. style: form explode: true schema: type: string - name: attributename in: query description: Name of the attribute used to filter the search. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - apiproducts summary: CreateV1ApiproductsByParent description: "Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. **WARNING:** - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?" operationId: CreateV1ApiproductsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/keys/create: post: tags: - create summary: CreateV1KeysCreateByParent description: 'Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.' operationId: CreateV1KeysCreateByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+/apps/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/keys: post: tags: - keys summary: CreateV1KeysByParent description: 'Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.' operationId: CreateV1KeysByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+/apps/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/apps: get: tags: - apps summary: ListV1AppsByParent description: Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the `startKey` and `count` query parameters. operationId: ListV1AppsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: expand in: query description: Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters. style: form explode: true schema: type: boolean - name: shallowExpand in: query description: Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode. style: form explode: true schema: type: boolean - name: startKey in: query description: "**Note**: Must be used in conjunction with the `count` parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the `count` query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive." style: form explode: true schema: type: string - name: count in: query description: Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - apps summary: CreateV1AppsByParent description: Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI. operationId: CreateV1AppsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/subscriptions: get: tags: - subscriptions summary: ListV1SubscriptionsByParent description: Lists all API product subscriptions for a developer. operationId: ListV1SubscriptionsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+$ type: string - name: count in: query description: Number of API product subscriptions to return in the API call. Use with `startKey` to provide more targeted filtering. Defaults to 100. The maximum limit is 1000. style: form explode: true schema: type: integer contentEncoding: int32 - name: startKey in: query description: Name of the API product subscription from which to start displaying the list of subscriptions. If omitted, the list starts from the first item. For example, to view the API product subscriptions from 51-150, set the value of `startKey` to the name of the 51st subscription and set the value of `count` to 100. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - subscriptions summary: CreateV1SubscriptionsByParent description: 'Creates a subscription to an API product. ' operationId: CreateV1SubscriptionsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Email address of the developer that is purchasing a subscription to the API product. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:expire: post: tags: - subscriptions summary: ExpireV1ExpireByName description: Expires an API product subscription immediately. operationId: ExpireV1ExpireByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the API product subscription. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/subscriptions/{subscription}`' required: true style: simple schema: pattern: ^organizations/[^/]+/developers/[^/]+/subscriptions/[^/]+$ type: string requestBody: description: '' content: text/plain: schema: type: object contentMediaType: text/plain required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/developers: post: tags: - developers summary: CreateV1DevelopersByParent description: Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as `active`. To change the developer status, use the SetDeveloperStatus API. operationId: CreateV1DevelopersByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the Apigee organization in which the developer is created. Use the following structure in your request: `organizations/{org}`.' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - developers summary: ListV1DevelopersByParent description: 'Lists all developers in an organization by email address. By default, the response does not include company developers. Set the `includeCompany` query parameter to `true` to include company developers. **Note**: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the `startKey` and `count` query parameters.' operationId: ListV1DevelopersByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: startKey in: query description: '**Note**: Must be used in conjunction with the `count` parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: ``` westley@example.com fezzik@example.com buttercup@example.com ``` and your `startKey` is `fezzik@example.com`, the list returned will be ``` fezzik@example.com buttercup@example.com ```' style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`.' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: count in: query description: Optional. Number of developers to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000. style: form explode: true schema: type: string - name: ids in: query description: Optional. List of IDs to include, separated by commas. style: form explode: true schema: type: string - name: app in: query description: Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria. style: form explode: true schema: type: string - name: expand in: query description: Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters. style: form explode: true schema: type: boolean - name: includeCompany in: query description: Flag that specifies whether to include company details in the response. style: form explode: true schema: type: boolean responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/deployments: get: tags: - deployments summary: ListV1DeploymentsByParent description: Lists all deployments of API proxies or shared flows. operationId: ListV1DeploymentsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization for which to return deployment information in the following format: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: sharedFlows in: query description: Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`. style: form explode: true schema: type: boolean responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}/deployments:generateDeployChangeReport: post: tags: - deployments summary: GenerateDeployChangeReportV1DeploymentsGenerateDeployChangeReport description: 'Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`' operationId: GenerateDeployChangeReportV1DeploymentsGenerateDeployChangeReport parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$ type: string - name: override in: query description: Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks. style: form explode: true schema: type: boolean responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}/deployments:generateUndeployChangeReport: post: tags: - deployments summary: GenerateUndeployChangeReportV1DeploymentsGenerateUndeployChangeReport description: 'Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.undeploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`' operationId: GenerateUndeployChangeReportV1DeploymentsGenerateUndeployChangeReport parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}/deployments: get: tags: - revisions summary: GetDeploymentsV1DeploymentsByName description: Gets the deployment of an API proxy revision and actual state reported by runtime pods. operationId: GetDeploymentsV1DeploymentsByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - revisions summary: DeployV1DeploymentsByName description: 'Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` ' operationId: DeployV1DeploymentsByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: override in: query description: Flag that specifies whether the new deployment replaces other deployed revisions of the API proxy in the environment. Set `override` to `true` to replace other deployed revisions. By default, `override` is `false` and the deployment is rejected if other revisions of the API proxy are deployed in the environment. style: form explode: true schema: type: boolean - name: sequencedRollout in: query description: Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment. style: form explode: true schema: type: boolean - name: name in: path description: 'Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$ type: string - name: serviceAccount in: query description: Google Cloud IAM service account. The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be `{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform delete: tags: - revisions summary: UndeployV1DeploymentsByName description: 'Undeploys an API proxy revision from an environment. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.undeploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`' operationId: UndeployV1DeploymentsByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: sequencedRollout in: query description: Flag that specifies whether to enable sequenced rollout. If set to `true`, the environment group routing rules corresponding to this deployment will be removed before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The [GenerateUndeployChangeReport API](GenerateUndeployChangeReport) may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment. style: form explode: true schema: type: boolean - name: name in: path description: 'Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$ type: string responses: '200': description: '' headers: {} content: text/plain: schema: type: object contentMediaType: text/plain deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/sharedflows: post: tags: - sharedflows summary: CreateV1SharedflowsByParent description: Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB. operationId: CreateV1SharedflowsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: action in: query description: Required. Must be set to either `import` or `validate`. style: form explode: true schema: type: string - name: name in: query description: Required. The name to give the shared flow style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleApiHttpBody' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - sharedflows summary: ListV1SharedflowsByParent description: Lists all shared flows in the organization. operationId: ListV1SharedflowsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: includeMetaData in: query description: Indicates whether to include shared flow metadata in the response. style: form explode: true schema: type: boolean - name: includeRevisions in: query description: Indicates whether to include a list of revisions in the response. style: form explode: true schema: type: boolean - name: parent in: path description: 'Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:activate: post: tags: - natAddresses summary: ActivateV1ActivateByName description: Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. **Note:** Not supported for Apigee hybrid. operationId: ActivateV1ActivateByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``' required: true style: simple schema: pattern: ^organizations/[^/]+/instances/[^/]+/natAddresses/[^/]+$ type: string requestBody: description: '' content: text/plain: schema: type: object contentMediaType: text/plain required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/natAddresses: post: tags: - natAddresses summary: CreateV1NatAddressesByParent description: Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. **Note:** Not supported for Apigee hybrid. operationId: CreateV1NatAddressesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`' required: true style: simple schema: pattern: ^organizations/[^/]+/instances/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - natAddresses summary: ListV1NatAddressesByParent description: Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid. operationId: ListV1NatAddressesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageToken in: query description: Page token, returned from a previous ListNatAddresses call, that you can use to retrieve the next page of content. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`' required: true style: simple schema: pattern: ^organizations/[^/]+/instances/[^/]+$ type: string - name: pageSize in: query description: Maximum number of natAddresses to return. Defaults to 25. style: form explode: true schema: type: integer contentEncoding: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/canaryevaluations: post: tags: - canaryevaluations summary: CreateV1CanaryevaluationsByParent description: Creates a new canary evaluation for an organization. operationId: CreateV1CanaryevaluationsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/instances/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/instances: post: tags: - instances summary: CreateV1InstancesByParent description: Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid. operationId: CreateV1InstancesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - instances summary: ListV1InstancesByParent description: Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid. operationId: ListV1InstancesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageToken in: query description: Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content. style: form explode: true schema: type: string - name: pageSize in: query description: Maximum number of instances to return. Defaults to 25. style: form explode: true schema: type: integer contentEncoding: int32 - name: parent in: path description: 'Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{instance}:reportStatus: post: tags: - instances summary: ReportStatusV1ReportStatusByInstance description: Reports the latest status for a runtime instance. operationId: ReportStatusV1ReportStatusByInstance parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: instance in: path description: The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance} required: true style: simple schema: pattern: ^organizations/[^/]+/instances/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest' required: true responses: '200': description: '' headers: {} content: text/plain: schema: type: object contentMediaType: text/plain deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{profileEnvironment}:computeEnvironmentScores: post: tags: - environments summary: ComputeEnvironmentScoresV1ComputeEnvironmentScores description: ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment. operationId: ComputeEnvironmentScoresV1ComputeEnvironmentScores parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: profileEnvironment in: path description: 'Required. Name of organization and environment and profile id for which score needs to be computed. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}' required: true style: simple schema: pattern: ^organizations/[^/]+/securityProfiles/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/environments: post: tags: - environments summary: CreateV1EnvironmentsByParent description: CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile. operationId: CreateV1EnvironmentsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of organization and security profile ID. Format: organizations/{org}/securityProfiles/{profile}' required: true style: simple schema: pattern: ^organizations/[^/]+/securityProfiles/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}:subscribe: post: tags: - environments summary: SubscribeV1SubscribeByParent description: Creates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The "name" and "push_config" must *not* be specified. operationId: SubscribeV1SubscribeByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{resource}:getIamPolicy: get: tags: - environments summary: GetIamPolicyV1GetIamPolicyByResource description: Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API. operationId: GetIamPolicyV1GetIamPolicyByResource parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: options.requestedPolicyVersion in: query description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). style: form explode: true schema: type: integer contentEncoding: int32 - name: resource in: path description: 'REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleIamV1Policy' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}:unsubscribe: post: tags: - environments summary: UnsubscribeV1UnsubscribeByParent description: Deletes a subscription for the environment's Pub/Sub topic. operationId: UnsubscribeV1UnsubscribeByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' required: true responses: '200': description: '' headers: {} content: text/plain: schema: type: object contentMediaType: text/plain deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{resource}:setIamPolicy: post: tags: - environments summary: SetIamPolicyV1SetIamPolicyByResource description: Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API. operationId: SetIamPolicyV1SetIamPolicyByResource parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: resource in: path description: 'REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleIamV1Policy' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{resource}:testIamPermissions: post: tags: - environments summary: TestIamPermissionsV1TestIamPermissionsByResource description: Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned). operationId: TestIamPermissionsV1TestIamPermissionsByResource parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: resource in: path description: 'REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/securityProfiles: get: tags: - securityProfiles summary: ListV1SecurityProfilesByParent description: ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles. operationId: ListV1SecurityProfilesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageToken in: query description: A page token, received from a previous `ListSecurityProfiles` call. Provide this to retrieve the subsequent page. style: form explode: true schema: type: string - name: parent in: path description: 'Required. For a specific organization, list of all the security profiles. Format: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: pageSize in: query description: The maximum number of profiles to return. The service may return fewer than this value. If unspecified, at most 50 profiles will be returned. style: form explode: true schema: type: integer contentEncoding: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:listRevisions: get: tags: - securityProfiles summary: ListRevisionsV1ListRevisionsByName description: ListSecurityProfileRevisions lists all the revisions of the security profile. operationId: ListRevisionsV1ListRevisionsByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageSize in: query description: The maximum number of profile revisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned. style: form explode: true schema: type: integer contentEncoding: int32 - name: pageToken in: query description: A page token, received from a previous `ListSecurityProfileRevisions` call. Provide this to retrieve the subsequent page. style: form explode: true schema: type: string - name: name in: path description: 'Required. For a specific profile, list all the revisions. Format: `organizations/{org}/securityProfiles/{profile}`' required: true style: simple schema: pattern: ^organizations/[^/]+/securityProfiles/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/hostSecurityReports: post: tags: - hostSecurityReports summary: CreateV1HostSecurityReportsByParent description: 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, the `state` of "enqueued" means that the request succeeded. operationId: CreateV1HostSecurityReportsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent resource name. Must be of the form `organizations/{org}`. required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - hostSecurityReports summary: ListV1HostSecurityReportsByParent description: Return a list of Security Reports at host level. operationId: ListV1HostSecurityReportsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: from in: query description: Filter response list by returning security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'. style: form explode: true schema: type: string - name: pageSize in: query description: The maximum number of security report to return in the list response. style: form explode: true schema: type: integer contentEncoding: int32 - name: dataset in: query description: 'Filter response list by dataset. Example: `api`, `mint`' style: form explode: true schema: type: string - name: submittedBy in: query description: Filter response list by user who submitted queries. style: form explode: true schema: type: string - name: to in: query description: Filter response list by returning security reports that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'. style: form explode: true schema: type: string - name: pageToken in: query description: Token returned from the previous list response to fetch the next page. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent resource name. Must be of the form `organizations/{org}`. required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: envgroupHostname in: query description: Required. Filter response list by hostname. style: form explode: true schema: type: string - name: status in: query description: Filter response list by security report status. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}/operations: get: tags: - operations summary: ListV1OperationsByName description: "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id." operationId: ListV1OperationsByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: The name of the operation's parent resource. required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: filter in: query description: The standard list filter. style: form explode: true schema: type: string - name: pageToken in: query description: The standard list page token. style: form explode: true schema: type: string - name: pageSize in: query description: The standard list page size. style: form explode: true schema: type: integer contentEncoding: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/datacollectors: get: tags: - datacollectors summary: ListV1DatacollectorsByParent description: Lists all data collectors. operationId: ListV1DatacollectorsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageToken in: query description: Page token, returned from a previous ListDataCollectors call, that you can use to retrieve the next page. style: form explode: true schema: type: string - name: pageSize in: query description: Maximum number of data collectors to return. The page size defaults to 25. style: form explode: true schema: type: integer contentEncoding: int32 - name: parent in: path description: 'Required. Name of the organization for which to list data collectors in the following format: `organizations/{org}`.' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - datacollectors summary: CreateV1DatacollectorsByParent description: Creates a new data collector. operationId: CreateV1DatacollectorsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization in which to create the data collector in the following format: `organizations/{org}`.' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: dataCollectorId in: query description: ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with `dc_` that contains only letters, numbers, and underscores. style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/reports: post: tags: - reports summary: CreateV1ReportsByParent description: Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart. operationId: CreateV1ReportsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. The parent organization name under which the Custom Report will be created. Must be of the form: `organizations/{organization_id}/reports`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - reports summary: ListV1ReportsByParent description: Return a list of Custom Reports operationId: ListV1ReportsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent organization name under which the API product will be listed `organizations/{organization_id}/reports` required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: expand in: query description: Set to 'true' to get expanded details about each custom report. style: form explode: true schema: type: boolean responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/entries: get: tags: - entries summary: ListV1EntriesByParent description: 'Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.' operationId: ListV1EntriesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/keyvaluemaps/[^/]+$ type: string - name: pageToken in: query description: Optional. Page token. If provides, must be a valid key value entry returned from a previous call that can be used to retrieve the next page. style: form explode: true schema: type: string - name: pageSize in: query description: Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned. style: form explode: true schema: type: integer contentEncoding: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - entries summary: CreateV1EntriesByParent description: 'Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.' operationId: CreateV1EntriesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/keyvaluemaps/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/keyvaluemaps: post: tags: - keyvaluemaps summary: CreateV1KeyvaluemapsByParent description: Creates a key value map in an organization. operationId: CreateV1KeyvaluemapsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization in which to create the key value map file. Use the following structure in your request: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/apis: post: tags: - apis summary: CreateV1ApisByParent description: 'Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.' operationId: CreateV1ApisByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization in the following format: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: validate in: query description: Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API. style: form explode: true schema: type: boolean - name: action in: query description: 'Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * `import` to import the API proxy configuration bundle. * `validate` to validate the API proxy configuration bundle without importing it.' style: form explode: true schema: type: string - name: name in: query description: 'Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-' style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleApiHttpBody' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - apis summary: ListV1ApisByParent description: Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. operationId: ListV1ApisByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the organization in the following format: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: includeMetaData in: query description: Flag that specifies whether to include API proxy metadata in the response. style: form explode: true schema: type: boolean - name: includeRevisions in: query description: Flag that specifies whether to include a list of revisions in the response. style: form explode: true schema: type: boolean responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/analytics/datastores: post: tags: - datastores summary: CreateV1AnalyticsDatastoresByParent description: Create a Datastore for an org operationId: CreateV1AnalyticsDatastoresByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent organization name. Must be of the form `organizations/{org}`. required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - datastores summary: ListV1AnalyticsDatastoresByParent description: List Datastores operationId: ListV1AnalyticsDatastoresByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent organization name. Must be of the form `organizations/{org}`. required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string - name: targetType in: query description: Optional. TargetType is used to fetch all Datastores that match the type style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/analytics/datastores:test: post: tags: - datastores summary: TestV1AnalyticsDatastoresTestByParent description: Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage operationId: TestV1AnalyticsDatastoresTestByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent organization name Must be of the form `organizations/{org}` required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/rateplans: get: tags: - rateplans summary: ListV1RateplansByParent description: Lists all the rate plans for an API product. operationId: ListV1RateplansByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.' required: true style: simple schema: pattern: ^organizations/[^/]+/apiproducts/[^/]+$ type: string - name: expand in: query description: Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API. Defaults to `false`. style: form explode: true schema: type: boolean - name: startKey in: query description: Name of the rate plan from which to start displaying the list of rate plans. If omitted, the list starts from the first item. For example, to view the rate plans from 51-150, set the value of `startKey` to the name of the 51st rate plan and set the value of `count` to 100. style: form explode: true schema: type: string - name: state in: query description: 'State of the rate plans (`DRAFT`, `PUBLISHED`) that you want to display. (Acceptable values are: "STATE_UNSPECIFIED", "DRAFT", "PUBLISHED")' style: form explode: true schema: type: string default: STATE_UNSPECIFIED - name: count in: query description: Number of rate plans to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The maximum limit is 1000. Defaults to 100. style: form explode: true schema: type: integer contentEncoding: int32 - name: orderBy in: query description: 'Name of the attribute used for sorting. Valid values include: * `name`: Name of the rate plan. * `state`: State of the rate plan (`DRAFT`, `PUBLISHED`). * `startTime`: Time when the rate plan becomes active. * `endTime`: Time when the rate plan expires. **Note**: Not supported by Apigee at this time.' style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - rateplans summary: CreateV1RateplansByParent description: "Create a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by configuring one or more of the following: - Billing frequency - Initial setup fees for using an API product - Payment funding model (postpaid only) - Fixed recurring or consumption-based charges for using an API product - Revenue sharing with developer partners An API product can have multiple rate plans associated with it but *only one* rate plan can be active at any point of time. **Note: From the developer's perspective, they purchase API products not rate plans." operationId: CreateV1RateplansByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`' required: true style: simple schema: pattern: ^organizations/[^/]+/apiproducts/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/references: post: tags: - references summary: CreateV1ReferencesByParent description: Creates a Reference in the specified environment. operationId: CreateV1ReferencesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent environment name under which the Reference will be created. Must be of the form `organizations/{org}/environments/{env}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{orgenv}/securityStats:queryTabularStats: post: tags: - securityStats summary: QueryTabularStatsV1SecurityStatsQueryTabularStatsByOrgenv description: Retrieve security statistics as tabular rows. operationId: QueryTabularStatsV1SecurityStatsQueryTabularStatsByOrgenv parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: orgenv in: path description: Required. Should be of the form organizations//environments/. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{orgenv}/securityStats:queryTimeSeriesStats: post: tags: - securityStats summary: QueryTimeSeriesStatsV1SecurityStatsQueryTimeSeriesStats description: Retrieve security statistics as a collection of time series. operationId: QueryTimeSeriesStatsV1SecurityStatsQueryTimeSeriesStats parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: orgenv in: path description: Required. Should be of the form organizations//environments/. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/queries: get: tags: - queries summary: ListV1QueriesByParent description: Return a list of Asynchronous Queries operationId: ListV1QueriesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: inclQueriesWithoutReport in: query description: Flag to include asynchronous queries that don't have a report denifition. style: form explode: true schema: type: string - name: dataset in: query description: 'Filter response list by dataset. Example: `api`, `mint`' style: form explode: true schema: type: string - name: to in: query description: Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'. style: form explode: true schema: type: string - name: from in: query description: Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'. style: form explode: true schema: type: string - name: status in: query description: Filter response list by asynchronous query status. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: submittedBy in: query description: Filter response list by user who submitted queries. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - queries summary: CreateV1QueriesByParent description: Submit a query 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, the `state` of "enqueued" means that the request succeeded. operationId: CreateV1QueriesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Query' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/debugsessions: post: tags: - debugsessions summary: CreateV1DebugsessionsByParent description: Creates a debug session for a deployed API Proxy revision. operationId: CreateV1DebugsessionsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$ type: string - name: timeout in: query description: Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value. style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - debugsessions summary: ListV1DebugsessionsByParent description: Lists debug sessions that are currently active in the given API Proxy revision. operationId: ListV1DebugsessionsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageSize in: query description: Maximum number of debug sessions to return. The page size defaults to 25. style: form explode: true schema: type: integer contentEncoding: int32 - name: parent in: path description: 'Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$ type: string - name: pageToken in: query description: Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}/data: delete: tags: - debugsessions summary: DeleteDataV1DataByName description: Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods. operationId: DeleteDataV1DataByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$ type: string responses: '200': description: '' headers: {} content: text/plain: schema: type: object contentMediaType: text/plain deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/aliases: post: tags: - aliases summary: CreateV1AliasesByParent description: 'Creates an alias from a key/certificate pair. The structure of the request is controlled by the `format` query parameter: - `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. Set `Content-Type: multipart/form-data` and include the `keyFile`, `certFile`, and `password` (if keys are encrypted) fields in the request body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, provide the file in the `file` field, and include the `password` field if the file is encrypted in the request body. - `selfsignedcert` - A new private key and certificate are generated. Set `Content-Type: application/json` and include CertificateGenerationSpec in the request body.' operationId: CreateV1AliasesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the keystore. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$ type: string - name: ignoreNewlineValidation in: query description: Flag that specifies whether to ignore newline validation. If set to `true`, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to `false`. style: form explode: true schema: type: boolean - name: format in: query description: 'Required. Format of the data. Valid values include: `selfsignedcert`, `keycertfile`, or `pkcs12`' style: form explode: true schema: type: string - name: alias in: query description: Alias for the key/certificate pair. Values must match the regular expression `[\w\s-.]{1,255}`. This must be provided for all formats except `selfsignedcert`; self-signed certs may specify the alias in either this parameter or the JSON body. style: form explode: true schema: type: string - name: _password in: query description: 'DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set `Content-type: multipart/form-data` part with name `password`. Password for the private key file, if required.' style: form explode: true schema: type: string - name: ignoreExpiryValidation in: query description: Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed. style: form explode: true schema: type: boolean requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleApiHttpBody' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}/csr: get: tags: - aliases summary: CsrV1CsrByName description: 'Generates a PKCS #10 Certificate Signing Request for the private key in an alias.' operationId: CsrV1CsrByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleApiHttpBody' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}/certificate: get: tags: - aliases summary: GetCertificateV1CertificateByName description: Gets the certificate from an alias in PEM-encoded form. operationId: GetCertificateV1CertificateByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleApiHttpBody' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/keystores: post: tags: - keystores summary: CreateV1KeystoresByParent description: "Creates a keystore or truststore. - Keystore: Contains certificates and their associated keys. - Truststore: Contains trusted certificates used to validate a server's certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA." operationId: CreateV1KeystoresByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: query description: Optional. Name of the keystore. Overrides the value in Keystore. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the environment in which to create the keystore. Use the following format in your request: `organizations/{org}/environments/{env}`' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/overrides: post: tags: - overrides summary: CreateV1OverridesByParent description: Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides. operationId: CreateV1OverridesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. Parent resource of the trace configuration override. Use the following structure in your request. "organizations/*/environments/*/traceConfig". required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/traceConfig$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - overrides summary: ListV1OverridesByParent description: Lists all of the distributed trace configuration overrides in an environment. operationId: ListV1OverridesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Parent resource of the trace configuration override. Use the following structure in your request: "organizations/*/environments/*/traceConfig".' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/traceConfig$ type: string - name: pageToken in: query description: A page token, returned from a previous `ListTraceConfigOverrides` call. Token value that can be used to retrieve the subsequent page. When paginating, all other parameters provided to `ListTraceConfigOverrides` must match those specified in the call to obtain the page token. style: form explode: true schema: type: string - name: pageSize in: query description: Maximum number of trace configuration overrides to return. If not specified, the maximum number returned is 25. The maximum number cannot exceed 100. style: form explode: true schema: type: integer contentEncoding: int32 responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/targetservers: post: tags: - targetservers summary: CreateV1TargetserversByParent description: Creates a TargetServer in the specified environment. operationId: CreateV1TargetserversByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent environment name under which the TargetServer will be created. Must be of the form `organizations/{org}/environments/{env}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: name in: query description: Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer. style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/archiveDeployments: get: tags: - archiveDeployments summary: ListV1ArchiveDeploymentsByParent description: Lists the ArchiveDeployments in the specified Environment. operationId: ListV1ArchiveDeploymentsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the Environment for which to list Archive Deployments in the format: `organizations/{org}/environments/{env}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: filter in: query description: Optional. An optional query used to return a subset of Archive Deployments using the semantics defined in https://google.aip.dev/160. style: form explode: true schema: type: string - name: pageSize in: query description: Optional. Maximum number of Archive Deployments to return. If unspecified, at most 25 deployments will be returned. style: form explode: true schema: type: integer contentEncoding: int32 - name: pageToken in: query description: Optional. Page token, returned from a previous ListArchiveDeployments call, that you can use to retrieve the next page. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - archiveDeployments summary: CreateV1ArchiveDeploymentsByParent description: Creates a new ArchiveDeployment. operationId: CreateV1ArchiveDeploymentsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The Environment this Archive Deployment will be created in. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:generateDownloadUrl: post: tags: - archiveDeployments summary: GenerateDownloadUrlV1GenerateDownloadUrlByName description: Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL. operationId: GenerateDownloadUrlV1GenerateDownloadUrlByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: Required. The name of the Archive Deployment you want to download. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+/archiveDeployments/[^/]+$ type: string requestBody: description: '' content: text/plain: schema: type: object contentMediaType: text/plain required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/archiveDeployments:generateUploadUrl: post: tags: - archiveDeployments summary: GenerateUploadUrlV1ArchiveDeploymentsGenerateUploadUrl description: 'Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,1073741824` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`' operationId: GenerateUploadUrlV1ArchiveDeploymentsGenerateUploadUrl parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The organization and environment to upload to. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: text/plain: schema: type: object contentMediaType: text/plain required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/resourcefiles/{type}/{name}: put: tags: - resourcefiles summary: UpdateV1ResourcefilesNameByParentAndType description: Updates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). operationId: UpdateV1ResourcefilesNameByParentAndType parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: "Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}" required: true style: simple schema: type: string - name: parent in: path description: 'Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: type in: path description: Required. Resource file type. {{ resource_file_type }} required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleApiHttpBody' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - resourcefiles summary: GetV1ResourcefilesNameByParentAndType description: Gets the contents of a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). operationId: GetV1ResourcefilesNameByParentAndType parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: type in: path description: Required. Resource file type. {{ resource_file_type }} required: true style: simple schema: type: string - name: parent in: path description: 'Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: name in: path description: "Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}" required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleApiHttpBody' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform delete: tags: - resourcefiles summary: DeleteV1ResourcefilesNameByParentAndType description: Deletes a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). operationId: DeleteV1ResourcefilesNameByParentAndType parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: type in: path description: Required. Resource file type. {{ resource_file_type }} required: true style: simple schema: type: string - name: name in: path description: "Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}" required: true style: simple schema: type: string - name: parent in: path description: 'Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/resourcefiles/{type}: get: tags: - resourcefiles summary: ListEnvironmentResourcesV1ResourcefilesByParentAndType description: Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). operationId: ListEnvironmentResourcesV1ResourcefilesByParentAndType parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: type in: path description: Optional. Type of resource files to list. {{ resource_file_type }} required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/resourcefiles: get: tags: - resourcefiles summary: ListV1ResourcefilesByParent description: Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). operationId: ListV1ResourcefilesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: type in: query description: Optional. Type of resource files to list. {{ resource_file_type }} style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - resourcefiles summary: CreateV1ResourcefilesByParent description: Creates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). operationId: CreateV1ResourcefilesByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Name of the environment in which to create the resource file in the following format: `organizations/{org}/environments/{env}`.' required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: type in: query description: Required. Resource file type. {{ resource_file_type }} style: form explode: true schema: type: string - name: name in: query description: "Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}" style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleApiHttpBody' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/analytics/exports: get: tags: - exports summary: ListV1AnalyticsExportsByParent description: Lists the details and status of all analytics export jobs belonging to the parent organization and environment. operationId: ListV1AnalyticsExportsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform post: tags: - exports summary: CreateV1AnalyticsExportsByParent description: Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the `state` value of "enqueued". operationId: CreateV1AnalyticsExportsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Export' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/securityReports: post: tags: - securityReports summary: CreateV1SecurityReportsByParent description: Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the `state` of "enqueued" means that the request succeeded. operationId: CreateV1SecurityReportsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - securityReports summary: ListV1SecurityReportsByParent description: Return a list of Security Reports operationId: ListV1SecurityReportsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`. required: true style: simple schema: pattern: ^organizations/[^/]+/environments/[^/]+$ type: string - name: pageSize in: query description: The maximum number of security report to return in the list response. style: form explode: true schema: type: integer contentEncoding: int32 - name: submittedBy in: query description: Filter response list by user who submitted queries. style: form explode: true schema: type: string - name: from in: query description: Filter response list by returning security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'. style: form explode: true schema: type: string - name: dataset in: query description: 'Filter response list by dataset. Example: `api`, `mint`' style: form explode: true schema: type: string - name: to in: query description: Filter response list by returning security reports that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'. style: form explode: true schema: type: string - name: status in: query description: Filter response list by security reports status. style: form explode: true schema: type: string - name: pageToken in: query description: Token returned from the previous list response to fetch the next page. style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}/endpointAttachments: post: tags: - endpointAttachments summary: CreateV1EndpointAttachmentsByParent description: Creates an endpoint attachment. **Note:** Not supported for Apigee hybrid. operationId: CreateV1EndpointAttachmentsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: endpointAttachmentId in: query description: ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2. style: form explode: true schema: type: string - name: parent in: path description: Required. Organization the endpoint attachment will be created in. required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform get: tags: - endpointAttachments summary: ListV1EndpointAttachmentsByParent description: Lists the endpoint attachments in an organization. operationId: ListV1EndpointAttachmentsByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: pageToken in: query description: Optional. Page token, returned from a previous `ListEndpointAttachments` call, that you can use to retrieve the next page. style: form explode: true schema: type: string - name: pageSize in: query description: Optional. Maximum number of endpoint attachments to return. If unspecified, at most 25 attachments will be returned. style: form explode: true schema: type: integer contentEncoding: int32 - name: parent in: path description: 'Required. Name of the organization for which to list endpoint attachments. Use the following structure in your request: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:setSyncAuthorization: post: tags: - organizations summary: SetSyncAuthorizationV1SetSyncAuthorizationByName description: "Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version. To get an ETag, call [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only." operationId: SetSyncAuthorizationV1SetSyncAuthorizationByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:getProjectMapping: get: tags: - organizations summary: GetProjectMappingV1GetProjectMappingByName description: Gets the project ID and region for an Apigee organization. operationId: GetProjectMappingV1GetProjectMappingByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Apigee organization name in the following format: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{parent}: get: tags: - organizations summary: ListV1ByParent description: Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). operationId: ListV1ByParent parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: path description: 'Required. Use the following structure in your request: `organizations`' required: true style: simple schema: pattern: ^organizations$ type: string responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{name}:getSyncAuthorization: post: tags: - organizations summary: GetSyncAuthorizationV1GetSyncAuthorizationByName description: "Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only." operationId: GetSyncAuthorizationV1GetSyncAuthorizationByName parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: name in: path description: 'Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: text/plain: schema: type: object contentMediaType: text/plain required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/organizations: post: tags: - organizations summary: CreateV1Organizations description: Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). operationId: CreateV1Organizations parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: parent in: query description: 'Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: `projects/`' style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] /v1/{org}:setAddons: post: tags: - organizations summary: SetAddonsV1SetAddonsByOrg description: Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced. operationId: SetAddonsV1SetAddonsByOrg parameters: - name: callback in: query description: JSONP style: form explode: true schema: type: string - name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. style: form explode: true schema: type: string - name: alt in: query description: 'Data format for response. (Acceptable values are: "json", "media", "proto")' style: form explode: true schema: type: string default: json - name: uploadType in: query description: Legacy upload protocol for media (e.g. "media", "multipart"). style: form explode: true schema: type: string - name: upload_protocol in: query description: Upload protocol for media (e.g. "raw", "multipart"). style: form explode: true schema: type: string - name: fields in: query description: Selector specifying which fields to include in a partial response. style: form explode: true schema: type: string - name: access_token in: query description: OAuth access token. style: form explode: true schema: type: string - name: $.xgafv in: query description: 'V1 error format. (Acceptable values are: "1", "2")' style: form explode: true schema: type: string default: '1' - name: quotaUser in: query description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. style: form explode: true schema: type: string - name: prettyPrint in: query description: Returns response with indentations and line breaks. style: form explode: true schema: type: boolean default: true - name: oauth_token in: query description: OAuth 2.0 token for the current user. style: form explode: true schema: type: string - name: org in: path description: 'Required. Name of the organization. Use the following structure in your request: `organizations/{org}`' required: true style: simple schema: pattern: ^organizations/[^/]+$ type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' required: true responses: '200': description: '' headers: {} content: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' deprecated: false security: - httpBearer: - https://www.googleapis.com/auth/cloud-platform parameters: [] components: schemas: GoogleIamV1AuditLogConfig: title: GoogleIamV1AuditLogConfig type: object properties: logType: allOf: - $ref: '#/components/schemas/LogType' - description: The log type that this config enables. exemptedMembers: type: array items: type: string description: Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. description: "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging." GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: title: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute type: object properties: basepath: type: string description: Base path in the routing table. percentage: type: integer description: Percentage of ingress replicas reporting this route. contentEncoding: int32 envgroup: type: string description: Environment group where this route is installed. environment: type: string description: Destination environment. This will be empty if the route is not yet reported. description: Route deployed in the ingress routing table. GoogleTypeExpr: title: GoogleTypeExpr type: object properties: location: type: string description: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. expression: type: string description: Textual representation of an expression in Common Expression Language syntax. title: type: string description: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. description: type: string description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. description: "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information." GoogleCloudApigeeV1RatePlan: title: GoogleCloudApigeeV1RatePlan type: object properties: revenueShareRates: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' description: Details of the revenue sharing model. paymentFundingModel: allOf: - $ref: '#/components/schemas/PaymentFundingModel' - description: 'DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, use the `billingType` field inside `DeveloperMonetizationConfig` resource. Flag that specifies the billing account type, prepaid or postpaid.' endTime: type: string description: Time when the rate plan will expire in milliseconds since epoch. Set to 0 or `null` to indicate that the rate plan should never expire. lastModifiedAt: type: string description: Output only. Time the rate plan was last modified in milliseconds since epoch. state: allOf: - $ref: '#/components/schemas/State' - description: Current state of the rate plan (draft or published). description: type: string description: Description of the rate plan. createdAt: type: string description: Output only. Time that the rate plan was created in milliseconds since epoch. consumptionPricingRates: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' description: 'API call volume ranges and the fees charged when the total number of API calls is within a given range. The method used to calculate the final fee depends on the selected pricing model. For example, if the pricing model is `STAIRSTEP` and the ranges are defined as follows: ``` { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": 200, "fee": 100 }, } ``` Then the following fees would be charged based on the total number of API calls (assuming the currency selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.' revenueShareType: allOf: - $ref: '#/components/schemas/RevenueShareType' - description: Method used to calculate the revenue that is shared with developers. fixedRecurringFee: allOf: - $ref: '#/components/schemas/GoogleTypeMoney' - description: Represents an amount of money with its currency type. name: type: string description: Output only. Name of the rate plan. setupFee: allOf: - $ref: '#/components/schemas/GoogleTypeMoney' - description: Represents an amount of money with its currency type. apiproduct: type: string description: Name of the API product that the rate plan is associated with. displayName: type: string description: Display name of the rate plan. currencyCode: type: string description: Currency to be used for billing. Consists of a three-letter code as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. consumptionPricingType: allOf: - $ref: '#/components/schemas/ConsumptionPricingType' - description: Pricing model used for consumption-based charges. fixedFeeFrequency: type: integer description: Frequency at which the fixed fee is charged. contentEncoding: int32 startTime: type: string description: Time when the rate plan becomes active in milliseconds since epoch. billingPeriod: allOf: - $ref: '#/components/schemas/BillingPeriod' - description: Frequency at which the customer will be billed. description: Rate plan details. GoogleCloudApigeeV1GraphQLOperation: title: GoogleCloudApigeeV1GraphQLOperation type: object properties: operation: type: string description: GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload. operationTypes: type: array items: type: string description: 'Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types.' description: Represents the pairing of GraphQL operation types and the GraphQL operation name. GoogleCloudApigeeV1ResourceConfig: title: GoogleCloudApigeeV1ResourceConfig type: object properties: name: type: string description: 'Resource name in the following format: `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` Only environment-scoped resource files are supported.' location: type: string description: Location of the resource as a URI. GoogleCloudApigeeV1ListEnvironmentResourcesResponse: title: GoogleCloudApigeeV1ListEnvironmentResourcesResponse type: object properties: resourceFile: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' description: List of resources files. description: Response for ListEnvironmentResources GoogleCloudApigeeV1MetricAggregation: title: GoogleCloudApigeeV1MetricAggregation type: object properties: aggregation: allOf: - $ref: '#/components/schemas/Aggregation' - description: Aggregation function associated with the metric. name: type: string description: Name of the metric order: allOf: - $ref: '#/components/schemas/Order' - description: Ordering for this aggregation in the result. For time series this is ignored since the ordering of points depends only on the timestamp, not the values. description: The optionally aggregated metric to query with its ordering. GoogleCloudApigeeV1OrganizationProjectMapping: title: GoogleCloudApigeeV1OrganizationProjectMapping type: object properties: organization: type: string description: Name of the Apigee organization. projectId: type: string description: GCP project associated with the Apigee organization location: type: string description: Output only. The Google Cloud region where control plane data is located. For more information, see https://cloud.google.com/about/locations/. projectIds: type: array items: type: string description: 'DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a single project.' GoogleCloudApigeeV1Subscription: title: GoogleCloudApigeeV1Subscription type: object properties: name: type: string description: 'Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription "projects/foo/subscription/bar"`' description: Pub/Sub subscription of an environment. GoogleCloudApigeeV1ListRatePlansResponse: title: GoogleCloudApigeeV1ListRatePlansResponse type: object properties: ratePlans: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' description: List of rate plans in an organization. nextStartKey: type: string description: Value that can be sent as `startKey` to retrieve the next page of content. If this field is omitted, there are no subsequent pages. description: Response for ListRatePlans. GoogleCloudApigeeV1CustomReport: title: GoogleCloudApigeeV1CustomReport type: object properties: chartType: type: string description: This field contains the chart type for the report offset: type: string description: 'Legacy field: not used. This field contains the offset for the data' organization: type: string description: Output only. Organization name fromTime: type: string description: 'Legacy field: not used. Contains the from time for the report' environment: type: string description: Output only. Environment name metrics: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' description: Required. This contains the list of metrics createdAt: type: string description: 'Output only. Unix time when the app was created json key: createdAt' displayName: type: string description: This is the display name for the report tags: type: array items: type: string description: 'Legacy field: not used. This field contains a list of tags associated with custom report' toTime: type: string description: 'Legacy field: not used. Contains the end time for the report' topk: type: string description: 'Legacy field: not used. This field contains the top k parameter value for restricting the result' sortByCols: type: array items: type: string description: 'Legacy field: not used much. Contains the list of sort by columns' lastModifiedAt: type: string description: 'Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt' lastViewedAt: type: string description: Output only. Last viewed time of this entity as milliseconds since epoch filter: type: string description: This field contains the filter expression sortOrder: type: string description: 'Legacy field: not used much. Contains the sort order for the sort columns' limit: type: string description: 'Legacy field: not used This field contains the limit for the result retrieved' comments: type: array items: type: string description: 'Legacy field: not used. This field contains a list of comments associated with custom report' dimensions: type: array items: type: string description: This contains the list of dimensions for the report timeUnit: type: string description: This field contains the time unit of aggregation for the report properties: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' description: This field contains report properties such as ui metadata etc. name: type: string description: Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id GoogleCloudApigeeV1EndpointAttachment: title: GoogleCloudApigeeV1EndpointAttachment type: object properties: location: type: string description: Required. Location of the endpoint attachment. connectionState: allOf: - $ref: '#/components/schemas/ConnectionState' - description: Output only. State of the endpoint attachment connection to the service attachment. state: allOf: - $ref: '#/components/schemas/State1' - description: Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use. serviceAttachment: type: string description: 'Format: projects/*/regions/*/serviceAttachments/*' host: type: string description: Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server. name: type: string description: 'Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}`' description: Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). GoogleCloudApigeeV1ListDataCollectorsResponse: title: GoogleCloudApigeeV1ListDataCollectorsResponse type: object properties: nextPageToken: type: string description: Page token that you can include in a ListDataCollectors request to retrieve the next page. If omitted, no subsequent pages exist. dataCollectors: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' description: Data collectors in the specified organization. description: Response for ListDataCollectors. GoogleCloudApigeeV1EnvironmentGroupAttachment: title: GoogleCloudApigeeV1EnvironmentGroupAttachment type: object properties: name: type: string description: ID of the environment group attachment. createdAt: type: string description: Output only. The time at which the environment group attachment was created as milliseconds since epoch. environmentGroupId: type: string description: Output only. ID of the environment group. environment: type: string description: Required. ID of the attached environment. description: EnvironmentGroupAttachment is a resource which defines an attachment of an environment to an environment group. GoogleTypeInterval: title: GoogleTypeInterval type: object properties: endTime: type: string description: Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. startTime: type: string description: Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. description: Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. GoogleCloudApigeeV1ResourceFile: title: GoogleCloudApigeeV1ResourceFile type: object properties: type: type: string description: Resource file type. {{ resource_file_type }} name: type: string description: ID of the resource file. description: Metadata about a resource file. GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: title: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse type: object properties: nextPageToken: type: string description: Next page token. values: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence' description: Results of the query returned as a JSON array. columns: type: array items: type: string description: Column names corresponding to the same order as the inner values in the stats field. description: Represents security stats result as a collection of time series sequences. GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: title: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext type: object properties: documentationLink: type: string description: Documentation link for the action. description: Action context are all the relevant details for the action. GoogleCloudApigeeV1AsyncQuery: title: GoogleCloudApigeeV1AsyncQuery type: object properties: error: type: string description: Error is set when query fails. resultRows: type: string description: ResultRows is available only after the query is completed. envgroupHostname: type: string description: Hostname is available only when query is executed at host level. name: type: string description: Asynchronous Query Name. self: type: string description: 'Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`' reportDefinitionId: type: string description: Asynchronous Report ID. result: $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' created: type: string description: Creation time of the query. executionTime: type: string description: ExecutionTime is available only after the query is completed. updated: type: string description: Last updated timestamp for the query. resultFileSize: type: string description: ResultFileSize is available only after the query is completed. queryParams: $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' state: type: string description: Query state could be "enqueued", "running", "completed", "failed". GoogleLongrunningListOperationsResponse: title: GoogleLongrunningListOperationsResponse type: object properties: nextPageToken: type: string description: The standard List next-page token. operations: type: array items: $ref: '#/components/schemas/GoogleLongrunningOperation' description: A list of operations that matches the specified filter in the request. description: The response message for Operations.ListOperations. GoogleCloudApigeeV1TlsInfo: title: GoogleCloudApigeeV1TlsInfo type: object properties: trustStore: type: string description: The resource ID of the truststore. keyAlias: type: string description: Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert. protocols: type: array items: type: string description: The TLS versioins to be used. ciphers: type: array items: type: string description: 'The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.' enabled: type: boolean description: Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled. clientAuthEnabled: type: boolean description: Optional. Enables two-way TLS. commonName: $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' ignoreValidationErrors: type: boolean description: If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails. keyStore: type: string description: Required if `client_auth_enabled` is true. The resource ID of the keystore. description: TLS configuration information for virtual hosts and TargetServers. GoogleCloudApigeeV1SetAddonsRequest: title: GoogleCloudApigeeV1SetAddonsRequest type: object properties: addonsConfig: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - description: Add-on configurations for the Apigee organization. description: Request for SetAddons. GoogleRpcPreconditionFailure: title: GoogleRpcPreconditionFailure type: object properties: violations: type: array items: $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' description: Describes all precondition violations. description: Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message. GoogleCloudApigeeV1ApiCategory: title: GoogleCloudApigeeV1ApiCategory type: object properties: requestId: type: string description: ID that can be used to find request details in the log files. status: type: string description: Status of the operation. message: type: string description: Description of the operation. errorCode: type: string description: ID that can be used to find errors in the log files. data: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryData' - description: the Api category resource. description: the Api category resource wrapped with response status, error_code etc. GoogleCloudApigeeV1MonetizationConfig: title: GoogleCloudApigeeV1MonetizationConfig type: object properties: enabled: type: boolean description: Flag that specifies whether the Monetization add-on is enabled. description: Configuration for the Monetization add-on. GoogleCloudApigeeV1NodeConfig: title: GoogleCloudApigeeV1NodeConfig type: object properties: currentAggregateNodeCount: type: string description: Output only. The current total number of gateway nodes that each environment currently has across all instances. maxNodeCount: type: string description: Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway. minNodeCount: type: string description: Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway. description: NodeConfig for setting the min/max number of nodes associated with the environment. GoogleCloudApigeeV1SecurityReportQueryMetric: title: GoogleCloudApigeeV1SecurityReportQueryMetric type: object properties: alias: type: string description: Alias for the metric. Alias will be used to replace metric name in query results. aggregationFunction: type: string description: 'Aggregation function: avg, min, max, or sum.' value: type: string description: Operand value should be provided when operator is set. name: type: string description: Required. Metric name. operator: type: string description: One of `+`, `-`, `/`, `%`, `*`. description: Metric of the Query GoogleCloudApigeeV1PodStatus: title: GoogleCloudApigeeV1PodStatus type: object properties: deploymentStatus: type: string description: 'Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment.' podName: type: string description: Name of the pod which is reporting the status. appVersion: type: string description: Version of the application running in the pod. deploymentStatusTime: type: string description: Time the deployment status was reported in milliseconds since epoch. statusCode: type: string description: Code associated with the deployment status. deploymentTime: type: string description: Time the proxy was deployed in milliseconds since epoch. podStatusTime: type: string description: Time the pod status was reported in milliseconds since epoch. podStatus: type: string description: 'Overall status of the pod (not this specific deployment). Valid values include: - `active`: Up to date. - `stale` : Recently out of date. Pods that have not reported status in a long time are excluded from the output.' statusCodeDetails: type: string description: Human-readable message associated with the status code. GoogleCloudApigeeV1CertInfo: title: GoogleCloudApigeeV1CertInfo type: object properties: subject: type: string description: X.509 subject. subjectAlternativeNames: type: array items: type: string description: X.509 subject alternative names (SANs) extension. issuer: type: string description: X.509 issuer. validFrom: type: string description: X.509 `notBefore` validity period in milliseconds since epoch. serialNumber: type: string description: X.509 serial number. isValid: type: string description: Flag that specifies whether the certificate is valid. Flag is set to `Yes` if the certificate is valid, `No` if expired, or `Not yet` if not yet valid. version: type: integer description: X.509 version. contentEncoding: int32 basicConstraints: type: string description: X.509 basic constraints extension. sigAlgName: type: string description: X.509 signatureAlgorithm. publicKey: type: string description: Public key component of the X.509 subject public key info. expiryDate: type: string description: X.509 `notAfter` validity period in milliseconds since epoch. description: X.509 certificate as defined in RFC 5280. GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: title: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence type: object properties: dimensions: type: object additionalProperties: type: string description: Map of dimensions and their values that uniquely identifies a time series sequence. points: type: array items: type: array items: {} description: List of points. First value of each inner list is a timestamp. description: A sequence of time series. GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: title: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest type: object properties: pageSize: type: integer description: Optional. The maximum number of subcomponents to be returned in a single page. The service may return fewer than this value. If unspecified, at most 100 subcomponents will be returned in a single page. contentEncoding: int32 pageToken: type: string description: Optional. A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. filters: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter' description: 'Optional. Filters are used to filter scored components. Return all the components if no filter is mentioned. Example: [{ "scorePath": "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" }, { "scorePath": "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", }] This will return components with path: "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" OR "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target"' timeRange: allOf: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. description: Request for ComputeEnvironmentScores. GoogleCloudApigeeV1ScoreComponent: title: GoogleCloudApigeeV1ScoreComponent type: object properties: calculateTime: type: string description: Time when score was calculated. scorePath: type: string description: 'Path of the component. Example: /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy' score: type: integer description: Score for the component. contentEncoding: int32 dataCaptureTime: type: string description: Time in the requested time period when data was last captured to compute the score. drilldownPaths: type: array items: type: string description: List of paths for next components. recommendations: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation' description: List of recommendations to improve API security. description: Component is an individual security element that is scored. GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: title: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest type: object properties: filter: type: string description: Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters dimensions: type: array items: type: string description: List of dimension names to group the aggregations by. If no dimensions are passed, a single trend line representing the requested metric aggregations grouped by environment is returned. timeRange: allOf: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. metrics: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' description: Required. List of metrics and their aggregations. pageToken: type: string description: Page token stands for a specific collection of time series sequences. windowSize: allOf: - $ref: '#/components/schemas/WindowSize' - description: Time buckets to group the stats by. pageSize: type: integer description: Page size represents the number of time series sequences, one per unique set of dimensions and their values. contentEncoding: int32 timestampOrder: allOf: - $ref: '#/components/schemas/TimestampOrder' - description: Order the sequences in increasing or decreasing order of timestamps. Default is descending order of timestamps (latest first). description: QueryTimeSeriesStatsRequest represents a query that returns a collection of time series sequences grouped by their values. GoogleCloudApigeeV1ListApiProductsResponse: title: GoogleCloudApigeeV1ListApiProductsResponse type: object properties: apiProduct: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' description: Lists all API product names defined for an organization. GoogleCloudApigeeV1Result: title: GoogleCloudApigeeV1Result type: object properties: headers: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Property' description: "A list of HTTP headers. for example, '\"headers\" : [ { \"name\" : \"Content-Length\", \"value\" : \"83\" }, { \"name\" : \"Content-Type\", \"value\" : \"application/json\" } ]'" properties: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Message for compatibility with legacy Edge specification for Java Properties object in JSON. timestamp: type: string description: 'Timestamp of when the result is recorded. Its format is dd-mm-yy hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"`' content: type: string description: 'Error message content. for example, "content" : "{\"fault\":{\"faultstring\":\"API timed out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}"' uRI: type: string description: 'The relative path of the api proxy. for example, `"uRI" : "/iloveapis"`' reasonPhrase: type: string description: HTTP response phrase ActionResult: type: string description: 'Type of the action result. Can be one of the five: DebugInfo, RequestMessage, ResponseMessage, ErrorMessage, VariableAccess' accessList: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Access' description: 'A list of variable access actions agaist the api proxy. Supported values: Get, Set, Remove.' verb: type: string description: HTTP method verb statusCode: type: string description: HTTP response code description: 'Result is short for "action result", could be different types identified by "action_result" field. Supported types: 1. DebugInfo : generic debug info collected by runtime recorded as a list of properties. For example, the contents could be virtual host info, state change result, or execution metadata. Required fields : properties, timestamp 2. RequestMessage: information of a http request. Contains headers, request URI and http methods type.Required fields : headers, uri, verb 3. ResponseMessage: information of a http response. Contains headers, reason phrase and http status code. Required fields : headers, reasonPhrase, statusCode 4. ErrorMessage: information of a http error message. Contains detail error message, reason phrase and status code. Required fields : content, headers, reasonPhrase, statusCode 5. VariableAccess: a list of variable access actions, can be Get, Set and Remove. Required fields : accessList' GoogleCloudApigeeV1ListAppsResponse: title: GoogleCloudApigeeV1ListAppsResponse type: object properties: app: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1App' description: '' GoogleCloudApigeeV1ListOrganizationsResponse: title: GoogleCloudApigeeV1ListOrganizationsResponse type: object properties: organizations: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' description: List of Apigee organizations and associated GCP projects. GoogleCloudApigeeV1TraceConfigOverride: title: GoogleCloudApigeeV1TraceConfigOverride type: object properties: name: type: string description: ID of the trace configuration override specified as a system-generated UUID. apiProxy: type: string description: ID of the API proxy that will have its trace configuration overridden. samplingConfig: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' - description: TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. description: A representation of a configuration override. GoogleCloudApigeeV1DataCollectorConfig: title: GoogleCloudApigeeV1DataCollectorConfig type: object properties: name: type: string description: 'Name of the data collector in the following format: `organizations/{org}/datacollectors/{datacollector}`' type: allOf: - $ref: '#/components/schemas/Type1' - description: Data type accepted by the data collector. description: Data collector and its configuration. GoogleCloudApigeeV1RuntimeTraceSamplingConfig: title: GoogleCloudApigeeV1RuntimeTraceSamplingConfig type: object properties: sampler: allOf: - $ref: '#/components/schemas/Sampler' - description: Sampler of distributed tracing. OFF is the default value. samplingRate: type: number description: Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. description: 'NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.' GoogleCloudApigeeV1ApiResponseWrapper: title: GoogleCloudApigeeV1ApiResponseWrapper type: object properties: message: type: string description: Description of the operation. requestId: type: string description: ID that can be used to find request details in the log files. errorCode: type: string description: ID that can be used to find errors in the log files. status: type: string description: Status of the operation. GoogleIamV1Policy: title: GoogleIamV1Policy type: object properties: auditConfigs: type: array items: $ref: '#/components/schemas/GoogleIamV1AuditConfig' description: Specifies cloud audit logging configuration for this policy. version: type: integer description: 'Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).' contentEncoding: int32 etag: type: string description: '`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.' bindings: type: array items: $ref: '#/components/schemas/GoogleIamV1Binding' description: Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. description: "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)." GoogleCloudApigeeV1DebugSession: title: GoogleCloudApigeeV1DebugSession type: object properties: tracesize: type: integer description: Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120. contentEncoding: int32 timeout: type: string description: Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided. validity: type: integer description: Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10. contentEncoding: int32 name: type: string description: A unique ID for this DebugSession. filter: type: string description: Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition. count: type: integer description: Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10. contentEncoding: int32 createTime: type: string description: Output only. The first transaction creation timestamp, recorded by UAP. GoogleCloudApigeeV1QueryTabularStatsRequest: title: GoogleCloudApigeeV1QueryTabularStatsRequest type: object properties: dimensions: type: array items: type: string description: Required. List of dimension names to group the aggregations by. metrics: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' description: Required. List of metrics and their aggregations. pageSize: type: integer description: Page size represents the number of rows. contentEncoding: int32 timeRange: allOf: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. pageToken: type: string description: Identifies a sequence of rows. filter: type: string description: Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters description: Request payload representing the query to be run for fetching security statistics as rows. GoogleCloudApigeeV1ListExportsResponse: title: GoogleCloudApigeeV1ListExportsResponse type: object properties: exports: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Export' description: Details of the export jobs. description: The response for ListExports GoogleCloudApigeeV1CommonNameConfig: title: GoogleCloudApigeeV1CommonNameConfig type: object properties: name: type: string matchWildCards: type: boolean GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: title: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision type: object properties: percentage: type: integer description: Percentage of MP replicas reporting this revision. contentEncoding: int32 revision: type: string description: API proxy revision reported as deployed. description: Revisions deployed in the MPs. GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: title: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse type: object properties: securityProfiles: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' description: List of security profile revisions. The revisions may be attached or unattached to any environment. nextPageToken: type: string description: A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. description: Response for ListSecurityProfileRevisions. GoogleCloudApigeeV1SecurityProfileEnvironment: title: GoogleCloudApigeeV1SecurityProfileEnvironment type: object properties: attachTime: type: string description: Output only. Time at which environment was attached to the security profile. environment: type: string description: Output only. Name of the environment. description: Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile. GoogleCloudApigeeV1OperationMetadata: title: GoogleCloudApigeeV1OperationMetadata type: object properties: warnings: type: array items: type: string description: Warnings encountered while executing the operation. state: $ref: '#/components/schemas/State2' targetResourceName: type: string description: Name of the resource for which the operation is operating on. progress: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' - description: Information about operation progress. operationType: $ref: '#/components/schemas/OperationType' description: Metadata describing an Operation. GoogleCloudApigeeV1OptimizedStatsNode: title: GoogleCloudApigeeV1OptimizedStatsNode type: object properties: data: type: array items: {} description: '' description: 'Encapsulates a data node as represented below: ``` { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics.' GoogleCloudApigeeV1SecurityProfileScoringConfig: title: GoogleCloudApigeeV1SecurityProfileScoringConfig type: object properties: description: type: string description: Description of the config. title: type: string description: Title of the config. scorePath: type: string description: Path of the component config used for scoring. description: Security configurations to manage scoring. GoogleCloudApigeeV1CanaryEvaluationMetricLabels: title: GoogleCloudApigeeV1CanaryEvaluationMetricLabels type: object properties: env: type: string description: The environment ID associated with the metrics. location: type: string description: Required. The location associated with the metrics. instance_id: type: string description: Required. The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation. description: Labels that can be used to filter Apigee metrics. GoogleCloudApigeeV1AliasRevisionConfig: title: GoogleCloudApigeeV1AliasRevisionConfig type: object properties: name: type: string description: 'Name of the alias revision included in the keystore in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}`' type: $ref: '#/components/schemas/Type2' location: type: string description: Location of the alias file. For example, a Google Cloud Storage URI. GoogleCloudApigeeV1ListDatastoresResponse: title: GoogleCloudApigeeV1ListDatastoresResponse type: object properties: datastores: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' description: A list of datastores description: The response for ListDatastores GoogleCloudApigeeV1RuntimeTraceConfig: title: GoogleCloudApigeeV1RuntimeTraceConfig type: object properties: revisionCreateTime: type: string description: The timestamp that the revision was created or updated. overrides: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' description: List of trace configuration overrides for spicific API proxies. revisionId: type: string description: Revision number which can be used by the runtime to detect if the trace config has changed between two versions. samplingConfig: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - description: 'NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.' name: type: string description: 'Name of the trace config in the following format: `organizations/{org}/environment/{env}/traceConfig`' exporter: allOf: - $ref: '#/components/schemas/Exporter' - description: Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. endpoint: type: string description: Endpoint of the exporter. description: 'NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment.' GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: title: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse type: object properties: nextPageToken: type: string description: Page token that you can include in a ListEnvironmentGroupAttachments request to retrieve the next page. If omitted, no subsequent pages exist. environmentGroupAttachments: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' description: EnvironmentGroupAttachments for the specified environment group. description: Response for ListEnvironmentGroupAttachments. GoogleCloudApigeeV1App: title: GoogleCloudApigeeV1App type: object properties: developerId: type: string description: ID of the developer. credentials: type: array items: {} description: Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products. callbackUrl: type: string description: Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. attributes: type: array items: {} description: List of attributes. lastModifiedAt: type: string description: Output only. Last modified time as milliseconds since epoch. apiProducts: type: array items: {} description: List of API products associated with the app. name: type: string description: Name of the app. scopes: type: array items: type: string description: Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app. keyExpiresIn: type: string description: "Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn" companyName: type: string description: Name of the company that owns the app. appId: type: string description: ID of the app. createdAt: type: string description: Output only. Unix time when the app was created. status: type: string description: Status of the credential. GoogleCloudApigeeV1DeveloperMonetizationConfig: title: GoogleCloudApigeeV1DeveloperMonetizationConfig type: object properties: billingType: allOf: - $ref: '#/components/schemas/BillingType' - description: Billing type. description: Monetization configuration for the developer. GoogleCloudApigeeV1KeyValueMap: title: GoogleCloudApigeeV1KeyValueMap type: object properties: name: type: string description: Required. ID of the key value map. encrypted: type: boolean description: Optional. Flag that specifies whether entry values will be encrypted. You must set this value to `true`. Apigee X and hybrid do not support unencrytped key value maps. description: Collection of key/value string pairs. GoogleCloudApigeeV1ServiceIssuersMapping: title: GoogleCloudApigeeV1ServiceIssuersMapping type: object properties: service: type: string description: String indicating the Apigee service name. emailIds: type: array items: type: string description: List of trusted issuer email ids. GoogleCloudApigeeV1ConfigVersion: title: GoogleCloudApigeeV1ConfigVersion type: object properties: majorVersion: type: integer description: Major version of the API proxy configuration schema. contentEncoding: int32 minorVersion: type: integer description: Minor version of the API proxy configuration schema. contentEncoding: int32 description: Version of the API proxy configuration schema. Currently, only 4.0 is supported. GoogleCloudApigeeV1OperationGroup: title: GoogleCloudApigeeV1OperationGroup type: object properties: operationConfigType: type: string description: Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product. operationConfigs: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' description: Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product. description: List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. GoogleCloudApigeeV1ListEndpointAttachmentsResponse: title: GoogleCloudApigeeV1ListEndpointAttachmentsResponse type: object properties: nextPageToken: type: string description: Page token that you can include in an `ListEndpointAttachments` request to retrieve the next page. If omitted, no subsequent pages exist. endpointAttachments: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' description: Endpoint attachments in the specified organization. description: Response for ListEndpointAttachments method. GoogleCloudApigeeV1Certificate: title: GoogleCloudApigeeV1Certificate type: object properties: certInfo: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' description: Chain of certificates under this name. GoogleCloudApigeeV1DeveloperBalance: title: GoogleCloudApigeeV1DeveloperBalance type: object properties: wallets: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' description: Output only. List of all wallets. Each individual wallet stores the account balance for a particular currency. description: Account balance for the developer. GoogleCloudApigeeV1ListAsyncQueriesResponse: title: GoogleCloudApigeeV1ListAsyncQueriesResponse type: object properties: queries: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' description: The asynchronous queries belong to requested resource name. description: The response for ListAsyncQueries. GoogleCloudApigeeV1Stats: title: GoogleCloudApigeeV1Stats type: object properties: metaData: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - description: Encapsulates additional information about query execution. hosts: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' description: List of query results grouped by host. environments: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' description: List of query results on the environment level. description: Encapsulates a `stats` response. GoogleCloudApigeeV1ListDebugSessionsResponse: title: GoogleCloudApigeeV1ListDebugSessionsResponse type: object properties: nextPageToken: type: string description: Page token that you can include in a ListDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist. sessions: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Session' description: Session info that includes debug session ID and the first transaction creation timestamp. GoogleIamV1Binding: title: GoogleIamV1Binding type: object properties: role: type: string description: Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. condition: description: The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). members: type: array items: type: string description: 'Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.' description: Associates `members`, or principals, with a `role`. GoogleCloudApigeeV1ReferenceConfig: title: GoogleCloudApigeeV1ReferenceConfig type: object properties: name: type: string description: 'Name of the reference in the following format: `organizations/{org}/environments/{env}/references/{reference}`' resourceName: type: string description: 'Name of the referenced resource in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` Only references to keystore resources are supported.' GoogleCloudApigeeV1ListTraceConfigOverridesResponse: title: GoogleCloudApigeeV1ListTraceConfigOverridesResponse type: object properties: nextPageToken: type: string description: Token value that can be passed as `page_token` to retrieve the next page of content. traceConfigOverrides: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' description: List all trace configuration overrides in an environment. description: Response for ListTraceConfigOverrides. GoogleCloudApigeeV1DeveloperSubscription: title: GoogleCloudApigeeV1DeveloperSubscription type: object properties: endTime: type: string description: Time when the API product subscription ends in milliseconds since epoch. name: type: string description: Output only. Name of the API product subscription. startTime: type: string description: Time when the API product subscription starts in milliseconds since epoch. apiproduct: type: string description: Name of the API product for which the developer is purchasing a subscription. createdAt: type: string description: Output only. Time when the API product subscription was created in milliseconds since epoch. lastModifiedAt: type: string description: Output only. Time when the API product subscription was last modified in milliseconds since epoch. description: Structure of a DeveloperSubscription. GoogleCloudApigeeV1TargetServerConfig: title: GoogleCloudApigeeV1TargetServerConfig type: object properties: protocol: allOf: - $ref: '#/components/schemas/Protocol' - description: The protocol used by this target server. tlsInfo: $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' name: type: string description: 'Target server revision name in the following format: `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}`' host: type: string description: Host name of the target server. port: type: integer description: Port number for the target server. contentEncoding: int32 enabled: type: boolean description: Whether the target server is enabled. An empty/omitted value for this field should be interpreted as true. GoogleCloudApigeeV1CreditDeveloperBalanceRequest: title: GoogleCloudApigeeV1CreditDeveloperBalanceRequest type: object properties: transactionId: type: string description: Each transaction_id uniquely identifies a credit balance request. If multiple requests are received with the same transaction_id, only one of them will be considered. transactionAmount: allOf: - $ref: '#/components/schemas/GoogleTypeMoney' - description: Represents an amount of money with its currency type. description: Request for CreditDeveloperBalance. GoogleCloudApigeeV1Alias: title: GoogleCloudApigeeV1Alias type: object properties: alias: type: string description: Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`. certsInfo: $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' type: allOf: - $ref: '#/components/schemas/Type3' - description: Type of alias. description: Reference to a certificate or key/certificate pair. GoogleCloudApigeeV1Access: title: GoogleCloudApigeeV1Access type: object properties: Get: {} Set: {} Remove: {} GoogleCloudApigeeV1Point: title: GoogleCloudApigeeV1Point type: object properties: id: type: string description: Name of a step in the transaction. results: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Result' description: List of results extracted from a given debug point. description: 'Point is a group of information collected by runtime plane at critical points of the message flow of the processed API request. This is a list of supported point IDs, categorized to three major buckets. For each category, debug points that we are currently supporting are listed below: - Flow status debug points: StateChange FlowInfo Condition Execution DebugMask Error - Flow control debug points: FlowCallout Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition Oauth2ServicePoint RaiseFault NodeJS The detail information of the given debug point is stored in a list of results.' GoogleCloudApigeeV1DataCollector: title: GoogleCloudApigeeV1DataCollector type: object properties: name: type: string description: ID of the data collector. Must begin with `dc_`. lastModifiedAt: type: string description: Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. createdAt: type: string description: Output only. The time at which the data collector was created in milliseconds since the epoch. type: allOf: - $ref: '#/components/schemas/Type' - description: Immutable. The type of data this data collector will collect. description: type: string description: A description of the data collector. description: Data collector configuration. GoogleRpcPreconditionFailureViolation: title: GoogleRpcPreconditionFailureViolation type: object properties: type: type: string description: The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation". subject: type: string description: The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced. description: type: string description: 'A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted".' description: A message type used to describe a single precondition failure. GoogleCloudApigeeV1ListDeveloperAppsResponse: title: GoogleCloudApigeeV1ListDeveloperAppsResponse type: object properties: app: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' description: List of developer apps and their credentials. GoogleCloudApigeeV1ListNatAddressesResponse: title: GoogleCloudApigeeV1ListNatAddressesResponse type: object properties: natAddresses: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' description: List of NAT Addresses for the instance. nextPageToken: type: string description: Page token that you can include in a ListNatAddresses request to retrieve the next page of content. If omitted, no subsequent pages exist. description: Response for ListNatAddresses. GoogleCloudApigeeV1ListHybridIssuersResponse: title: GoogleCloudApigeeV1ListHybridIssuersResponse type: object properties: issuers: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' description: Lists of hybrid services and its trusted issuer email ids. GoogleCloudApigeeV1TraceSamplingConfig: title: GoogleCloudApigeeV1TraceSamplingConfig type: object properties: sampler: allOf: - $ref: '#/components/schemas/Sampler' - description: Sampler of distributed tracing. OFF is the default value. samplingRate: type: number description: Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. description: TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. GoogleCloudApigeeV1EnvironmentGroup: title: GoogleCloudApigeeV1EnvironmentGroup type: object properties: state: allOf: - $ref: '#/components/schemas/State5' - description: Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. lastModifiedAt: type: string description: Output only. The time at which the environment group was last updated as milliseconds since epoch. hostnames: type: array items: type: string description: Required. Host names for this environment group. name: type: string description: ID of the environment group. createdAt: type: string description: Output only. The time at which the environment group was created as milliseconds since epoch. description: EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name. GoogleCloudApigeeV1ScoreComponentRecommendation: title: GoogleCloudApigeeV1ScoreComponentRecommendation type: object properties: actions: type: array items: {} description: Actions for the recommendation to improve the security score. impact: type: integer description: Potential impact of this recommendation on the overall score. This denotes how important this recommendation is to improve the score. contentEncoding: int32 description: type: string description: Description of the recommendation. title: type: string description: Title represents recommendation title. description: Recommendation based on security concerns and score. GoogleCloudApigeeV1DateRange: title: GoogleCloudApigeeV1DateRange type: object properties: end: type: string description: Required. End date (exclusive) of the data to export in the format `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- which will not be in the output. start: type: string description: Required. Start date of the data to export in the format `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start date. description: Date range of the data to export. GoogleCloudApigeeV1OptimizedStatsResponse: title: GoogleCloudApigeeV1OptimizedStatsResponse type: object properties: TimeUnit: type: array items: type: string description: List of time unit values. Time unit refers to an epoch timestamp value. metaData: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - description: Encapsulates additional information about query execution. resultTruncated: type: boolean description: Boolean flag that indicates whether the results were truncated based on the limit parameter. stats: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' - description: 'Encapsulates a data node as represented below: ``` { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics.' description: Encapsulates a response format for JavaScript Optimized Scenario. GoogleCloudApigeeV1ApiProductRef: title: GoogleCloudApigeeV1ApiProductRef type: object properties: status: type: string description: Status of the API product. Valid values are `approved` or `revoked`. apiproduct: type: string description: Name of the API product. GoogleCloudApigeeV1EnvironmentConfig: title: GoogleCloudApigeeV1EnvironmentConfig type: object properties: deployments: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' description: List of deployments in the environment. forwardProxyUri: type: string description: The forward proxy's url to be used by the runtime. When set, runtime will send requests to the target via the given forward proxy. This is only used by programmable gateways. targets: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' description: List of target servers in the environment. Disabled target servers are not displayed. arcConfigLocation: type: string description: The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. resourceReferences: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' description: List of resource references in the environment. uid: type: string description: Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated. createTime: type: string description: Time that the environment configuration was created. resources: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' description: List of resource versions in the environment. debugMask: $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' keystores: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' description: List of keystores in the environment. pubsubTopic: type: string description: Name of the PubSub topic for the environment. sequenceNumber: type: string description: 'DEPRECATED: Use revision_id.' gatewayConfigLocation: type: string description: The location for the gateway config blob as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. dataCollectors: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' description: List of data collectors used by the deployments in the environment. provider: type: string description: Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging. flowhooks: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' description: List of flow hooks in the environment. name: type: string description: 'Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}`' traceConfig: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' - description: 'NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment.' revisionId: type: string description: Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed. featureFlags: type: object additionalProperties: type: string description: Feature flags inherited from the organization and environment. GoogleCloudApigeeV1Instance: title: GoogleCloudApigeeV1Instance type: object properties: serviceAttachment: type: string description: 'Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.' location: type: string description: Required. Compute Engine location where the instance resides. ipRange: type: string description: 'Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`' state: allOf: - $ref: '#/components/schemas/State6' - description: Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. displayName: type: string description: Optional. Display name for the instance. consumerAcceptList: type: array items: type: string description: Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list. port: type: string description: Output only. Port number of the exposed Apigee endpoint. name: type: string description: Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. runtimeVersion: type: string description: Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. host: type: string description: Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. diskEncryptionKeyName: type: string description: 'Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`' description: type: string description: Optional. Description of the instance. peeringCidrRange: allOf: - $ref: '#/components/schemas/PeeringCidrRange' - description: Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. lastModifiedAt: type: string description: Output only. Time the instance was last modified in milliseconds since epoch. createdAt: type: string description: Output only. Time the instance was created in milliseconds since epoch. description: Apigee runtime instance. GoogleCloudApigeeV1InstanceDeploymentStatus: title: GoogleCloudApigeeV1InstanceDeploymentStatus type: object properties: deployedRoutes: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute' description: Current routes deployed in the ingress routing table. A route which is missing will appear in `missing_routes`. deployedRevisions: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision' description: Revisions currently deployed in MPs. instance: type: string description: ID of the instance reporting the status. description: The status of a deployment as reported by a single instance. GoogleCloudApigeeV1Operation: title: GoogleCloudApigeeV1Operation type: object properties: resource: type: string description: Required. REST resource path associated with the API proxy or remote service. methods: type: array items: type: string description: methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed. description: Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path. EdgeConfigstoreBundleBadBundle: title: EdgeConfigstoreBundleBadBundle type: object properties: violations: type: array items: $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' description: Describes all precondition violations. description: Describes why a bundle is invalid. Intended for use in error details. GoogleCloudApigeeV1DeploymentChangeReport: title: GoogleCloudApigeeV1DeploymentChangeReport type: object properties: routingConflicts: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict' description: All base path conflicts detected for a deployment request. validationErrors: allOf: - $ref: '#/components/schemas/GoogleRpcPreconditionFailure' - description: Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message. routingChanges: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange' description: All routing changes that may result from a deployment request. description: 'Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment. The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are: 1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments. 2) To warn users if some base path in the proxy will not receive traffic due to an existing deployment having already claimed that base path. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected.' GoogleCloudApigeeV1EnvironmentGroupConfig: title: GoogleCloudApigeeV1EnvironmentGroupConfig type: object properties: revisionId: type: string description: Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed. uid: type: string description: A unique id for the environment group config that will only change if the environment group is deleted and recreated. routingRules: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' description: Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments. name: type: string description: 'Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.' hostnames: type: array items: type: string description: Host names for the environment group. description: EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules. GoogleCloudApigeeV1KeyValueEntry: title: GoogleCloudApigeeV1KeyValueEntry type: object properties: name: type: string description: Resource URI that can be used to identify the scope of the key value map entries. value: type: string description: Required. Data or payload that is being retrieved and associated with the unique key. description: 'Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.' GoogleCloudApigeeV1SecurityReportResultMetadata: title: GoogleCloudApigeeV1SecurityReportResultMetadata type: object properties: self: type: string description: 'Self link of the query results. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`' expires: type: string description: 'Output only. Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"' description: Contains informations about the security report results. GoogleCloudApigeeV1ListInstancesResponse: title: GoogleCloudApigeeV1ListInstancesResponse type: object properties: nextPageToken: type: string description: Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist. instances: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' description: Instances in the specified organization. description: Response for ListInstances. GoogleCloudApigeeV1AccessRemove: title: GoogleCloudApigeeV1AccessRemove type: object properties: name: type: string success: type: boolean description: 'Remove action. For example, "Remove" : { "name" : "target.name", "success" : true }' GoogleCloudApigeeV1ListApiCategoriesResponse: title: GoogleCloudApigeeV1ListApiCategoriesResponse type: object properties: message: type: string description: Description of the operation. data: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryData' description: Details of categories. requestId: type: string description: ID that can be used to find request details in the log files. status: type: string description: Status of the operation. errorCode: type: string description: ID that can be used to find errors in the log files. description: the response for ListApiCategoriesRequest. GoogleIamV1TestIamPermissionsRequest: title: GoogleIamV1TestIamPermissionsRequest type: object properties: permissions: type: array items: type: string description: The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). description: Request message for `TestIamPermissions` method. GoogleCloudApigeeV1Reference: title: GoogleCloudApigeeV1Reference type: object properties: resourceType: type: string description: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'. name: type: string description: Required. The resource id of this reference. Values must match the regular expression [\w\s\-.]+. refers: type: string description: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type. description: type: string description: Optional. A human-readable description of this reference. description: A Reference configuration. References must refer to a keystore that also exists in the parent environment. GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: title: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse type: object properties: urls: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo' description: The list of Signed URLs generated by the CreateAsyncQuery request description: The response for GetAsyncQueryResultUrl GoogleCloudApigeeV1Attributes: title: GoogleCloudApigeeV1Attributes type: object properties: attribute: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: List of attributes. GoogleCloudApigeeV1IngressConfig: title: GoogleCloudApigeeV1IngressConfig type: object properties: revisionCreateTime: type: string description: Time at which the IngressConfig revision was created. name: type: string description: 'Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`.' revisionId: type: string description: Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed. environmentGroups: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' description: List of environment groups in the organization. uid: type: string description: A unique id for the ingress config that will only change if the organization is deleted and recreated. GoogleCloudApigeeV1Environment: title: GoogleCloudApigeeV1Environment type: object properties: forwardProxyUri: type: string description: Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of "http" or "https", and port must be supplied. createdAt: type: string description: Output only. Creation time of this environment as milliseconds since epoch. apiProxyType: allOf: - $ref: '#/components/schemas/ApiProxyType' - description: Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. properties: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Message for compatibility with legacy Edge specification for Java Properties object in JSON. description: type: string description: Optional. Description of the environment. nodeConfig: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' - description: NodeConfig for setting the min/max number of nodes associated with the environment. lastModifiedAt: type: string description: Output only. Last modification time of this environment as milliseconds since epoch. displayName: type: string description: Optional. Display name for this environment. name: type: string description: Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` state: allOf: - $ref: '#/components/schemas/State7' - description: Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. deploymentType: allOf: - $ref: '#/components/schemas/DeploymentType' - description: 'Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers' GoogleCloudApigeeV1DebugMask: title: GoogleCloudApigeeV1DebugMask type: object properties: requestXPaths: type: array items: type: string description: List of XPaths that specify the XML elements to be filtered from XML request message payloads. namespaces: type: object additionalProperties: type: string description: Map of namespaces to URIs. responseJSONPaths: type: array items: type: string description: List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads. responseXPaths: type: array items: type: string description: List of XPaths that specify the XML elements to be filtered from XML response message payloads. requestJSONPaths: type: array items: type: string description: List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads. faultJSONPaths: type: array items: type: string description: List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows. name: type: string description: Name of the debug mask. faultXPaths: type: array items: type: string description: List of XPaths that specify the XML elements to be filtered from XML payloads in error flows. variables: type: array items: type: string description: List of variables that should be masked from the debug output. GoogleCloudApigeeV1Session: title: GoogleCloudApigeeV1Session type: object properties: timestampMs: type: string description: The first transaction creation timestamp in millisecond, recorded by UAP. id: type: string description: The debug session ID. description: Session carries the debug session id and its creation time. GoogleCloudApigeeV1ArchiveDeployment: title: GoogleCloudApigeeV1ArchiveDeployment type: object properties: name: type: string description: 'Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`.' labels: type: object additionalProperties: type: string description: 'User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' updatedAt: type: string description: Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. createdAt: type: string description: Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. operation: type: string description: 'Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}`' gcsUri: type: string description: Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. description: Archive Deployment information. GoogleCloudApigeeV1QueryMetadata: title: GoogleCloudApigeeV1QueryMetadata type: object properties: timeUnit: type: string description: Query GroupBy time unit. dimensions: type: array items: type: string description: Dimensions of the AsyncQuery. startTimestamp: type: string description: Start timestamp of the query range. endTimestamp: type: string description: End timestamp of the query range. outputFormat: type: string description: Output format. metrics: type: array items: type: string description: 'Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]' GoogleCloudApigeeV1Keystore: title: GoogleCloudApigeeV1Keystore type: object properties: name: type: string description: Required. Resource ID for this keystore. Values must match the regular expression `[\w[:space:].-]{1,255}`. aliases: type: array items: type: string description: Output only. Aliases in this keystore. description: Datastore for Certificates and Aliases. GoogleCloudApigeeV1Developer: title: GoogleCloudApigeeV1Developer type: object properties: status: type: string description: Output only. Status of the developer. Valid values are `active` and `inactive`. organizationName: type: string description: Output only. Name of the Apigee organization in which the developer resides. apps: type: array items: type: string description: List of apps associated with the developer. accessType: type: string description: Access type. email: type: string description: Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only. lastName: type: string description: Required. Last name of the developer. appFamily: type: string description: Developer app family. attributes: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: Optional. Developer attributes (name/value pairs). The custom attribute limit is 18. lastModifiedAt: type: string description: Output only. Time at which the developer was last modified in milliseconds since epoch. companies: type: array items: type: string description: List of companies associated with the developer. userName: type: string description: Required. User name of the developer. Not used by Apigee hybrid. firstName: type: string description: Required. First name of the developer. createdAt: type: string description: Output only. Time at which the developer was created in milliseconds since epoch. developerId: type: string description: 'ID of the developer. **Note**: IDs are generated internally by Apigee and are not guaranteed to stay the same over time.' GoogleCloudApigeeV1Organization: title: GoogleCloudApigeeV1Organization type: object properties: properties: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Message for compatibility with legacy Edge specification for Java Properties object in JSON. displayName: type: string description: Display name for the Apigee organization. Unused, but reserved for future use. runtimeType: allOf: - $ref: '#/components/schemas/RuntimeType' - description: Required. Runtime type of the Apigee organization based on the Apigee subscription purchased. apigeeProjectId: type: string description: Output only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee. projectId: type: string description: Output only. Project ID associated with the Apigee organization. portalDisabled: type: boolean description: Configuration for the Portals settings. caCertificate: type: string description: Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType](#RuntimeType) is `CLOUD`. runtimeDatabaseEncryptionKeyName: type: string description: 'Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. Required when [RuntimeType](#RuntimeType) is `CLOUD`. If not specified when [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** Not supported for Apigee hybrid.' billingType: allOf: - $ref: '#/components/schemas/BillingType1' - description: Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing). state: allOf: - $ref: '#/components/schemas/State8' - description: Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use. createdAt: type: string description: Output only. Time that the Apigee organization was created in milliseconds since epoch. environments: type: array items: type: string description: Output only. List of environments in the Apigee organization. expiresAt: type: string description: Output only. Time that the Apigee organization is scheduled for deletion. description: type: string description: Description of the Apigee organization. name: type: string description: Output only. Name of the Apigee organization. attributes: type: array items: type: string description: Not used by Apigee. authorizedNetwork: type: string description: 'Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: `default`. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See [Shared VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` **Note:** Not supported for Apigee hybrid.' subscriptionType: allOf: - $ref: '#/components/schemas/SubscriptionType' - description: 'Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/).' lastModifiedAt: type: string description: Output only. Time that the Apigee organization was last modified in milliseconds since epoch. addonsConfig: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - description: Add-on configurations for the Apigee organization. type: allOf: - $ref: '#/components/schemas/Type4' - description: Not used by Apigee. customerName: type: string description: Not used by Apigee. analyticsRegion: type: string description: 'Required. DEPRECATED: This field will be deprecated once Apigee supports DRZ. Primary GCP region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).' GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: title: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo type: object properties: md5: type: string description: The MD5 Hash of the JSON data uri: type: string description: The signed URL of the JSON data. Will be of the form `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 2ea7abedc098d2eb14a7` sizeBytes: type: string description: The size of the returned file in bytes description: A Signed URL and the relevant metadata associated with it. GoogleCloudApigeeV1ListOfDevelopersResponse: title: GoogleCloudApigeeV1ListOfDevelopersResponse type: object properties: developer: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' description: List of developers. EdgeConfigstoreBundleBadBundleViolation: title: EdgeConfigstoreBundleBadBundleViolation type: object properties: description: type: string description: A description of why the bundle is invalid and how to fix it. filename: type: string description: The filename (including relative path from the bundle root) in which the error occurred. description: A message type used to describe a single bundle validation error. GoogleCloudApigeeV1ListSecurityReportsResponse: title: GoogleCloudApigeeV1ListSecurityReportsResponse type: object properties: nextPageToken: type: string description: If the number of security reports exceeded the page size requested, the token can be used to fetch the next page in a subsequent call. If the response is the last page and there are no more reports to return this field is left empty. securityReports: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' description: The security reports belong to requested resource name. description: The response for SecurityReports. GoogleCloudApigeeV1CanaryEvaluation: title: GoogleCloudApigeeV1CanaryEvaluation type: object properties: control: type: string description: Required. The stable version that is serving requests. createTime: type: string description: Output only. Create time of the canary evaluation. metricLabels: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' - description: Labels that can be used to filter Apigee metrics. verdict: allOf: - $ref: '#/components/schemas/Verdict' - description: 'Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.' treatment: type: string description: Required. The newer version that is serving requests. endTime: type: string description: Required. End time for the evaluation's analysis. name: type: string description: Output only. Name of the canary evalution. state: allOf: - $ref: '#/components/schemas/State9' - description: Output only. The current state of the canary evaluation. startTime: type: string description: Required. Start time for the canary evaluation's analysis. description: CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests. GoogleCloudApigeeV1ApiSecurityConfig: title: GoogleCloudApigeeV1ApiSecurityConfig type: object properties: enabled: type: boolean description: Flag that specifies whether the API security add-on is enabled. expiresAt: type: string description: Output only. Time at which the API Security add-on expires in in milliseconds since epoch. If unspecified, the add-on will never expire. description: Configurations of the API Security add-on. GoogleCloudApigeeV1Query: title: GoogleCloudApigeeV1Query type: object properties: groupByTimeUnit: type: string description: 'Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.' reportDefinitionId: type: string description: Asynchronous Report ID. metrics: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' description: A list of Metrics. outputFormat: type: string description: 'Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.' dimensions: type: array items: type: string description: A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions csvDelimiter: type: string description: Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\t`). timeRange: description: 'Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }' limit: type: integer description: Maximum number of rows that can be returned in the result. contentEncoding: int32 envgroupHostname: type: string description: Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname. filter: type: string description: Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax name: type: string description: Asynchronous Query Name. GoogleCloudApigeeV1SyncAuthorization: title: GoogleCloudApigeeV1SyncAuthorization type: object properties: etag: type: string description: "Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](organizations/getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](organizations/setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions." identities: type: array items: type: string description: 'Required. Array of service accounts to grant access to control plane resources, each specified using the following format: `serviceAccount:` service-account-name. The service-account-name is formatted like an email address. For example: `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts).' GoogleCloudApigeeV1AccessGet: title: GoogleCloudApigeeV1AccessGet type: object properties: name: type: string value: type: string description: 'Get action. For example, "Get" : { "name" : "target.name", "value" : "default" }' GoogleCloudApigeeV1ListArchiveDeploymentsResponse: title: GoogleCloudApigeeV1ListArchiveDeploymentsResponse type: object properties: archiveDeployments: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' description: Archive Deployments in the specified environment. nextPageToken: type: string description: Page token that you can include in a ListArchiveDeployments request to retrieve the next page. If omitted, no subsequent pages exist. description: Response for ListArchiveDeployments method. GoogleCloudApigeeV1UpdateError: title: GoogleCloudApigeeV1UpdateError type: object properties: resource: type: string description: The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource. code: allOf: - $ref: '#/components/schemas/Code' - description: Status code. message: type: string description: User-friendly error message. type: type: string description: A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances. description: Details on why a resource update failed in the runtime. GoogleCloudApigeeV1SecurityReport: title: GoogleCloudApigeeV1SecurityReport type: object properties: updated: type: string description: Output only. Last updated timestamp for the query. resultRows: type: string description: ResultRows is available only after the query is completed. envgroupHostname: type: string description: Hostname is available only when query is executed at host level. displayName: type: string description: Display Name specified by the user. reportDefinitionId: type: string description: Report Definition ID. state: type: string description: Query state could be "enqueued", "running", "completed", "expired" and "failed". error: type: string description: Error is set when query fails. resultFileSize: type: string description: ResultFileSize is available only after the query is completed. queryParams: description: Contains information like metrics, dimenstions etc of the Security Report. created: type: string description: Creation time of the query. self: type: string description: 'Self link of the query. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`' executionTime: type: string description: ExecutionTime is available only after the query is completed. result: description: Result is available only after the query is completed. description: SecurityReport saves all the information about the created security report. GoogleCloudApigeeV1EntityMetadata: title: GoogleCloudApigeeV1EntityMetadata type: object properties: lastModifiedAt: type: string description: Time at which the API proxy was most recently modified, in milliseconds since epoch. subType: type: string description: The type of entity described createdAt: type: string description: Time at which the API proxy was created, in milliseconds since epoch. description: Metadata common to many entities in this API. GoogleRpcStatus: title: GoogleRpcStatus type: object properties: message: type: string description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. code: type: integer description: The status code, which should be an enum value of google.rpc.Code. contentEncoding: int32 details: type: array items: {} description: A list of messages that carry the error details. There is a common set of message types for APIs to use. description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).' GoogleCloudApigeeV1AsyncQueryResultView: title: GoogleCloudApigeeV1AsyncQueryResultView type: object properties: error: type: string description: Error message when there is a failure. state: type: string description: State of retrieving ResultView. metadata: $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' rows: type: array items: {} description: 'Rows of query result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…}' code: type: integer description: Error code when there is a failure. contentEncoding: int32 GoogleCloudApigeeV1SecurityReportMetadata: title: GoogleCloudApigeeV1SecurityReportMetadata type: object properties: metrics: type: array items: type: string description: 'Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]' endTimestamp: type: string description: End timestamp of the query range. startTimestamp: type: string description: Start timestamp of the query range. mimeType: type: string description: MIME type / Output format. dimensions: type: array items: type: string description: Dimensions of the SecurityReport. timeUnit: type: string description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' description: Metadata for the security report. GoogleCloudApigeeV1Metric: title: GoogleCloudApigeeV1Metric type: object properties: name: type: string description: Metric name. values: type: array items: {} description: 'List of metric values. Possible value formats include: `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": 1232434354} ]`' description: 'Encapsulates the metric data point. For example: ```{ "name": "sum(message_count)", "values" : [ { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }```' GoogleCloudApigeeV1IntegrationConfig: title: GoogleCloudApigeeV1IntegrationConfig type: object properties: enabled: type: boolean description: Flag that specifies whether the Integration add-on is enabled. description: Configuration for the Integration add-on. GoogleCloudApigeeV1SharedFlow: title: GoogleCloudApigeeV1SharedFlow type: object properties: revision: type: array items: type: string description: A list of revisions of this shared flow. name: type: string description: The ID of the shared flow. metaData: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - description: Metadata common to many entities in this API. latestRevisionId: type: string description: The id of the most recently created revision for this shared flow. description: The metadata describing a shared flow GoogleCloudApigeeV1KeyAliasReference: title: GoogleCloudApigeeV1KeyAliasReference type: object properties: reference: type: string description: 'Reference name in the following format: `organizations/{org}/environments/{env}/references/{reference}`' aliasId: type: string description: Alias ID. Must exist in the keystore referred to by the reference. GoogleCloudApigeeV1OperationMetadataProgress: title: GoogleCloudApigeeV1OperationMetadataProgress type: object properties: description: type: string description: Description of the operation's progress. state: allOf: - $ref: '#/components/schemas/State3' - description: State of the operation. details: type: object additionalProperties: {} description: The additional details of the progress. percentDone: type: integer description: The percentage of the operation progress. contentEncoding: int32 description: Information about operation progress. GoogleCloudApigeeV1KeystoreConfig: title: GoogleCloudApigeeV1KeystoreConfig type: object properties: aliases: type: array items: {} description: Aliases in the keystore. name: type: string description: 'Resource name in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}`' GoogleCloudApigeeV1DeveloperApp: title: GoogleCloudApigeeV1DeveloperApp type: object properties: attributes: type: array items: {} description: List of attributes for the developer app. lastModifiedAt: type: string description: Output only. Time the developer app was modified in milliseconds since epoch. scopes: type: array items: type: string description: Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. appFamily: type: string description: Developer app family. status: type: string description: Status of the credential. Valid values include `approved` or `revoked`. keyExpiresIn: type: string description: Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. name: type: string description: Name of the developer app. callbackUrl: type: string description: Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. appId: type: string description: ID of the developer app. credentials: type: array items: {} description: Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. developerId: type: string description: ID of the developer. apiProducts: type: array items: type: string description: List of API products associated with the developer app. createdAt: type: string description: Output only. Time the developer app was created in milliseconds since epoch. GoogleCloudApigeeV1Property: title: GoogleCloudApigeeV1Property type: object properties: name: type: string description: The property key value: type: string description: The property value description: A single property entry in the Properties message. GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: title: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict type: object properties: environmentGroup: type: string description: Name of the environment group in which this conflict exists. description: type: string description: Human-readable description of this conflict. conflictingDeployment: description: Existing base path/deployment causing the conflict. description: Describes a routing conflict that may cause a deployment not to receive traffic at some base path. GoogleCloudApigeeV1Score: title: GoogleCloudApigeeV1Score type: object properties: component: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - description: Component is an individual security element that is scored. timeRange: allOf: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. subcomponents: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' description: List of all the drilldown score components. description: Represents Security Score. GoogleCloudApigeeV1Schema: title: GoogleCloudApigeeV1Schema type: object properties: metrics: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' description: List of schema fields grouped as dimensions that can be used with an aggregate function such as `sum`, `avg`, `min`, and `max`. meta: type: array items: type: string description: Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings. dimensions: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' description: List of schema fields grouped as dimensions. description: Response for Schema call GoogleCloudApigeeV1Properties: title: GoogleCloudApigeeV1Properties type: object properties: property: type: array items: {} description: List of all properties in the object description: Message for compatibility with legacy Edge specification for Java Properties object in JSON. GoogleCloudApigeeV1AdvancedApiOpsConfig: title: GoogleCloudApigeeV1AdvancedApiOpsConfig type: object properties: enabled: type: boolean description: Flag that specifies whether the Advanced API Ops add-on is enabled. description: Configuration for the Advanced API Ops add-on. GoogleCloudApigeeV1Metadata: title: GoogleCloudApigeeV1Metadata type: object properties: notices: type: array items: type: string description: 'List of additional information such as data source, if result was truncated. For example: ``` "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]```' errors: type: array items: type: string description: List of error messages as strings. description: Encapsulates additional information about query execution. GoogleIamV1TestIamPermissionsResponse: title: GoogleIamV1TestIamPermissionsResponse type: object properties: permissions: type: array items: type: string description: A subset of `TestPermissionsRequest.permissions` that the caller is allowed. description: Response message for `TestIamPermissions` method. GoogleCloudApigeeV1OptimizedStats: title: GoogleCloudApigeeV1OptimizedStats type: object properties: Response: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' - description: Encapsulates a response format for JavaScript Optimized Scenario. GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: title: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse type: object properties: developerSubscriptions: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' description: List of all subscriptions. nextStartKey: type: string description: Value that can be sent as `startKey` to retrieve the next page of content. If this field is omitted, there are no subsequent pages. description: Response for ListDeveloperSubscriptions. GoogleCloudApigeeV1DimensionMetric: title: GoogleCloudApigeeV1DimensionMetric type: object properties: metrics: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' description: List of metrics. name: type: string description: Name of the dimension. description: Encapsulates a metric grouped by dimension. GoogleCloudApigeeV1OperationConfig: title: GoogleCloudApigeeV1OperationConfig type: object properties: operations: type: array items: {} description: 'List of resource/method pairs for the API proxy or remote service to which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.' attributes: type: array items: {} description: Custom attributes associated with the operation. quota: description: Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done. apiSource: type: string description: Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated. description: Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement. GoogleCloudApigeeV1GenerateUploadUrlResponse: title: GoogleCloudApigeeV1GenerateUploadUrlResponse type: object properties: uploadUri: type: string description: The Google Cloud Storage signed URL that can be used to upload a new Archive zip file. description: Response for GenerateUploadUrl method. GoogleCloudApigeeV1AccessSet: title: GoogleCloudApigeeV1AccessSet type: object properties: value: type: string success: type: boolean name: type: string description: 'Set action. For example, "Set" : { "name" : "target.name", "success" : true, "value" : "default" }' GoogleCloudApigeeV1StatsHostStats: title: GoogleCloudApigeeV1StatsHostStats type: object properties: name: type: string description: Hostname used in query. dimensions: type: array items: {} description: List of metrics grouped under dimensions. metrics: type: array items: {} description: 'In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only the top-level metrics are provided. If dimensions are included, then there will be a top-level dimensions field under hostnames which will contain metrics values and the dimension name. Example: ``` "hosts": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" } ]``` OR ```"hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "example.com" } ]``` List of metric values.' description: 'Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "example.com" } ]```' GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: title: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter type: object properties: scorePath: type: string description: 'Optional. Return scores for this component. Example: "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source"' description: Filter scores by component path. Used custom filter instead of AIP-160 as the use cases are highly constrained and predictable. GoogleCloudApigeeV1ListDeploymentsResponse: title: GoogleCloudApigeeV1ListDeploymentsResponse type: object properties: deployments: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' description: List of deployments. GoogleCloudApigeeV1TestDatastoreResponse: title: GoogleCloudApigeeV1TestDatastoreResponse type: object properties: state: type: string description: Output only. It could be `completed` or `failed` error: type: string description: Output only. Error message of test connection failure description: The response for TestDatastore GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: title: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse type: object properties: scores: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Score' description: List of scores. One score per day. nextPageToken: type: string description: A page token, received from a previous `ComputeScore` call. Provide this to retrieve the subsequent page. description: Response for ComputeEnvironmentScores. GoogleCloudApigeeV1TlsInfoCommonName: title: GoogleCloudApigeeV1TlsInfoCommonName type: object properties: wildcardMatch: type: boolean description: Indicates whether the cert should be matched against as a wildcard cert. value: type: string description: The TLS Common Name string of the certificate. GoogleCloudApigeeV1SecurityProfile: title: GoogleCloudApigeeV1SecurityProfile type: object properties: name: type: string description: 'Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}' displayName: type: string description: Display name of the security profile. environments: type: array items: {} description: List of environments attached to security profile. minScore: type: integer description: Output only. Minimum security score that can be generated by this profile. contentEncoding: int32 revisionUpdateTime: type: string description: Output only. The time when revision was updated. revisionCreateTime: type: string description: Output only. The time when revision was created. scoringConfigs: type: array items: {} description: List of profile scoring configs in this revision. revisionPublishTime: type: string description: Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. maxScore: type: integer description: Output only. Maximum security score that can be generated by this profile. contentEncoding: int32 revisionId: type: string description: Output only. Revision ID of the security profile. description: Represents a SecurityProfile resource. GoogleCloudApigeeV1TargetServer: title: GoogleCloudApigeeV1TargetServer type: object properties: isEnabled: type: boolean description: Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. port: type: integer description: Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. contentEncoding: int32 description: type: string description: Optional. A human-readable description of this TargetServer. host: type: string description: Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. name: type: string description: Required. The resource id of this target server. Values must match the regular expression sSLInfo: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' - description: TLS configuration information for virtual hosts and TargetServers. protocol: allOf: - $ref: '#/components/schemas/Protocol1' - description: Immutable. The protocol used by this TargetServer. description: TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. GoogleCloudApigeeV1RateRange: title: GoogleCloudApigeeV1RateRange type: object properties: fee: description: Fee to charge when total number of API calls falls within this range. end: type: string description: Ending value of the range. Set to 0 or `null` for the last range of values. start: type: string description: Starting value of the range. Set to 0 or `null` for the initial range of values. description: API call volume range and the fees charged when the total number of API calls is within the range. GoogleCloudApigeeV1DeleteCustomReportResponse: title: GoogleCloudApigeeV1DeleteCustomReportResponse type: object properties: message: type: string description: The response contains only a message field. GoogleCloudApigeeV1ListCustomReportsResponse: title: GoogleCloudApigeeV1ListCustomReportsResponse type: object properties: qualifier: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' description: '' description: This message encapsulates a list of custom report definitions GoogleCloudApigeeV1RoutingRule: title: GoogleCloudApigeeV1RoutingRule type: object properties: envGroupRevision: type: string description: The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL. receiver: type: string description: 'The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.' updateTime: type: string description: The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL. environment: type: string description: 'Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`.' basepath: type: string description: URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string. GoogleCloudApigeeV1ApiProduct: title: GoogleCloudApigeeV1ApiProduct type: object properties: proxies: type: array items: type: string description: Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation. name: type: string description: 'Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product.' attributes: type: array items: {} description: Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers. displayName: type: string description: Name displayed in the UI or developer portal to developers registering for API access. quota: type: string description: Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours. scopes: type: array items: type: string description: Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product. quotaTimeUnit: type: string description: Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`. approvalType: type: string description: Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. description: type: string description: Description of the API product. Include key information about the API product that is not captured by other fields. graphqlOperationGroup: description: Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type. apiResources: type: array items: type: string description: 'Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.' operationGroup: description: Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail. createdAt: type: string description: Response only. Creation time of this environment as milliseconds since epoch. quotaInterval: type: string description: Time interval over which the number of request messages is calculated. quotaCounterScope: allOf: - $ref: '#/components/schemas/QuotaCounterScope' - description: Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself. lastModifiedAt: type: string description: Response only. Modified time of this environment as milliseconds since epoch. environments: type: array items: type: string description: Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. GoogleCloudApigeeV1ListApiProxiesResponse: title: GoogleCloudApigeeV1ListApiProxiesResponse type: object properties: proxies: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' description: '' description: To change this message, in the same CL add a change log in go/changing-api-proto-breaks-ui GoogleCloudApigeeV1Quota: title: GoogleCloudApigeeV1Quota type: object properties: interval: type: string description: Required. Time interval over which the number of request messages is calculated. timeUnit: type: string description: Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null. limit: type: string description: Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected. description: Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: title: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest type: object properties: adjustment: allOf: - $ref: '#/components/schemas/GoogleTypeMoney' - description: Represents an amount of money with its currency type. description: Request for AdjustDeveloperBalance. GoogleCloudApigeeV1ListSharedFlowsResponse: title: GoogleCloudApigeeV1ListSharedFlowsResponse type: object properties: sharedFlows: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' description: '' description: To change this message, in the same CL add a change log in go/changing-api-proto-breaks-ui GoogleCloudApigeeV1ScoreComponentRecommendationAction: title: GoogleCloudApigeeV1ScoreComponentRecommendationAction type: object properties: description: type: string description: Description of the action. actionContext: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext' - description: Action context are all the relevant details for the action. description: Action to improve security score. GoogleCloudApigeeV1ResourceFiles: title: GoogleCloudApigeeV1ResourceFiles type: object properties: resourceFile: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' description: List of resource files. description: List of resource files. GoogleCloudApigeeV1RuntimeTraceConfigOverride: title: GoogleCloudApigeeV1RuntimeTraceConfigOverride type: object properties: revisionCreateTime: type: string description: The timestamp that the revision was created or updated. apiProxy: type: string description: 'Name of the API proxy that will have its trace configuration overridden following format: `organizations/{org}/apis/{api}`' name: type: string description: 'Name of the trace config override in the following format: `organizations/{org}/environment/{env}/traceConfig/overrides/{override}`' samplingConfig: description: Trace configuration override for a specific API proxy in an environment. revisionId: type: string description: Revision number which can be used by the runtime to detect if the trace config override has changed between two versions. uid: type: string description: Unique ID for the configuration override. The ID will only change if the override is deleted and recreated. Corresponds to name's "override" field. description: 'NEXT ID: 7 Trace configuration override for a specific API proxy in an environment.' GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: title: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation type: object properties: attachTime: type: string description: Output only. The time when environment was attached to the security profile. name: type: string description: 'Immutable. Name of the profile-environment association resource. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}' securityProfileRevisionId: type: string description: Revision ID of the security profile. description: Represents a SecurityProfileEnvironmentAssociation resource. GoogleCloudApigeeV1ListInstanceAttachmentsResponse: title: GoogleCloudApigeeV1ListInstanceAttachmentsResponse type: object properties: nextPageToken: type: string description: Page token that you can include in a ListInstanceAttachments request to retrieve the next page of content. If omitted, no subsequent pages exist. attachments: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' description: Attachments for the instance. description: Response for ListInstanceAttachments. GoogleCloudApigeeV1Credential: title: GoogleCloudApigeeV1Credential type: object properties: scopes: type: array items: type: string description: List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. status: type: string description: Status of the credential. Valid values include `approved` or `revoked`. expiresAt: type: string description: Time the credential will expire in milliseconds since epoch. apiProducts: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' description: List of API products this credential can be used for. issuedAt: type: string description: Time the credential was issued in milliseconds since epoch. consumerKey: type: string description: Consumer key. attributes: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: List of attributes associated with this credential. consumerSecret: type: string description: Secret key. GoogleCloudApigeeV1TraceConfig: title: GoogleCloudApigeeV1TraceConfig type: object properties: endpoint: type: string description: Required. Endpoint of the exporter. samplingConfig: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' - description: TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. exporter: allOf: - $ref: '#/components/schemas/Exporter1' - description: Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. description: TraceConfig defines the configurations in an environment of distributed trace. GoogleCloudApigeeV1ReportInstanceStatusRequest: title: GoogleCloudApigeeV1ReportInstanceStatusRequest type: object properties: instanceUid: type: string description: A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID. reportTime: type: string description: The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it's status reports so that clock skew does not play a factor. resources: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' description: Status for config resources description: Request for ReportInstanceStatus. GoogleCloudApigeeV1DeploymentConfig: title: GoogleCloudApigeeV1DeploymentConfig type: object properties: serviceAccount: type: string description: 'The service account identity associated with this deployment. If non-empty, will be in the following format: `projects/-/serviceAccounts/{account_email}`' basePath: type: string description: Base path where the application will be hosted. Defaults to "/". location: type: string description: Location of the API proxy bundle as a URI. name: type: string description: 'Name of the API or shared flow revision to be deployed in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`' attributes: type: object additionalProperties: type: string description: Additional key-value metadata for the deployment. proxyUid: type: string description: Unique ID of the API proxy revision. uid: type: string description: Unique ID. The ID will only change if the deployment is deleted and recreated. description: 'NEXT ID: 9' GoogleCloudApigeeV1RevenueShareRange: title: GoogleCloudApigeeV1RevenueShareRange type: object properties: end: type: string description: Ending value of the range. Set to 0 or `null` for the last range of values. start: type: string description: Starting value of the range. Set to 0 or `null` for the initial range of values. sharePercentage: type: number description: Percentage of the revenue to be shared with the developer. For example, to share 21 percent of the total revenue with the developer, set this value to 21. Specify a decimal number with a maximum of two digits following the decimal point. description: API call volume range and the percentage of revenue to share with the developer when the total number of API calls is within the range. GoogleCloudApigeeV1AsyncQueryResult: title: GoogleCloudApigeeV1AsyncQueryResult type: object properties: expires: type: string description: Query result will be unaccessable after this time. self: type: string description: 'Self link of the query results. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`' GoogleCloudApigeeV1QueryTabularStatsResponse: title: GoogleCloudApigeeV1QueryTabularStatsResponse type: object properties: values: type: array items: type: array items: {} description: Resultant rows from the executed query. columns: type: array items: type: string description: Column names corresponding to the same order as the inner values in the stats field. nextPageToken: type: string description: Next page token. description: Encapsulates two kinds of stats that are results of the dimensions and aggregations requested. - Tabular rows. - Time series data. Example of tabular rows, Represents security stats results as a row of flat values. GoogleCloudApigeeV1SecurityReportResultView: title: GoogleCloudApigeeV1SecurityReportResultView type: object properties: metadata: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' - description: Metadata for the security report. error: type: string description: Error message when there is a failure. code: type: integer description: Error code when there is a failure. contentEncoding: int32 rows: type: array items: {} description: 'Rows of security report result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…}' state: type: string description: State of retrieving ResultView. description: The response for security report result view APIs. GoogleCloudApigeeV1DeveloperBalanceWallet: title: GoogleCloudApigeeV1DeveloperBalanceWallet type: object properties: lastCreditTime: type: string description: Output only. Time at which the developer last added credit to the account in milliseconds since epoch. balance: description: Current remaining balance of the developer for a particular currency. description: Wallet used to manage an account balance for a particular currency. GoogleCloudApigeeV1QueryMetric: title: GoogleCloudApigeeV1QueryMetric type: object properties: value: type: string description: Operand value should be provided when operator is set. alias: type: string description: Alias for the metric. Alias will be used to replace metric name in query results. name: type: string description: Required. Metric name. function: type: string description: 'Aggregation function: avg, min, max, or sum.' operator: type: string description: One of `+`, `-`, `/`, `%`, `*`. description: 'More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics' GoogleCloudApigeeV1FlowHook: title: GoogleCloudApigeeV1FlowHook type: object properties: continueOnError: type: boolean description: Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to `true` to continue execution. Set to `false` to stop execution if the flow hook throws an exception. Defaults to `true`. flowHookPoint: type: string description: Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. description: type: string description: Description of the flow hook. sharedFlow: type: string description: Shared flow attached to this flow hook, or empty if there is none attached. GoogleCloudApigeeV1ResourceStatus: title: GoogleCloudApigeeV1ResourceStatus type: object properties: revisions: type: array items: {} description: Revisions of the resource currently deployed in the instance. resource: type: string description: 'The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig' uid: type: string description: The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses. totalReplicas: type: integer description: The total number of replicas that should have this resource. contentEncoding: int32 description: The status of a resource loaded in the runtime. GoogleCloudApigeeV1ListSecurityProfilesResponse: title: GoogleCloudApigeeV1ListSecurityProfilesResponse type: object properties: nextPageToken: type: string description: A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. securityProfiles: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' description: List of security profiles in the organization. The profiles may be attached or unattached to any environment. This will return latest revision of each profile. description: Response for ListSecurityProfiles. GoogleCloudApigeeV1Datastore: title: GoogleCloudApigeeV1Datastore type: object properties: datastoreConfig: description: Datastore Configurations. targetType: type: string description: Destination storage type. Supported types `gcs` or `bigquery`. createTime: type: string description: Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z lastUpdateTime: type: string description: Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z org: type: string description: Output only. Organization that the datastore belongs to displayName: type: string description: Required. Display name in UI self: type: string description: 'Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`' description: The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository. GoogleLongrunningOperation: title: GoogleLongrunningOperation type: object properties: name: type: string description: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. done: type: boolean description: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. error: description: The error result of the operation in case of failure or cancellation. response: type: object additionalProperties: {} description: The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. metadata: type: object additionalProperties: {} description: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. description: This resource represents a long-running operation that is the result of a network API call. GoogleCloudApigeeV1SharedFlowRevision: title: GoogleCloudApigeeV1SharedFlowRevision type: object properties: type: type: string description: The string "Application" name: type: string description: The resource ID of the parent shared flow. description: type: string description: Description of the shared flow revision. createdAt: type: string description: Time at which this shared flow revision was created, in milliseconds since epoch. entityMetaDataAsProperties: type: object additionalProperties: type: string description: A Key-Value map of metadata about this shared flow revision. displayName: type: string description: The human readable name of this shared flow. resources: type: array items: type: string description: A list of the resources included in this shared flow revision formatted as "{type}://{name}". revision: type: string description: The resource ID of this revision. contextInfo: type: string description: A textual description of the shared flow revision. sharedFlows: type: array items: type: string description: A list of the shared flow names included in this shared flow revision. resourceFiles: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - description: List of resource files. policies: type: array items: type: string description: A list of policy names included in this shared flow revision. lastModifiedAt: type: string description: Time at which this shared flow revision was most recently modified, in milliseconds since epoch. configurationVersion: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' - description: Version of the API proxy configuration schema. Currently, only 4.0 is supported. description: The metadata describing a shared flow revision. GoogleCloudApigeeV1StatsEnvironmentStats: title: GoogleCloudApigeeV1StatsEnvironmentStats type: object properties: dimensions: type: array items: {} description: List of metrics grouped under dimensions. metrics: type: array items: {} description: 'In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only top-level metrics is provided. If dimensions are included, then there will be a top-level dimensions field under environments which will contain metrics values and the dimension name. Example: ``` "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values.' name: type: string description: Name of the environment. description: 'Encapsulates the environment wrapper: ``` "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]```' GoogleCloudApigeeV1GraphQLOperationGroup: title: GoogleCloudApigeeV1GraphQLOperationGroup type: object properties: operationConfigType: type: string description: Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product. operationConfigs: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' description: Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product. description: List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. GoogleCloudApigeeV1AddonsConfig: title: GoogleCloudApigeeV1AddonsConfig type: object properties: apiSecurityConfig: description: Configuration for the API Security add-on. integrationConfig: description: Configuration for the Integration add-on. advancedApiOpsConfig: description: Configuration for the Advanced API Ops add-on. connectorsPlatformConfig: description: Configuration for the Connectors Platform add-on. monetizationConfig: description: Configuration for the Monetization add-on. description: Add-on configurations for the Apigee organization. GoogleCloudApigeeV1ExportRequest: title: GoogleCloudApigeeV1ExportRequest type: object properties: csvDelimiter: type: string description: Optional. Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\t`). outputFormat: type: string description: 'Optional. Output format of the export. Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the `csvDelimiter` property.' dateRange: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' - description: Date range of the data to export. description: type: string description: Optional. Description of the export job. name: type: string description: Required. Display name of the export job. datastoreName: type: string description: Required. Name of the preconfigured datastore. description: Request body for [CreateExportRequest] GoogleCloudApigeeV1TlsInfoConfig: title: GoogleCloudApigeeV1TlsInfoConfig type: object properties: keyAlias: type: string description: 'Name of the alias used for client-side authentication in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`' clientAuthEnabled: type: boolean description: Flag that specifies whether client-side authentication is enabled for the target server. Enables two-way TLS. trustStore: type: string description: 'Name of the keystore or keystore reference containing trusted certificates for the server in the following format: `organizations/{org}/environments/{env}/keystores/{keystore}` or `organizations/{org}/environments/{env}/references/{reference}`' enabled: type: boolean description: Flag that specifies whether one-way TLS is enabled. Set to `true` to enable one-way TLS. protocols: type: array items: type: string description: List of TLS protocols that are granted access. ignoreValidationErrors: type: boolean description: Flag that specifies whether to ignore TLS certificate validation errors. Set to `true` to ignore errors. ciphers: type: array items: type: string description: List of ciphers that are granted access. keyAliasReference: description: Reference name and alias pair to use for client-side authentication. commonName: description: Common name to validate the target server against. GoogleCloudApigeeV1RevisionStatus: title: GoogleCloudApigeeV1RevisionStatus type: object properties: errors: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' description: Errors reported when attempting to load this revision. replicas: type: integer description: The number of replicas that have successfully loaded this revision. contentEncoding: int32 revisionId: type: string description: The revision of the resource. jsonSpec: type: string description: The json content of the resource revision. Large specs should be sent individually via the spec field to avoid hitting request size limits. description: The status of a specific resource revision. GoogleCloudApigeeV1Deployment: title: GoogleCloudApigeeV1Deployment type: object properties: state: allOf: - $ref: '#/components/schemas/State10' - description: 'Current state of the deployment. **Note**: This field is displayed only when viewing deployment status.' serviceAccount: type: string description: The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`. revision: type: string description: API proxy revision. pods: type: array items: {} description: 'Status reported by runtime pods. **Note**: **This field is deprecated**. Runtime versions 1.3 and above report instance level status rather than pod status.' routeConflicts: type: array items: {} description: "Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status." instances: type: array items: {} description: 'Status reported by each runtime instance. **Note**: This field is displayed only when viewing deployment status.' apiProxy: type: string description: API proxy. deployStartTime: type: string description: Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. environment: type: string description: Environment. errors: type: array items: {} description: 'Errors reported for this deployment. Populated only when state == ERROR. **Note**: This field is displayed only when viewing deployment status.' GoogleCloudApigeeV1InstanceAttachment: title: GoogleCloudApigeeV1InstanceAttachment type: object properties: name: type: string description: Output only. ID of the attachment. environment: type: string description: ID of the attached environment. createdAt: type: string description: Output only. Time the attachment was created in milliseconds since epoch. description: InstanceAttachment represents the installation of an environment onto an instance. GoogleCloudApigeeV1ConnectorsPlatformConfig: title: GoogleCloudApigeeV1ConnectorsPlatformConfig type: object properties: expiresAt: type: string description: Output only. Time at which the Connectors Platform add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire. enabled: type: boolean description: Flag that specifies whether the Connectors Platform add-on is enabled. description: Configuration for the Connectors Platform add-on. GoogleCloudApigeeV1ApiSecurityRuntimeConfig: title: GoogleCloudApigeeV1ApiSecurityRuntimeConfig type: object properties: updateTime: type: string description: Time that the API Security Runtime configuration was updated. name: type: string description: 'Name of the environment API Security Runtime configuration resource. Format: `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig`' uid: type: string description: Unique ID for the API Security Runtime configuration. The ID will only change if the environment is deleted and recreated. revisionId: type: string description: Revision ID of the API Security Runtime configuration. The higher the value, the more recently the configuration was deployed. location: type: array items: type: string description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. description: Response for GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. GoogleCloudApigeeV1CustomReportMetric: title: GoogleCloudApigeeV1CustomReportMetric type: object properties: function: type: string description: aggregate function name: type: string description: name of the metric description: This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum GoogleCloudApigeeV1RuntimeConfig: title: GoogleCloudApigeeV1RuntimeConfig type: object properties: analyticsBucket: type: string description: Cloud Storage bucket used for uploading Analytics records. traceBucket: type: string description: Cloud Storage bucket used for uploading Trace records. tenantProjectId: type: string description: Output only. Tenant project ID associated with the Apigee organization. The tenant project is used to host Google-managed resources that are dedicated to this Apigee organization. Clients have limited access to resources within the tenant project used to support Apigee runtime instances. Access to the tenant project is managed using SetSyncAuthorization. It can be empty if the tenant project hasn't been created yet. name: type: string description: 'Name of the resource in the following format: `organizations/{org}/runtimeConfig`.' description: Runtime configuration for the organization. Response for GetRuntimeConfig. GoogleCloudApigeeV1Export: title: GoogleCloudApigeeV1Export type: object properties: description: type: string description: Description of the export job. created: type: string description: Output only. Time the export job was created. self: type: string description: 'Output only. Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`' state: type: string description: Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`. datastoreName: type: string description: Name of the datastore that is the destination of the export job [datastore] updated: type: string description: Output only. Time the export job was last updated. executionTime: type: string description: Output only. Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed since`created`, in seconds. Else, it will set to (`updated` - `created`), in seconds. name: type: string description: Display name of the export job. error: type: string description: Output only. Error is set when export fails description: Details of an export job. GoogleCloudApigeeV1SchemaSchemaProperty: title: GoogleCloudApigeeV1SchemaSchemaProperty type: object properties: createTime: type: string description: 'Time the field was created in RFC3339 string form. For example: `2016-02-26T10:23:09.592Z`.' custom: type: string description: Flag that specifies whether the field is standard in the dataset or a custom field created by the customer. `true` indicates that it is a custom field. type: type: string description: Data type of the field. description: Properties for the schema field. GoogleApiHttpBody: title: GoogleApiHttpBody type: object properties: data: type: string description: The HTTP request/response body as raw binary. extensions: type: array items: {} description: Application specific response metadata. Must be set in the first response for streaming APIs. contentType: type: string description: The HTTP Content-Type header value specifying the content type of the body. description: "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged." GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: title: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange type: object properties: description: type: string description: Human-readable description of this routing change. shouldSequenceRollout: type: boolean description: 'Set to `true` if using sequenced rollout would make this routing change safer. **Note**: This does not necessarily imply that automated sequenced rollout mode is supported for the operation.' environmentGroup: type: string description: Name of the environment group affected by this routing change. fromDeployment: description: Base path/deployment that may stop receiving some traffic. toDeployment: description: Base path/deployment that may start receiving that traffic. May be null if no deployment is able to receive the traffic. description: Describes a potential routing change that may occur as a result of some deployment operation. GoogleCloudApigeeV1ReportProperty: title: GoogleCloudApigeeV1ReportProperty type: object properties: property: type: string description: name of the property value: type: array items: {} description: property values GoogleCloudApigeeV1GenerateDownloadUrlResponse: title: GoogleCloudApigeeV1GenerateDownloadUrlResponse type: object properties: downloadUri: type: string description: The Google Cloud Storage signed URL that can be used to download the Archive zip file. description: Response for GenerateDownloadUrl method. GoogleCloudApigeeV1NatAddress: title: GoogleCloudApigeeV1NatAddress type: object properties: name: type: string description: Required. Resource ID of the NAT address. ipAddress: type: string description: Output only. The static IPV4 address. state: allOf: - $ref: '#/components/schemas/State4' - description: Output only. State of the nat address. description: Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic. GoogleCloudApigeeV1DatastoreConfig: title: GoogleCloudApigeeV1DatastoreConfig type: object properties: bucketName: type: string description: Name of the Cloud Storage bucket. Required for `gcs` target_type. path: type: string description: Path of Cloud Storage bucket Required for `gcs` target_type. datasetName: type: string description: BigQuery dataset name Required for `bigquery` target_type. tablePrefix: type: string description: Prefix of BigQuery table Required for `bigquery` target_type. projectId: type: string description: Required. GCP project in which the datastore exists description: Configuration detail for datastore GoogleCloudApigeeV1ListKeyValueEntriesResponse: title: GoogleCloudApigeeV1ListKeyValueEntriesResponse type: object properties: keyValueEntries: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' description: One or more key value map keys and values. nextPageToken: type: string description: Token that can be sent as `next_page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. description: The request structure for listing key value map keys and its corresponding values. GoogleCloudApigeeV1ProvisionOrganizationRequest: title: GoogleCloudApigeeV1ProvisionOrganizationRequest type: object properties: analyticsRegion: type: string description: Primary Cloud Platform region for analytics data storage. For valid values, see [Create an organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). Defaults to `us-west1`. authorizedNetwork: type: string description: Name of the customer project's VPC network. If provided, the network needs to be peered through Service Networking. If none is provided, the organization will have access only to the public internet. runtimeLocation: type: string description: Cloud Platform location for the runtime instance. Defaults to zone `us-west1-a`. If a region is provided, `EVAL` organizations will use the region for automatically selecting a zone for the runtime instance. description: Request for ProvisionOrganization. GoogleCloudApigeeV1DebugSessionTransaction: title: GoogleCloudApigeeV1DebugSessionTransaction type: object properties: completed: type: boolean description: Flag indicating whether a transaction is completed or not point: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Point' description: List of debug data collected by runtime plane at various defined points in the flow. description: A transaction contains all of the debug information of the entire message flow of an API call processed by the runtime plane. The information is collected and recorded at critical points of the message flow in the runtime apiproxy. GoogleCloudApigeeV1ListEnvironmentGroupsResponse: title: GoogleCloudApigeeV1ListEnvironmentGroupsResponse type: object properties: nextPageToken: type: string description: Page token that you can include in a ListEnvironmentGroups request to retrieve the next page. If omitted, no subsequent pages exist. environmentGroups: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' description: EnvironmentGroups in the specified organization. description: Response for ListEnvironmentGroups. GoogleTypeMoney: title: GoogleTypeMoney type: object properties: currencyCode: type: string description: The three-letter currency code defined in ISO 4217. nanos: type: integer description: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. contentEncoding: int32 units: type: string description: The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. description: Represents an amount of money with its currency type. GoogleCloudApigeeV1ApiProxyRevision: title: GoogleCloudApigeeV1ApiProxyRevision type: object properties: basepaths: type: array items: type: string description: Base URL of the API proxy. sharedFlows: type: array items: type: string description: List of the shared flows included in the API proxy revision. teams: type: array items: type: string description: List of the teams included in the API proxy revision. contextInfo: type: string description: Revision number, app name, and organization for the API proxy. spec: type: string description: OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store. type: type: string description: Type. Set to `Application`. Maintained for compatibility with the Apigee Edge API. entityMetaDataAsProperties: type: object additionalProperties: type: string description: Metadata describing the API proxy revision as a key-value map. description: type: string description: Description of the API proxy revision. integrationEndpoints: type: array items: type: string description: List of IntegrationEndpoints in the '/integration-endpoints' directory of the API proxy. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. policies: type: array items: type: string description: List of policy names included in the API proxy revision.. targets: type: array items: type: string description: List of the targets included in the API proxy revision. configurationVersion: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' - description: Version of the API proxy configuration schema. Currently, only 4.0 is supported. lastModifiedAt: type: string description: Time that the API proxy revision was last modified in milliseconds since epoch. proxyEndpoints: type: array items: type: string description: List of ProxyEndpoints in the `/proxies` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. resources: type: array items: type: string description: List of the resources included in the API proxy revision formatted as "{type}://{name}". displayName: type: string description: Human-readable name of the API proxy. name: type: string description: Name of the API proxy. createdAt: type: string description: Time that the API proxy revision was created in milliseconds since epoch. resourceFiles: allOf: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - description: List of resource files. proxies: type: array items: type: string description: List of proxy names included in the API proxy revision. revision: type: string description: API proxy revision. archive: type: string description: 'Output only. The archive that generated this proxy revision. This field is only present on proxy revisions that were generated by an archive. Proxies generated by archives cannot be updated, deleted, or deployed to other environments. Format: `organizations/*/environments/*/archiveDeployments/*`' targetServers: type: array items: type: string description: List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. targetEndpoints: type: array items: type: string description: List of TargetEndpoints in the `/targets` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. description: API proxy revision. GoogleCloudApigeeV1SchemaSchemaElement: title: GoogleCloudApigeeV1SchemaSchemaElement type: object properties: properties: description: 'Properties for the schema field. For example: { "createTime": "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" }' name: type: string description: Name of the field. description: Message type for the schema element GoogleCloudApigeeV1DeveloperAppKey: title: GoogleCloudApigeeV1DeveloperAppKey type: object properties: expiresAt: type: string description: Time the developer app expires in milliseconds since epoch. consumerSecret: type: string description: Secret key. expiresInSeconds: type: string description: Input only. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. issuedAt: type: string description: Time the developer app was created in milliseconds since epoch. status: type: string description: Status of the credential. Valid values include `approved` or `revoked`. scopes: type: array items: type: string description: Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app. attributes: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: List of attributes associated with the credential. apiProducts: type: array items: {} description: 'List of API products for which the credential can be used. **Note**: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.' consumerKey: type: string description: Consumer key. GoogleIamV1AuditConfig: title: GoogleIamV1AuditConfig type: object properties: auditLogConfigs: type: array items: {} description: The configuration for logging of each type of permission. service: type: string description: Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. description: 'Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.' GoogleIamV1SetIamPolicyRequest: title: GoogleIamV1SetIamPolicyRequest type: object properties: updateMask: type: string description: 'OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`' policy: allOf: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)." description: Request message for `SetIamPolicy` method. GoogleCloudApigeeV1FlowHookConfig: title: GoogleCloudApigeeV1FlowHookConfig type: object properties: name: type: string description: 'Name of the flow hook in the following format: `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, and `PostTargetFlowHook`' sharedFlowName: type: string description: 'Name of the shared flow to invoke in the following format: `organizations/{org}/sharedflows/{sharedflow}`' continueOnError: type: boolean description: Flag that specifies whether the flow should abort after an error in the flow hook. Defaults to `true` (continue on error). GoogleCloudApigeeV1Attribute: title: GoogleCloudApigeeV1Attribute type: object properties: name: type: string description: API key of the attribute. value: type: string description: Value of the attribute. description: Key-value pair to store extra metadata. GoogleCloudApigeeV1ApiCategoryData: title: GoogleCloudApigeeV1ApiCategoryData type: object properties: id: type: string description: ID of the category (a UUID). name: type: string description: Name of the category. updateTime: type: string description: Time the category was last modified in milliseconds since epoch. siteId: type: string description: Name of the portal. description: the Api category resource. GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: title: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment type: object properties: basepath: type: string description: Base path receiving traffic. apiProxy: type: string description: Name of the deployed API proxy revision containing the base path. environment: type: string description: Name of the environment in which the proxy is deployed. revision: type: string description: Name of the deployed API proxy revision containing the base path. description: Tuple representing a base path and the deployment containing it. GoogleCloudApigeeV1ApiProxy: title: GoogleCloudApigeeV1ApiProxy type: object properties: apiProxyType: allOf: - $ref: '#/components/schemas/ApiProxyType1' - description: Output only. The type of the API proxy. readOnly: type: boolean description: Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive. metaData: description: Output only. Metadata describing the API proxy. latestRevisionId: type: string description: Output only. The id of the most recently created revision for this api proxy. name: type: string description: Output only. Name of the API proxy. labels: type: object additionalProperties: type: string description: User labels applied to this API Proxy. revision: type: array items: type: string description: Output only. List of revisions defined for the API proxy. description: Metadata describing the API proxy GoogleCloudApigeeV1SecurityReportQuery: title: GoogleCloudApigeeV1SecurityReportQuery type: object properties: filter: type: string description: Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax displayName: type: string description: Security Report display name which users can specify. groupByTimeUnit: type: string description: 'Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.' metrics: type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' description: A list of Metrics. limit: type: integer description: Maximum number of rows that can be returned in the result. contentEncoding: int32 mimeType: type: string description: 'Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.' reportDefinitionId: type: string description: Report Definition ID. timeRange: description: 'Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }' envgroupHostname: type: string description: Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname. dimensions: type: array items: type: string description: A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions csvDelimiter: type: string description: Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\t`). description: Body structure when user makes a request to create a security report. GoogleCloudApigeeV1GraphQLOperationConfig: title: GoogleCloudApigeeV1GraphQLOperationConfig type: object properties: quota: description: Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done. operations: type: array items: {} description: 'Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.' attributes: type: array items: {} description: Custom attributes associated with the operation. apiSource: type: string description: Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated. description: Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement. Aggregation: title: Aggregation enum: - AGGREGATION_FUNCTION_UNSPECIFIED - AVG - SUM - MIN - MAX - COUNT_DISTINCT type: string description: Aggregation function associated with the metric. ApiProxyType: title: ApiProxyType enum: - API_PROXY_TYPE_UNSPECIFIED - PROGRAMMABLE - CONFIGURABLE type: string description: Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. ApiProxyType1: title: ApiProxyType1 enum: - API_PROXY_TYPE_UNSPECIFIED - PROGRAMMABLE - CONFIGURABLE type: string description: Output only. The type of the API proxy. BillingPeriod: title: BillingPeriod enum: - BILLING_PERIOD_UNSPECIFIED - WEEKLY - MONTHLY type: string description: Frequency at which the customer will be billed. BillingType: title: BillingType enum: - BILLING_TYPE_UNSPECIFIED - PREPAID - POSTPAID type: string description: Billing type. BillingType1: title: BillingType1 enum: - BILLING_TYPE_UNSPECIFIED - SUBSCRIPTION - EVALUATION - PAYG type: string description: Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing). Code: title: Code enum: - OK - CANCELLED - UNKNOWN - INVALID_ARGUMENT - DEADLINE_EXCEEDED - NOT_FOUND - ALREADY_EXISTS - PERMISSION_DENIED - UNAUTHENTICATED - RESOURCE_EXHAUSTED - FAILED_PRECONDITION - ABORTED - OUT_OF_RANGE - UNIMPLEMENTED - INTERNAL - UNAVAILABLE - DATA_LOSS type: string description: Status code. ConnectionState: title: ConnectionState enum: - CONNECTION_STATE_UNSPECIFIED - UNAVAILABLE - PENDING - ACCEPTED - REJECTED - CLOSED - FROZEN - NEEDS_ATTENTION type: string description: Output only. State of the endpoint attachment connection to the service attachment. ConsumptionPricingType: title: ConsumptionPricingType enum: - CONSUMPTION_PRICING_TYPE_UNSPECIFIED - FIXED_PER_UNIT - BANDED - TIERED - STAIRSTEP type: string description: Pricing model used for consumption-based charges. DeploymentType: title: DeploymentType enum: - DEPLOYMENT_TYPE_UNSPECIFIED - PROXY - ARCHIVE type: string description: 'Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers' Exporter: title: Exporter enum: - EXPORTER_UNSPECIFIED - JAEGER - CLOUD_TRACE type: string description: Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. Exporter1: title: Exporter1 enum: - EXPORTER_UNSPECIFIED - JAEGER - CLOUD_TRACE type: string description: Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. LogType: title: LogType enum: - LOG_TYPE_UNSPECIFIED - ADMIN_READ - DATA_WRITE - DATA_READ type: string description: The log type that this config enables. OperationType: title: OperationType enum: - OPERATION_TYPE_UNSPECIFIED - INSERT - DELETE - UPDATE type: string Order: title: Order enum: - ORDER_UNSPECIFIED - ASCENDING - DESCENDING type: string description: Ordering for this aggregation in the result. For time series this is ignored since the ordering of points depends only on the timestamp, not the values. PaymentFundingModel: title: PaymentFundingModel enum: - PAYMENT_FUNDING_MODEL_UNSPECIFIED - PREPAID - POSTPAID type: string description: 'DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, use the `billingType` field inside `DeveloperMonetizationConfig` resource. Flag that specifies the billing account type, prepaid or postpaid.' PeeringCidrRange: title: PeeringCidrRange enum: - CIDR_RANGE_UNSPECIFIED - SLASH_16 - SLASH_17 - SLASH_18 - SLASH_19 - SLASH_20 - SLASH_22 - SLASH_23 type: string description: Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. Protocol: title: Protocol enum: - PROTOCOL_UNSPECIFIED - HTTP - GRPC type: string description: The protocol used by this target server. Protocol1: title: Protocol1 enum: - PROTOCOL_UNSPECIFIED - HTTP - GRPC type: string description: Immutable. The protocol used by this TargetServer. QuotaCounterScope: title: QuotaCounterScope enum: - QUOTA_COUNTER_SCOPE_UNSPECIFIED - PROXY - OPERATION type: string description: Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself. RevenueShareType: title: RevenueShareType enum: - REVENUE_SHARE_TYPE_UNSPECIFIED - FIXED - VOLUME_BANDED type: string description: Method used to calculate the revenue that is shared with developers. RuntimeType: title: RuntimeType enum: - RUNTIME_TYPE_UNSPECIFIED - CLOUD - HYBRID type: string description: Required. Runtime type of the Apigee organization based on the Apigee subscription purchased. Sampler: title: Sampler enum: - SAMPLER_UNSPECIFIED - OFF - PROBABILITY type: string description: Sampler of distributed tracing. OFF is the default value. State: title: State enum: - STATE_UNSPECIFIED - DRAFT - PUBLISHED type: string description: Current state of the rate plan (draft or published). State1: title: State1 enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - UPDATING type: string description: Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use. State2: title: State2 enum: - STATE_UNSPECIFIED - NOT_STARTED - IN_PROGRESS - FINISHED type: string State3: title: State3 enum: - STATE_UNSPECIFIED - NOT_STARTED - IN_PROGRESS - FINISHED type: string description: State of the operation. State4: title: State4 enum: - STATE_UNSPECIFIED - CREATING - RESERVED - ACTIVE - DELETING type: string description: Output only. State of the nat address. State5: title: State5 enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - UPDATING type: string description: Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. State6: title: State6 enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - UPDATING type: string description: Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. State7: title: State7 enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - UPDATING type: string description: Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. State8: title: State8 enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - UPDATING type: string description: Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use. State9: title: State9 enum: - STATE_UNSPECIFIED - RUNNING - SUCCEEDED type: string description: Output only. The current state of the canary evaluation. State10: title: State10 enum: - RUNTIME_STATE_UNSPECIFIED - READY - PROGRESSING - ERROR type: string description: 'Current state of the deployment. **Note**: This field is displayed only when viewing deployment status.' SubscriptionType: title: SubscriptionType enum: - SUBSCRIPTION_TYPE_UNSPECIFIED - PAID - TRIAL type: string description: 'Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/).' TimestampOrder: title: TimestampOrder enum: - ORDER_UNSPECIFIED - ASCENDING - DESCENDING type: string description: Order the sequences in increasing or decreasing order of timestamps. Default is descending order of timestamps (latest first). Type: title: Type enum: - TYPE_UNSPECIFIED - INTEGER - FLOAT - STRING - BOOLEAN - DATETIME type: string description: Immutable. The type of data this data collector will collect. Type1: title: Type1 enum: - TYPE_UNSPECIFIED - INTEGER - FLOAT - STRING - BOOLEAN - DATETIME type: string description: Data type accepted by the data collector. Type2: title: Type2 enum: - ALIAS_TYPE_UNSPECIFIED - CERT - KEY_CERT type: string Type3: title: Type3 enum: - ALIAS_TYPE_UNSPECIFIED - CERT - KEY_CERT type: string description: Type of alias. Type4: title: Type4 enum: - TYPE_UNSPECIFIED - TYPE_TRIAL - TYPE_PAID - TYPE_INTERNAL type: string description: Not used by Apigee. Verdict: title: Verdict enum: - VERDICT_UNSPECIFIED - NONE - FAIL - PASS type: string description: 'Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.' WindowSize: title: WindowSize enum: - WINDOW_SIZE_UNSPECIFIED - MINUTE - HOUR - DAY - MONTH type: string description: Time buckets to group the stats by. securitySchemes: httpBearer: type: http scheme: bearer security: - httpBearer: [] tags: - name: projects description: '' - name: issuers description: '' - name: attachments description: '' - name: envgroups description: '' - name: hostQueries description: '' - name: apicategories description: '' - name: balance description: '' - name: attributes description: '' - name: apiproducts description: '' - name: create description: '' - name: keys description: '' - name: apps description: '' - name: subscriptions description: '' - name: developers description: '' - name: deployments description: '' - name: revisions description: '' - name: sharedflows description: '' - name: natAddresses description: '' - name: canaryevaluations description: '' - name: instances description: '' - name: environments description: '' - name: securityProfiles description: '' - name: hostSecurityReports description: '' - name: operations description: '' - name: datacollectors description: '' - name: reports description: '' - name: entries description: '' - name: keyvaluemaps description: '' - name: hostStats description: '' - name: apis description: '' - name: datastores description: '' - name: optimizedHostStats description: '' - name: rateplans description: '' - name: references description: '' - name: caches description: '' - name: securityStats description: '' - name: queries description: '' - name: data description: '' - name: debugsessions description: '' - name: aliases description: '' - name: keystores description: '' - name: overrides description: '' - name: targetservers description: '' - name: archiveDeployments description: '' - name: resourcefiles description: '' - name: admin description: '' - name: exports description: '' - name: stats description: '' - name: flowhooks description: '' - name: securityReports description: '' - name: optimizedStats description: '' - name: endpointAttachments description: '' - name: organizations description: ''