/v1/{parent}/apicategories

Creates a new category on the portal.

• parent (path, required) — Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`

/v1/organizations

Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).

• parent (query) — Required. Name of the Google Cloud project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: `projects/`

/v1/{instance}:reportStatus

Reports the latest status for a runtime instance.

• instance (path, required) — 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}

/v1/{name}

Deletes a category from the portal.

• name (path, required) — Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}`
• retention (query) — Optional. This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored.

/v1/{name}:getSyncAuthorization

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.

• name (path, required) — Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`

/v1/{name}

Gets a category on the portal.

• name (path, required) — Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}`
• format (query) — Specify `bundle` to export the contents of the shared flow bundle. Otherwise, the bundle metadata is returned.
• envgroupHostname (query) — Required. Hostname for which the interactive query will be executed.
• filter (query) — Filter that enables you to drill-down on specific dimension values.
• limit (query, limit) — Maximum number of result items to return. The default and maximum value that can be returned is 14400.
• offset (query, offset) — Offset value. Use `offset` with `limit` to enable pagination of results. For example, to display results 11-20, set limit to `10` and offset to `10`.
• realtime (query) — No longer used by Apigee. Supported for backwards compatibility.
• select (query) — Required. Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
• sort (query) — Flag that specifies whether the sort order should be ascending or descending. Valid values include `DESC` and `ASC`.
• sortby (query) — Comma-separated list of columns used to sort the final result.
• timeRange (query) — Required. Time interval for the interactive query. Time range is specified in GMT as `start~end`. For example: `04/15/2017 00:00~05/15/2017 23:59`.
• timeUnit (query) — Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or `month`.
• topk (query) — Top number of results to return. For example, to return the top 5 results, set `topk=5`.
• tsAscending (query) — Flag that specifies whether to list timestamps in ascending (`true`) or descending (`false`) order. Apigee recommends that you set this value to `true` if you are using `sortby` with `sort=DESC`.
• tzo (query) — Timezone offset value.

/v1/{name}

Updates a category on the portal.

• name (path, required) — Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}`
• updateMask (query) — List of fields to be updated.

/v1/{name}

Updates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable, even if it becomes undeployed. The payload is a ZIP-formatted shared flow. Content type must be either multipart/form-data or application/octet-stream.

• name (path, required) — Required. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
• validate (query) — Ignored. All uploads are validated regardless of the value of this field. It is kept for compatibility with existing APIs. Must be `true` or `false` if provided.

/v1/{name}

Update an existing custom report definition

• name (path, required) — Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}`
• ignoreExpiryValidation (query) — Required. Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed.
• ignoreNewlineValidation (query) — 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`.

/v1/{name}/attributes

Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.

• name (path, required) — Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`

/v1/{name}/certificate

Gets the certificate from an alias in PEM-encoded form.

• name (path, required) — Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.

/v1/{name}/csr

Generates a PKCS #10 Certificate Signing Request for the private key in an alias.

• name (path, required) — Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.

/v1/{name}/data

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.

• name (path, required) — Required. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.

/v1/{name}/deployments

Undeploys a shared flow revision from an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.undeploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}`

• name (path, required) — Required. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
• sequencedRollout (query) — 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.

/v1/{name}/deployments

Gets the deployment of a shared flow revision and actual state reported by runtime pods.

• name (path, required) — Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`

/v1/{name}/deployments

Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.deploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}`

• name (path, required) — Required. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
• override (query) — Flag that specifies whether the new deployment replaces other deployed revisions of the shared flow 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 shared flow are deployed in the environment.
• serviceAccount (query) — 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`.

/v1/{name}/deployments:generateDeployChangeReport

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}`

• name (path, required) — Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
• override (query) — Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.

/v1/{name}/deployments:generateUndeployChangeReport

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}`

• name (path, required) — Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`

/v1/{name}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

• name (path, required) — The name of the operation's parent resource.
• filter (query) — The standard list filter.
• pageSize (query, limit) — The standard list page size.
• pageToken (query) — The standard list page token.

/v1/{name}:activate

Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. **Note:** Not supported for Apigee hybrid.

• name (path, required) — Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``

/v1/{name}:adjust

Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged.

• name (path, required) — Required. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance`

/v1/{name}:credit

Credits the account balance for the developer.

• name (path, required) — Required. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance`

/v1/{name}:expire

Expires an API product subscription immediately.

• name (path, required) — Required. Name of the API product subscription. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/subscriptions/{subscription}`

/v1/{name}:generateDownloadUrl

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.

• name (path, required) — Required. The name of the Archive Deployment you want to download.

/v1/{name}:getProjectMapping

Gets the project ID and region for an Apigee organization.

• name (path, required) — Required. Apigee organization name in the following format: `organizations/{org}`

/v1/{name}:listRevisions

ListSecurityProfileRevisions lists all the revisions of the security profile.

• name (path, required) — Required. For a specific profile, list all the revisions. Format: `organizations/{org}/securityProfiles/{profile}`
• pageSize (query, limit) — 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.
• pageToken (query) — A page token, received from a previous `ListSecurityProfileRevisions` call. Provide this to retrieve the subsequent page.

/v1/{name}:setSyncAuthorization

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.

• name (path, required) — Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`

/v1/{orgenv}/securityStats:queryTabularStats

Retrieve security statistics as tabular rows.

• orgenv (path, required) — Required. Should be of the form organizations//environments/.

/v1/{orgenv}/securityStats:queryTimeSeriesStats

Retrieve security statistics as a collection of time series.

• orgenv (path, required) — Required. Should be of the form organizations//environments/.

/v1/{org}:setAddons

Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.

• org (path, required) — Required. Name of the organization. Use the following structure in your request: `organizations/{org}`

/v1/{parent}

Lists the Apigee organizations and associated Google Cloud projects that you have permission to access. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).

• parent (path, required) — Required. Use the following structure in your request: `organizations`

/v1/{parent}/aliases

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.

• parent (path, required) — Required. Name of the keystore. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}`.
• _password (query) — 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.
• alias (query) — 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.
• format (query) — Required. Format of the data. Valid values include: `selfsignedcert`, `keycertfile`, or `pkcs12`
• ignoreExpiryValidation (query) — Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed.
• ignoreNewlineValidation (query) — 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`.

/v1/{parent}/analytics/datastores

List Datastores

• parent (path, required) — Required. The parent organization name. Must be of the form `organizations/{org}`.
• targetType (query) — Optional. TargetType is used to fetch all Datastores that match the type

/v1/{parent}/analytics/datastores

Create a Datastore for an org

• parent (path, required) — Required. The parent organization name. Must be of the form `organizations/{org}`.

/v1/{parent}/analytics/datastores:test

Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

• parent (path, required) — Required. The parent organization name Must be of the form `organizations/{org}`

/v1/{parent}/analytics/exports

Lists the details and status of all analytics export jobs belonging to the parent organization and environment.

• parent (path, required) — Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`.

/v1/{parent}/analytics/exports

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".

• parent (path, required) — Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`.

/v1/{parent}/apicategories

Lists the categories on the portal.

• parent (path, required) — Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`

/v1/{parent}/apiproducts

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.

• parent (path, required) — Required. Name of the organization. Use the following structure in your request: `organizations/{org}`
• attributename (query) — Name of the attribute used to filter the search.
• attributevalue (query) — Value of the attribute used to filter the search.
• count (query, limit) — Enter the number of API products you want returned in the API call. The limit is 1000.
• expand (query) — Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API.
• startKey (query) — 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.

/v1/{parent}/apiproducts

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?

• parent (path, required) — Required. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`

/v1/{parent}/apis

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.

• parent (path, required) — Required. Name of the organization in the following format: `organizations/{org}`
• includeMetaData (query) — Flag that specifies whether to include API proxy metadata in the response.
• includeRevisions (query) — Flag that specifies whether to include a list of revisions in the response.

/v1/{parent}/apis

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.

• parent (path, required) — Required. Name of the organization in the following format: `organizations/{org}`
• action (query) — 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.
• name (query) — Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
• validate (query) — Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.

/v1/{parent}/apps

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.

• parent (path, required) — Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`
• count (query, limit) — Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.
• expand (query) — 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.
• shallowExpand (query) — Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode.
• startKey (query) — **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.
• includeCred (query) — Optional. Flag that specifies whether to include credentials in the response.
• keyStatus (query) — Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.
• rows (query) — Optional. Maximum number of app IDs to return. Defaults to 10000.
• status (query) — Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`.

/v1/{parent}/queries

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.

• parent (path, required) — Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.

/v1/{parent}/apps

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.

• parent (path, required) — Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

/v1/{parent}/archiveDeployments

Lists the ArchiveDeployments in the specified Environment.

• parent (path, required) — Required. Name of the Environment for which to list Archive Deployments in the format: `organizations/{org}/environments/{env}`.
• filter (query) — Optional. An optional query used to return a subset of Archive Deployments using the semantics defined in https://google.aip.dev/160.
• pageSize (query, limit) — Optional. Maximum number of Archive Deployments to return. If unspecified, at most 25 deployments will be returned.
• pageToken (query) — Optional. Page token, returned from a previous ListArchiveDeployments call, that you can use to retrieve the next page.

/v1/{parent}/archiveDeployments

Creates a new ArchiveDeployment.

• parent (path, required) — Required. The Environment this Archive Deployment will be created in.

/v1/{parent}/archiveDeployments:generateUploadUrl

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`

• parent (path, required) — Required. The organization and environment to upload to.

/v1/{parent}/attachments

Lists all attachments to an instance. **Note:** Not supported for Apigee hybrid.

• parent (path, required) — Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`
• pageSize (query, limit) — Maximum number of instance attachments to return. Defaults to 25.
• pageToken (query) — Page token, returned by a previous ListInstanceAttachments call, that you can use to retrieve the next page of content.

/v1/{parent}/attachments

Creates a new attachment of an environment to an instance. **Note:** Not supported for Apigee hybrid.

• parent (path, required) — Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.

/v1/{parent}/attributes

Returns a list of all developer attributes.

• parent (path, required) — Required. Email address of the developer for which attributes are being listed. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

/v1/{parent}/attributes

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.

• parent (path, required) — Required. Email address of the developer for which attributes are being updated. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

/v1/{parent}/canaryevaluations

Creates a new canary evaluation for an organization.

• parent (path, required) — Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`.

/v1/{parent}/datacollectors

Lists all data collectors.

• parent (path, required) — Required. Name of the organization for which to list data collectors in the following format: `organizations/{org}`.
• pageSize (query, limit) — Maximum number of data collectors to return. The page size defaults to 25.
• pageToken (query) — Page token, returned from a previous ListDataCollectors call, that you can use to retrieve the next page.

/v1/{parent}/datacollectors

Creates a new data collector.

• parent (path, required) — Required. Name of the organization in which to create the data collector in the following format: `organizations/{org}`.
• dataCollectorId (query) — 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.

/v1/{parent}/debugsessions

Lists debug sessions that are currently active in the given API Proxy revision.

• parent (path, required) — 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}`.
• pageSize (query, limit) — Maximum number of debug sessions to return. The page size defaults to 25.
• pageToken (query) — Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page.

/v1/{parent}/debugsessions

Creates a debug session for a deployed API Proxy revision.

• parent (path, required) — 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}`.
• timeout (query) — Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value.

/v1/{parent}/deployments

Lists all deployments of a shared flow revision.

• parent (path, required) — Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.
• sharedFlows (query) — 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`.

/v1/{parent}/developers

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.

• parent (path, required) — Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`.
• app (query) — Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria.
• count (query, limit) — Optional. Number of developers to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.
• expand (query) — 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.
• ids (query) — Optional. List of IDs to include, separated by commas.
• includeCompany (query) — Flag that specifies whether to include company details in the response.
• startKey (query) — **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 ```

/v1/{parent}/developers

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.

• parent (path, required) — Required. Name of the Apigee organization in which the developer is created. Use the following structure in your request: `organizations/{org}`.

/v1/{parent}/endpointAttachments

Lists the endpoint attachments in an organization.

• parent (path, required) — Required. Name of the organization for which to list endpoint attachments. Use the following structure in your request: `organizations/{org}`
• pageSize (query, limit) — Optional. Maximum number of endpoint attachments to return. If unspecified, at most 25 attachments will be returned.
• pageToken (query) — Optional. Page token, returned from a previous `ListEndpointAttachments` call, that you can use to retrieve the next page.

/v1/{parent}/endpointAttachments

Creates an endpoint attachment. **Note:** Not supported for Apigee hybrid.

• parent (path, required) — Required. Organization the endpoint attachment will be created in.
• endpointAttachmentId (query) — 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.

/v1/{parent}/entries

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.

• parent (path, required) — 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}`.
• pageSize (query, limit) — Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.
• pageToken (query) — 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.

/v1/{parent}/entries

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.

• parent (path, required) — 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}`.

/v1/{parent}/envgroups

Lists all environment groups.

• parent (path, required) — Required. Name of the organization for which to list environment groups in the following format: `organizations/{org}`.
• pageSize (query, limit) — Maximum number of environment groups to return. The page size defaults to 25.
• pageToken (query) — Page token, returned from a previous ListEnvironmentGroups call, that you can use to retrieve the next page.

/v1/{parent}/envgroups

Creates a new environment group.

• parent (path, required) — Required. Name of the organization in which to create the environment group in the following format: `organizations/{org}`.
• name (query) — ID of the environment group. Overrides any ID in the environment_group resource.

/v1/{parent}/environments

CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile.

• parent (path, required) — Required. Name of organization and security profile ID. Format: organizations/{org}/securityProfiles/{profile}
• name (query) — Optional. Name of the environment.

/v1/{parent}/hostQueries

Return a list of Asynchronous Queries at host level.

• parent (path, required) — Required. The parent resource name. Must be of the form `organizations/{org}`.
• dataset (query) — Filter response list by dataset. Example: `api`, `mint`
• envgroupHostname (query) — Required. Filter response list by hostname.
• from (query) — 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'.
• inclQueriesWithoutReport (query) — Flag to include asynchronous queries that don't have a report denifition.
• status (query) — Filter response list by asynchronous query status.
• submittedBy (query) — Filter response list by user who submitted queries.
• to (query) — 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'.

/v1/{parent}/hostQueries

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.

• parent (path, required) — Required. The parent resource name. Must be of the form `organizations/{org}`.

/v1/{parent}/hostSecurityReports

Return a list of Security Reports at host level.

• parent (path, required) — Required. The parent resource name. Must be of the form `organizations/{org}`.
• dataset (query) — Filter response list by dataset. Example: `api`, `mint`
• envgroupHostname (query) — Required. Filter response list by hostname.
• from (query) — 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'.
• pageSize (query, limit) — The maximum number of security report to return in the list response.
• pageToken (query) — Token returned from the previous list response to fetch the next page.
• status (query) — Filter response list by security report status.
• submittedBy (query) — Filter response list by user who submitted queries.
• to (query) — 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'.

/v1/{parent}/hostSecurityReports

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.

• parent (path, required) — Required. The parent resource name. Must be of the form `organizations/{org}`.

/v1/{parent}/instances

Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.

• parent (path, required) — Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.
• pageSize (query, limit) — Maximum number of instances to return. Defaults to 25.
• pageToken (query) — Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.

/v1/{parent}/instances

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.

• parent (path, required) — Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.

/v1/{parent}/keys

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.

• parent (path, required) — Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`

/v1/{parent}/keys/create

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.

• parent (path, required) — Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`

/v1/{parent}/keystores

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.

• parent (path, required) — Required. Name of the environment in which to create the keystore. Use the following format in your request: `organizations/{org}/environments/{env}`
• name (query) — Optional. Name of the keystore. Overrides the value in Keystore.

/v1/{parent}/keyvaluemaps

Creates a key value map in an organization.

• parent (path, required) — Required. Name of the organization in which to create the key value map file. Use the following structure in your request: `organizations/{org}`

/v1/{parent}/natAddresses

Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid.

• parent (path, required) — Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`
• pageSize (query, limit) — Maximum number of natAddresses to return. Defaults to 25.
• pageToken (query) — Page token, returned from a previous ListNatAddresses call, that you can use to retrieve the next page of content.

/v1/{parent}/natAddresses

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.

• parent (path, required) — Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`

/v1/{parent}/overrides

Lists all of the distributed trace configuration overrides in an environment.

• parent (path, required) — Required. Parent resource of the trace configuration override. Use the following structure in your request: "organizations/*/environments/*/traceConfig".
• pageSize (query, limit) — Maximum number of trace configuration overrides to return. If not specified, the maximum number returned is 25. The maximum number cannot exceed 100.
• pageToken (query) — 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.

/v1/{parent}/overrides

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.

• parent (path, required) — Required. Parent resource of the trace configuration override. Use the following structure in your request. "organizations/*/environments/*/traceConfig".

/v1/{parent}/queries

Return a list of Asynchronous Queries

• parent (path, required) — Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.
• dataset (query) — Filter response list by dataset. Example: `api`, `mint`
• from (query) — 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'.
• inclQueriesWithoutReport (query) — Flag to include asynchronous queries that don't have a report denifition.
• status (query) — Filter response list by asynchronous query status.
• submittedBy (query) — Filter response list by user who submitted queries.
• to (query) — 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'.

/v1/{parent}/rateplans

Lists all the rate plans for an API product.

• parent (path, required) — 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.
• count (query, limit) — 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.
• expand (query) — Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API. Defaults to `false`.
• orderBy (query) — 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.
• startKey (query) — 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.
• state (query) — State of the rate plans (`DRAFT`, `PUBLISHED`) that you want to display.

/v1/{parent}/rateplans

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.

• parent (path, required) — Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`

/v1/{parent}/references

Creates a Reference in the specified environment.

• parent (path, required) — Required. The parent environment name under which the Reference will be created. Must be of the form `organizations/{org}/environments/{env}`.

/v1/{parent}/reports

Return a list of Custom Reports

• parent (path, required) — Required. The parent organization name under which the API product will be listed `organizations/{organization_id}/reports`
• expand (query) — Set to 'true' to get expanded details about each custom report.

/v1/{parent}/reports

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.

• parent (path, required) — Required. The parent organization name under which the Custom Report will be created. Must be of the form: `organizations/{organization_id}/reports`

/v1/{parent}/resourcefiles

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).

• parent (path, required) — Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.
• type (query) — Optional. Type of resource files to list. {{ resource_file_type }}

/v1/{parent}/resourcefiles

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).

• parent (path, required) — Required. Name of the environment in which to create the resource file in the following format: `organizations/{org}/environments/{env}`.
• name (query) — Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255}
• type (query) — Required. Resource file type. {{ resource_file_type }}

/v1/{parent}/resourcefiles/{type}

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).

• parent (path, required) — Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.
• type (path, required) — Optional. Type of resource files to list. {{ resource_file_type }}

/v1/{parent}/resourcefiles/{type}/{name}

Deletes a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).

• parent (path, required) — Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.
• type (path, required) — Required. Resource file type. {{ resource_file_type }}
• name (path, required) — Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255}

/v1/{parent}/resourcefiles/{type}/{name}

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).

• parent (path, required) — Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.
• type (path, required) — Required. Resource file type. {{ resource_file_type }}
• name (path, required) — Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255}

/v1/{parent}/resourcefiles/{type}/{name}

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).

• parent (path, required) — Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.
• type (path, required) — Required. Resource file type. {{ resource_file_type }}
• name (path, required) — Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255}

/v1/{parent}/securityIncidents

ListSecurityIncidents lists all the security incident associated with the environment.

• parent (path, required) — Required. For a specific organization, list of all the security incidents. Format: `organizations/{org}/environments/{environment}`
• filter (query) — The filter expression to be used to get the list of security incidents, where filtering can be done on API Proxies. Example: filter = "api_proxy = /", "first_detected_time >", "last_detected_time <"
• pageSize (query, limit) — The maximum number of incidents to return. The service may return fewer than this value. If unspecified, at most 50 incidents will be returned.
• pageToken (query) — A page token, received from a previous `ListSecurityIncident` call. Provide this to retrieve the subsequent page.

/v1/{parent}/securityProfiles

ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.

• parent (path, required) — Required. For a specific organization, list of all the security profiles. Format: `organizations/{org}`
• pageSize (query, limit) — The maximum number of profiles to return. The service may return fewer than this value. If unspecified, at most 50 profiles will be returned.
• pageToken (query) — A page token, received from a previous `ListSecurityProfiles` call. Provide this to retrieve the subsequent page.

/v1/{parent}/securityReports

Return a list of Security Reports

• parent (path, required) — Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.
• dataset (query) — Filter response list by dataset. Example: `api`, `mint`
• from (query) — 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'.
• pageSize (query, limit) — The maximum number of security report to return in the list response.
• pageToken (query) — Token returned from the previous list response to fetch the next page.
• status (query) — Filter response list by security reports status.
• submittedBy (query) — Filter response list by user who submitted queries.
• to (query) — 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'.

/v1/{parent}/securityReports

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.

• parent (path, required) — Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.

/v1/{parent}/sharedflows

Lists all shared flows in the organization.

• parent (path, required) — Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`
• includeMetaData (query) — Indicates whether to include shared flow metadata in the response.
• includeRevisions (query) — Indicates whether to include a list of revisions in the response.

/v1/{parent}/sharedflows

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.

• parent (path, required) — Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`
• action (query) — Required. Must be set to either `import` or `validate`.
• name (query) — Required. The name to give the shared flow

/v1/{parent}/subscriptions

Lists all API product subscriptions for a developer.

• parent (path, required) — Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`
• count (query, limit) — 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.
• startKey (query) — 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.

/v1/{parent}/subscriptions

Creates a subscription to an API product.

• parent (path, required) — 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}`

/v1/{parent}/targetservers

Creates a TargetServer in the specified environment.

• parent (path, required) — Required. The parent environment name under which the TargetServer will be created. Must be of the form `organizations/{org}/environments/{env}`.
• name (query) — Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer.

/v1/{parent}:subscribe

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.

• parent (path, required) — Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`

/v1/{parent}:unsubscribe

Deletes a subscription for the environment's Pub/Sub topic.

• parent (path, required) — Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`

/v1/{profileEnvironment}:computeEnvironmentScores

ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment.

• profileEnvironment (path, required) — Required. Name of organization and environment and profile id for which score needs to be computed. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}

/v1/{project}:provisionOrganization

Provisions a new Apigee organization with a functioning runtime. This is the standard way to create trial organizations for a free Apigee trial.

• project (path, required) — Required. Name of the GCP project with which to associate the Apigee organization.

/v1/{resource}:getIamPolicy

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.

• resource (path, required) — 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.
• options.requestedPolicyVersion (query) — 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).

/v1/{resource}:setIamPolicy

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.

• resource (path, required) — 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.

/v1/{resource}:testIamPermissions

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).

• resource (path, required) — 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.