happygapi.apigee.organizations — happygapi 0.4.7

Apigee API: organizations. 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. See: https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations

analytics-datastores-create$ clj

(analytics-datastores-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/analytics/datastores/create

Required parameters: parent

Optional parameters: none

Body:

{:self string, :lastUpdateTime string, :datastoreConfig {:tablePrefix string, :datasetName string, :path string, :projectId string, :bucketName string}, :targetType string, :displayName string, :org string, :createTime string}

Create a Datastore for an org

analytics-datastores-delete$ clj

(analytics-datastores-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/analytics/datastores/delete

Required parameters: name

Optional parameters: none

Delete a Datastore from an org.

analytics-datastores-get$ clj

(analytics-datastores-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/analytics/datastores/get

Required parameters: name

Optional parameters: none

Get a Datastore

analytics-datastores-list$ clj

(analytics-datastores-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/analytics/datastores/list

Required parameters: parent

Optional parameters: targetType

List Datastores

analytics-datastores-test$ clj

(analytics-datastores-test$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/analytics/datastores/test

Required parameters: parent

Optional parameters: none

Body:

{:self string, :lastUpdateTime string, :datastoreConfig {:tablePrefix string, :datasetName string, :path string, :projectId string, :bucketName string}, :targetType string, :displayName string, :org string, :createTime string}

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

analytics-datastores-update$ clj

(analytics-datastores-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/analytics/datastores/update

Required parameters: name

Optional parameters: none

Body:

{:self string, :lastUpdateTime string, :datastoreConfig {:tablePrefix string, :datasetName string, :path string, :projectId string, :bucketName string}, :targetType string, :displayName string, :org string, :createTime string}

Update a Datastore

apiproducts-attributes$ clj

(apiproducts-attributes$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/attributes

Required parameters: name

Optional parameters: none

Body:

{:attribute [{:value string, :name string}]}

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.

apiproducts-attributes-delete$ clj

(apiproducts-attributes-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/attributes/delete

Required parameters: name

Optional parameters: none

Deletes an API product attribute.

apiproducts-attributes-get$ clj

(apiproducts-attributes-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/attributes/get

Required parameters: name

Optional parameters: none

Gets the value of an API product attribute.

apiproducts-attributes-list$ clj

(apiproducts-attributes-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/attributes/list

Required parameters: parent

Optional parameters: none

Lists all API product attributes.

apiproducts-attributes-updateApiProductAttribute$ clj

(apiproducts-attributes-updateApiProductAttribute$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/attributes/updateApiProductAttribute

Required parameters: name

Optional parameters: none

Body:

{:value string, :name string}

Updates the value of an API product attribute. 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.

apiproducts-create$ clj

(apiproducts-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/create

Required parameters: parent

Optional parameters: none

Body:

{:scopes [string], :description string, :displayName string, :name string, :createdAt string, :approvalType string, :quota string, :environments [string], :quotaTimeUnit string, :proxies [string], :lastModifiedAt string, :graphqlOperationGroup {:operationConfigType string, :operationConfigs [GoogleCloudApigeeV1GraphQLOperationConfig]}, :quotaInterval string, :attributes [{:value string, :name string}], :operationGroup {:operationConfigType string, :operationConfigs [GoogleCloudApigeeV1OperationConfig]}, :apiResources [string]}

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?

apiproducts-delete$ clj

(apiproducts-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/delete

Required parameters: name

Optional parameters: none

Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. 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 the UI or the API. View the list of API products to verify the internal name.

apiproducts-get$ clj

(apiproducts-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/get

Required parameters: name

Optional parameters: none

Gets configuration details for an API product. 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 the UI or the API. View the list of API products to verify the internal name.

apiproducts-list$ clj

(apiproducts-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/list

Required parameters: parent

Optional parameters: attributevalue, expand, startKey, attributename, count

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.

apiproducts-rateplans-create$ clj

(apiproducts-rateplans-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/rateplans/create

Required parameters: parent

Optional parameters: none

Body:

{:description string, :billingPeriod string, :paymentFundingModel string, :startTime string, :displayName string, :name string, :revenueShareRates [{:sharePercentage number, :end string, :start string}], :endTime string, :fixedRecurringFee {:units string, :nanos integer, :currencyCode string}, :createdAt string, :state string, :consumptionPricingRates [{:end string, :fee GoogleTypeMoney, :start string}], :apiproduct string, :lastModifiedAt string, :fixedFeeFrequency integer, :consumptionPricingType string, :currencyCode string, :setupFee {:units string, :nanos integer, :currencyCode string}, :revenueShareType string}

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.

apiproducts-rateplans-delete$ clj

(apiproducts-rateplans-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/rateplans/delete

Required parameters: name

Optional parameters: none

Deletes a rate plan.

apiproducts-rateplans-get$ clj

(apiproducts-rateplans-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/rateplans/get

Required parameters: name

Optional parameters: none

Gets the details of a rate plan.

apiproducts-rateplans-list$ clj

(apiproducts-rateplans-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/rateplans/list

Required parameters: parent

Optional parameters: startKey, orderBy, state, count, expand

Lists all the rate plans for an API product.

apiproducts-rateplans-update$ clj

(apiproducts-rateplans-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/rateplans/update

Required parameters: name

Optional parameters: none

Body:

{:description string, :billingPeriod string, :paymentFundingModel string, :startTime string, :displayName string, :name string, :revenueShareRates [{:sharePercentage number, :end string, :start string}], :endTime string, :fixedRecurringFee {:units string, :nanos integer, :currencyCode string}, :createdAt string, :state string, :consumptionPricingRates [{:end string, :fee GoogleTypeMoney, :start string}], :apiproduct string, :lastModifiedAt string, :fixedFeeFrequency integer, :consumptionPricingType string, :currencyCode string, :setupFee {:units string, :nanos integer, :currencyCode string}, :revenueShareType string}

Updates an existing rate plan.

apiproducts-update$ clj

(apiproducts-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apiproducts/update

Required parameters: name

Optional parameters: none

Body:

{:scopes [string], :description string, :displayName string, :name string, :createdAt string, :approvalType string, :quota string, :environments [string], :quotaTimeUnit string, :proxies [string], :lastModifiedAt string, :graphqlOperationGroup {:operationConfigType string, :operationConfigs [GoogleCloudApigeeV1GraphQLOperationConfig]}, :quotaInterval string, :attributes [{:value string, :name string}], :operationGroup {:operationConfigType string, :operationConfigs [GoogleCloudApigeeV1OperationConfig]}, :apiResources [string]}

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.

apis-create$ clj

(apis-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/create

Required parameters: parent

Optional parameters: validate, action, name

Body:

{:contentType string, :extensions [{}], :data string}

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.

apis-delete$ clj

(apis-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/delete

Required parameters: name

Optional parameters: none

Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.

apis-deployments-list$ clj

(apis-deployments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/deployments/list

Required parameters: parent

Optional parameters: none

Lists all deployments of an API proxy.

apis-get$ clj

(apis-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/get

Required parameters: name

Optional parameters: none

Gets an API proxy including a list of existing revisions.

apis-keyvaluemaps-create$ clj

(apis-keyvaluemaps-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/keyvaluemaps/create

Required parameters: parent

Optional parameters: none

Body:

{:encrypted boolean, :name string}

Creates a key value map in an api proxy.

apis-keyvaluemaps-delete$ clj

(apis-keyvaluemaps-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/keyvaluemaps/delete

Required parameters: name

Optional parameters: none

Delete a key value map in an api proxy.

apis-list$ clj

(apis-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/list

Required parameters: parent

Optional parameters: includeRevisions, includeMetaData

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.

apis-revisions-delete$ clj

(apis-revisions-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/revisions/delete

Required parameters: name

Optional parameters: none

Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.

apis-revisions-deployments-list$ clj

(apis-revisions-deployments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/revisions/deployments/list

Required parameters: parent

Optional parameters: none

Lists all deployments of an API proxy revision.

apis-revisions-get$ clj

(apis-revisions-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/revisions/get

Required parameters: name

Optional parameters: format

Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in updateApiProxyRevision.

apis-revisions-updateApiProxyRevision$ clj

(apis-revisions-updateApiProxyRevision$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apis/revisions/updateApiProxyRevision

Required parameters: name

Optional parameters: validate

Body:

{:contentType string, :extensions [{}], :data string}

Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. You can update only API proxy revisions that have never been deployed. After deployment, an API proxy revision becomes immutable, even if it is undeployed. Set the Content-Type header to either multipart/form-data or application/octet-stream.

apps-get$ clj

(apps-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apps/get

Required parameters: name

Optional parameters: none

Gets the app profile for the specified app ID.

apps-list$ clj

(apps-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/apps/list

Required parameters: parent

Optional parameters: startKey, apiProduct, ids, keyStatus, rows, status, includeCred, expand, apptype

Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).

create$ clj

(create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/create

Required parameters: none

Optional parameters: parent

Body:

{:description string, :properties {:property [GoogleCloudApigeeV1Property]}, :analyticsRegion string, :expiresAt string, :runtimeType string, :displayName string, :name string, :caCertificate string, :customerName string, :billingType string, :createdAt string, :type string, :state string, :environments [string], :runtimeDatabaseEncryptionKeyName string, :lastModifiedAt string, :projectId string, :addonsConfig {:monetizationConfig GoogleCloudApigeeV1MonetizationConfig, :integrationConfig GoogleCloudApigeeV1IntegrationConfig, :advancedApiOpsConfig GoogleCloudApigeeV1AdvancedApiOpsConfig}, :attributes [string], :subscriptionType string, :authorizedNetwork string}

Creates an Apigee organization. See Create an Apigee organization.

datacollectors-create$ clj

(datacollectors-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/datacollectors/create

Required parameters: parent

Optional parameters: dataCollectorId

Body:

{:name string, :type string, :lastModifiedAt string, :createdAt string, :description string}

Creates a new data collector.

datacollectors-delete$ clj

(datacollectors-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/datacollectors/delete

Required parameters: name

Optional parameters: none

Deletes a data collector.

datacollectors-get$ clj

(datacollectors-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/datacollectors/get

Required parameters: name

Optional parameters: none

Gets a data collector.

datacollectors-list$ clj

(datacollectors-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/datacollectors/list

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists all data collectors.

datacollectors-patch$ clj

(datacollectors-patch$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/datacollectors/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :type string, :lastModifiedAt string, :createdAt string, :description string}

Updates a data collector.

delete$ clj

(delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/delete

Required parameters: name

Optional parameters: none

Delete an Apigee organization. Only supported for SubscriptionType TRIAL.

deployments-list$ clj

(deployments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/deployments/list

Required parameters: parent

Optional parameters: sharedFlows

Lists all deployments of API proxies or shared flows.

developers-apps-attributes$ clj

(developers-apps-attributes$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/attributes

Required parameters: name

Optional parameters: none

Body:

{:attribute [{:value string, :name string}]}

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

developers-apps-attributes-delete$ clj

(developers-apps-attributes-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/attributes/delete

Required parameters: name

Optional parameters: none

Deletes a developer app attribute.

developers-apps-attributes-get$ clj

(developers-apps-attributes-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/attributes/get

Required parameters: name

Optional parameters: none

Returns a developer app attribute.

developers-apps-attributes-list$ clj

(developers-apps-attributes-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/attributes/list

Required parameters: parent

Optional parameters: none

Returns a list of all developer app attributes.

developers-apps-attributes-updateDeveloperAppAttribute$ clj

(developers-apps-attributes-updateDeveloperAppAttribute$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/attributes/updateDeveloperAppAttribute

Required parameters: name

Optional parameters: none

Body:

{:value string, :name string}

Updates a developer app attribute. 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 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.

developers-apps-create$ clj

(developers-apps-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/create

Required parameters: parent

Optional parameters: none

Body:

{:scopes [string], :callbackUrl string, :apiProducts [string], :credentials [{:issuedAt string, :status string, :consumerKey string, :apiProducts [GoogleCloudApigeeV1ApiProductRef], :scopes [string], :expiresAt string, :attributes [GoogleCloudApigeeV1Attribute], :consumerSecret string}], :name string, :appFamily string, :keyExpiresIn string, :createdAt string, :developerId string, :status string, :appId string, :lastModifiedAt string, :attributes [{:value string, :name string}]}

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.

developers-apps-delete$ clj

(developers-apps-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/delete

Required parameters: name

Optional parameters: none

Deletes a developer app. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.

developers-apps-generateKeyPairOrUpdateDeveloperAppStatus$ clj

(developers-apps-generateKeyPairOrUpdateDeveloperAppStatus$ auth
                                                            parameters
                                                            body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/generateKeyPairOrUpdateDeveloperAppStatus

Required parameters: name

Optional parameters: action

Body:

{:scopes [string], :callbackUrl string, :apiProducts [string], :credentials [{:issuedAt string, :status string, :consumerKey string, :apiProducts [GoogleCloudApigeeV1ApiProductRef], :scopes [string], :expiresAt string, :attributes [GoogleCloudApigeeV1Attribute], :consumerSecret string}], :name string, :appFamily string, :keyExpiresIn string, :createdAt string, :developerId string, :status string, :appId string, :lastModifiedAt string, :attributes [{:value string, :name string}]}

Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the action query parameter to approved or revoked, respectively, and the Content-Type header to application/octet-stream. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still approved. If successful, the API call returns the following HTTP status code: 204 No Content To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (approved or revoked) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The keyExpiresIn property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to -1, the API key never expires. Notes: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.

developers-apps-get$ clj

(developers-apps-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/get

Required parameters: name

Optional parameters: entity, query

Returns the details for a developer app.

developers-apps-keys-apiproducts-delete$ clj

(developers-apps-keys-apiproducts-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/keys/apiproducts/delete

Required parameters: name

Optional parameters: none

Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. Note: The consumer key is not removed, only its association with the API product.

developers-apps-keys-apiproducts-updateDeveloperAppKeyApiProduct$ clj

(developers-apps-keys-apiproducts-updateDeveloperAppKeyApiProduct$ auth
                                                                   parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/keys/apiproducts/updateDeveloperAppKeyApiProduct

Required parameters: name

Optional parameters: action

Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked will not allow access to the API.

developers-apps-keys-create$ clj

(developers-apps-keys-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/keys/create

Required parameters: parent

Optional parameters: none

Body:

{:scopes [string], :apiProducts [any], :expiresAt string, :expiresInSeconds string, :consumerSecret string, :issuedAt string, :consumerKey string, :status string, :attributes [{:value string, :name string}]}

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.

developers-apps-keys-create-create$ clj

(developers-apps-keys-create-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/keys/create/create

Required parameters: parent

Optional parameters: none

Body:

{:scopes [string], :apiProducts [any], :expiresAt string, :expiresInSeconds string, :consumerSecret string, :issuedAt string, :consumerKey string, :status string, :attributes [{:value string, :name string}]}

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.

developers-apps-keys-delete$ clj

(developers-apps-keys-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/keys/delete

Required parameters: name

Optional parameters: none

Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. Note: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required.

developers-apps-keys-get$ clj

(developers-apps-keys-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/keys/get

Required parameters: name

Optional parameters: none

Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.

developers-apps-keys-replaceDeveloperAppKey$ clj

(developers-apps-keys-replaceDeveloperAppKey$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/keys/replaceDeveloperAppKey

Required parameters: name

Optional parameters: none

Body:

{:scopes [string], :apiProducts [any], :expiresAt string, :expiresInSeconds string, :consumerSecret string, :issuedAt string, :consumerKey string, :status string, :attributes [{:value string, :name string}]}

Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the scopes element under the apiProducts element in the attributes of the app.

developers-apps-keys-updateDeveloperAppKey$ clj

(developers-apps-keys-updateDeveloperAppKey$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/keys/updateDeveloperAppKey

Required parameters: name

Optional parameters: action

Body:

{:scopes [string], :apiProducts [any], :expiresAt string, :expiresInSeconds string, :consumerSecret string, :issuedAt string, :consumerKey string, :status string, :attributes [{:value string, :name string}]}

Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.

developers-apps-list$ clj

(developers-apps-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/list

Required parameters: parent

Optional parameters: shallowExpand, expand, count, startKey

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.

developers-apps-update$ clj

(developers-apps-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/apps/update

Required parameters: name

Optional parameters: none

Body:

{:scopes [string], :callbackUrl string, :apiProducts [string], :credentials [{:issuedAt string, :status string, :consumerKey string, :apiProducts [GoogleCloudApigeeV1ApiProductRef], :scopes [string], :expiresAt string, :attributes [GoogleCloudApigeeV1Attribute], :consumerSecret string}], :name string, :appFamily string, :keyExpiresIn string, :createdAt string, :developerId string, :status string, :appId string, :lastModifiedAt string, :attributes [{:value string, :name string}]}

Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.

developers-attributes$ clj

(developers-attributes$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/attributes

Required parameters: parent

Optional parameters: none

Body:

{:attribute [{:value string, :name string}]}

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.

developers-attributes-delete$ clj

(developers-attributes-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/attributes/delete

Required parameters: name

Optional parameters: none

Deletes a developer attribute.

developers-attributes-get$ clj

(developers-attributes-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/attributes/get

Required parameters: name

Optional parameters: none

Returns the value of the specified developer attribute.

developers-attributes-list$ clj

(developers-attributes-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/attributes/list

Required parameters: parent

Optional parameters: none

Returns a list of all developer attributes.

developers-attributes-updateDeveloperAttribute$ clj

(developers-attributes-updateDeveloperAttribute$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/attributes/updateDeveloperAttribute

Required parameters: name

Optional parameters: none

Body:

{:value string, :name string}

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.

developers-create$ clj

(developers-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/create

Required parameters: parent

Optional parameters: none

Body:

{:apps [string], :email string, :accessType string, :appFamily string, :firstName string, :createdAt string, :organizationName string, :developerId string, :status string, :lastModifiedAt string, :lastName string, :companies [string], :attributes [{:value string, :name string}], :userName string}

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.

developers-delete$ clj

(developers-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/delete

Required parameters: name

Optional parameters: none

Deletes a developer. All apps and API keys associated with the developer are also removed. Warning: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to inactive using the SetDeveloperStatus API. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.

developers-get$ clj

(developers-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/get

Required parameters: name

Optional parameters: action

Returns the developer details, including the developer's name, email address, apps, and other information. Note: The response includes only the first 100 developer apps.

developers-list$ clj

(developers-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/list

Required parameters: parent

Optional parameters: ids, includeCompany, startKey, app, expand, count

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.

developers-setDeveloperStatus$ clj

(developers-setDeveloperStatus$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/setDeveloperStatus

Required parameters: name

Optional parameters: action

Sets the status of a developer. Valid values are active or inactive. A developer is active by default. If you set a developer's status to inactive, the API keys assigned to the developer apps are no longer valid even though the API keys are set to approved. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won't work. If successful, the API call returns the following HTTP status code: 204 No Content

developers-subscriptions-create$ clj

(developers-subscriptions-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/subscriptions/create

Required parameters: parent

Optional parameters: none

Body:

{:apiproduct string, :lastModifiedAt string, :startTime string, :name string, :endTime string, :createdAt string}

Creates a subscription to an API product.

developers-subscriptions-expire$ clj

(developers-subscriptions-expire$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/subscriptions/expire

Required parameters: name

Optional parameters: none

Body:

{}

Expires an API product subscription immediately.

developers-subscriptions-get$ clj

(developers-subscriptions-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/subscriptions/get

Required parameters: name

Optional parameters: none

Gets details for an API product subscription.

developers-subscriptions-list$ clj

(developers-subscriptions-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/subscriptions/list

Required parameters: parent

Optional parameters: startKey, count

Lists all API product subscriptions for a developer.

developers-update$ clj

(developers-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/developers/update

Required parameters: name

Optional parameters: none

Body:

{:apps [string], :email string, :accessType string, :appFamily string, :firstName string, :createdAt string, :organizationName string, :developerId string, :status string, :lastModifiedAt string, :lastName string, :companies [string], :attributes [{:value string, :name string}], :userName string}

Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, 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 (current 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.

envgroups-attachments-create$ clj

(envgroups-attachments-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/attachments/create

Required parameters: parent

Optional parameters: none

Body:

{:environment string, :createdAt string, :name string}

Creates a new attachment of an environment to an environment group.

envgroups-attachments-delete$ clj

(envgroups-attachments-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/attachments/delete

Required parameters: name

Optional parameters: none

Deletes an environment group attachment.

envgroups-attachments-get$ clj

(envgroups-attachments-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/attachments/get

Required parameters: name

Optional parameters: none

Gets an environment group attachment.

envgroups-attachments-list$ clj

(envgroups-attachments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/attachments/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists all attachments of an environment group.

envgroups-create$ clj

(envgroups-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/create

Required parameters: parent

Optional parameters: name

Body:

{:lastModifiedAt string, :createdAt string, :hostnames [string], :state string, :name string}

Creates a new environment group.

envgroups-delete$ clj

(envgroups-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/delete

Required parameters: name

Optional parameters: none

Deletes an environment group.

envgroups-get$ clj

(envgroups-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/get

Required parameters: name

Optional parameters: none

Gets an environment group.

envgroups-list$ clj

(envgroups-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/list

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists all environment groups.

envgroups-patch$ clj

(envgroups-patch$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/envgroups/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:lastModifiedAt string, :createdAt string, :hostnames [string], :state string, :name string}

Updates an environment group.

environments-analytics-admin-getSchemav2$ clj

(environments-analytics-admin-getSchemav2$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/analytics/admin/getSchemav2

Required parameters: name

Optional parameters: type, disableCache

Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.

environments-analytics-exports-create$ clj

(environments-analytics-exports-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/analytics/exports/create

Required parameters: parent

Optional parameters: none

Body:

{:name string, :description string, :dateRange {:end string, :start string}, :datastoreName string, :csvDelimiter string, :outputFormat string}

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

environments-analytics-exports-get$ clj

(environments-analytics-exports-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/analytics/exports/get

Required parameters: name

Optional parameters: none

Gets the details and status of an analytics export job. If the export job is still in progress, its state is set to "running". After the export job has completed successfully, its state is set to "completed". If the export job fails, its state is set to failed.

environments-analytics-exports-list$ clj

(environments-analytics-exports-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/analytics/exports/list

Required parameters: parent

Optional parameters: none

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

environments-apis-deployments-list$ clj

(environments-apis-deployments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/deployments/list

Required parameters: parent

Optional parameters: none

Lists all deployments of an API proxy in an environment.

environments-apis-revisions-debugsessions-create$ clj

(environments-apis-revisions-debugsessions-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/debugsessions/create

Required parameters: parent

Optional parameters: timeout

Body:

{:timeout string, :validity integer, :name string, :count integer, :tracesize integer, :filter string}

Creates a debug session for a deployed API Proxy revision.

environments-apis-revisions-debugsessions-data-get$ clj

(environments-apis-revisions-debugsessions-data-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/debugsessions/data/get

Required parameters: name

Optional parameters: none

Gets the debug data from a transaction.

environments-apis-revisions-debugsessions-deleteData$ clj

(environments-apis-revisions-debugsessions-deleteData$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/debugsessions/deleteData

Required parameters: name

Optional parameters: none

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.

environments-apis-revisions-debugsessions-get$ clj

(environments-apis-revisions-debugsessions-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/debugsessions/get

Required parameters: name

Optional parameters: none

Retrieves a debug session.

environments-apis-revisions-debugsessions-list$ clj

(environments-apis-revisions-debugsessions-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/debugsessions/list

Required parameters: parent

Optional parameters: pageSize, pageToken

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

environments-apis-revisions-deploy$ clj

(environments-apis-revisions-deploy$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/deploy

Required parameters: name

Optional parameters: override, sequencedRollout

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}

environments-apis-revisions-deployments-generateDeployChangeReport$ clj

(environments-apis-revisions-deployments-generateDeployChangeReport$ auth
                                                                     parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/deployments/generateDeployChangeReport

Required parameters: name

Optional parameters: override

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}

environments-apis-revisions-deployments-generateUndeployChangeReport$ clj

(environments-apis-revisions-deployments-generateUndeployChangeReport$
  auth
  parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/deployments/generateUndeployChangeReport

Required parameters: name

Optional parameters: none

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}

environments-apis-revisions-getDeployments$ clj

(environments-apis-revisions-getDeployments$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/getDeployments

Required parameters: name

Optional parameters: none

Gets the deployment of an API proxy revision and actual state reported by runtime pods.

environments-apis-revisions-undeploy$ clj

(environments-apis-revisions-undeploy$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/apis/revisions/undeploy

Required parameters: name

Optional parameters: sequencedRollout

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}

environments-caches-delete$ clj

(environments-caches-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/caches/delete

Required parameters: name

Optional parameters: none

Deletes a cache.

environments-create$ clj

(environments-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/create

Required parameters: parent

Optional parameters: name

Body:

{:description string, :state string, :properties {:property [GoogleCloudApigeeV1Property]}, :lastModifiedAt string, :name string, :displayName string, :createdAt string}

Creates an environment in an organization.

environments-delete$ clj

(environments-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/delete

Required parameters: name

Optional parameters: none

Deletes an environment from an organization.

environments-deployments-list$ clj

(environments-deployments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/deployments/list

Required parameters: parent

Optional parameters: sharedFlows

Lists all deployments of API proxies or shared flows in an environment.

environments-flowhooks-attachSharedFlowToFlowHook$ clj

(environments-flowhooks-attachSharedFlowToFlowHook$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/flowhooks/attachSharedFlowToFlowHook

Required parameters: name

Optional parameters: none

Body:

{:description string, :flowHookPoint string, :continueOnError boolean, :sharedFlow string}

Attaches a shared flow to a flow hook.

environments-flowhooks-detachSharedFlowFromFlowHook$ clj

(environments-flowhooks-detachSharedFlowFromFlowHook$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/flowhooks/detachSharedFlowFromFlowHook

Required parameters: name

Optional parameters: none

Detaches a shared flow from a flow hook.

environments-flowhooks-get$ clj

(environments-flowhooks-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/flowhooks/get

Required parameters: name

Optional parameters: none

Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.

environments-get$ clj

(environments-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/get

Required parameters: name

Optional parameters: none

Gets environment details.

environments-getDebugmask$ clj

(environments-getDebugmask$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/getDebugmask

Required parameters: name

Optional parameters: none

Gets the debug mask singleton resource for an environment.

environments-getDeployedConfig$ clj

(environments-getDeployedConfig$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/getDeployedConfig

Required parameters: name

Optional parameters: none

Gets the deployed configuration for an environment.

environments-getIamPolicy$ clj

(environments-getIamPolicy$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.getIamPolicy permission to call this API.

environments-getTraceConfig$ clj

(environments-getTraceConfig$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/getTraceConfig

Required parameters: name

Optional parameters: none

Get distributed trace configuration in an environment.

environments-keystores-aliases-create$ clj

(environments-keystores-aliases-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/aliases/create

Required parameters: parent

Optional parameters: format, alias, ignoreNewlineValidation, ignoreExpiryValidation, _password

Body:

{:contentType string, :extensions [{}], :data string}

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.

environments-keystores-aliases-csr$ clj

(environments-keystores-aliases-csr$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/aliases/csr

Required parameters: name

Optional parameters: none

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

environments-keystores-aliases-delete$ clj

(environments-keystores-aliases-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/aliases/delete

Required parameters: name

Optional parameters: none

Deletes an alias.

environments-keystores-aliases-get$ clj

(environments-keystores-aliases-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/aliases/get

Required parameters: name

Optional parameters: none

Gets an alias.

environments-keystores-aliases-getCertificate$ clj

(environments-keystores-aliases-getCertificate$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/aliases/getCertificate

Required parameters: name

Optional parameters: none

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

environments-keystores-aliases-update$ clj

(environments-keystores-aliases-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/aliases/update

Required parameters: name

Optional parameters: ignoreExpiryValidation, ignoreNewlineValidation

Body:

{:contentType string, :extensions [{}], :data string}

Updates the certificate in an alias.

environments-keystores-create$ clj

(environments-keystores-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/create

Required parameters: parent

Optional parameters: name

Body:

{:aliases [string], :name string}

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.

environments-keystores-delete$ clj

(environments-keystores-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/delete

Required parameters: name

Optional parameters: none

Deletes a keystore or truststore.

environments-keystores-get$ clj

(environments-keystores-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keystores/get

Required parameters: name

Optional parameters: none

Gets a keystore or truststore.

environments-keyvaluemaps-create$ clj

(environments-keyvaluemaps-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keyvaluemaps/create

Required parameters: parent

Optional parameters: none

Body:

{:encrypted boolean, :name string}

Creates a key value map in an environment.

environments-keyvaluemaps-delete$ clj

(environments-keyvaluemaps-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/keyvaluemaps/delete

Required parameters: name

Optional parameters: none

Delete a key value map in an environment.

environments-optimizedStats-get$ clj

(environments-optimizedStats-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/optimizedStats/get

Required parameters: name

Optional parameters: tzo, aggTable, limit, offset, timeRange, accuracy, realtime, sonar, topk, sortby, tsAscending, filter, timeUnit, sort, select

This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.

environments-queries-create$ clj

(environments-queries-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/queries/create

Required parameters: parent

Optional parameters: none

Body:

{:reportDefinitionId string, :limit integer, :timeRange any, :name string, :envgroupHostname string, :outputFormat string, :dimensions [string], :filter string, :csvDelimiter string, :groupByTimeUnit string, :metrics [{:alias string, :operator string, :value string, :name string, :function string}]}

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.

environments-queries-get$ clj

(environments-queries-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/queries/get

Required parameters: name

Optional parameters: none

Get query status If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"

environments-queries-getResult$ clj

(environments-queries-getResult$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/queries/getResult

Required parameters: name

Optional parameters: none

After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip

environments-queries-list$ clj

(environments-queries-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/queries/list

Required parameters: parent

Optional parameters: submittedBy, dataset, from, inclQueriesWithoutReport, status, to

Return a list of Asynchronous Queries

environments-references-create$ clj

(environments-references-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/references/create

Required parameters: parent

Optional parameters: none

Body:

{:description string, :resourceType string, :name string, :refers string}

Creates a Reference in the specified environment.

environments-references-delete$ clj

(environments-references-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/references/delete

Required parameters: name

Optional parameters: none

Deletes a Reference from an environment. Returns the deleted Reference resource.

environments-references-get$ clj

(environments-references-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/references/get

Required parameters: name

Optional parameters: none

Gets a Reference resource.

environments-references-update$ clj

(environments-references-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/references/update

Required parameters: name

Optional parameters: none

Body:

{:description string, :resourceType string, :name string, :refers string}

Updates an existing Reference. Note that this operation has PUT semantics; it will replace the entirety of the existing Reference with the resource in the request body.

environments-resourcefiles-create$ clj

(environments-resourcefiles-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/resourcefiles/create

Required parameters: parent

Optional parameters: type, name

Body:

{:contentType string, :extensions [{}], :data string}

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.

environments-resourcefiles-delete$ clj

(environments-resourcefiles-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/resourcefiles/delete

Required parameters: name, parent, type

Optional parameters: none

Deletes a resource file. For more information about resource files, see Resource files.

environments-resourcefiles-get$ clj

(environments-resourcefiles-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/resourcefiles/get

Required parameters: parent, name, type

Optional parameters: none

Gets the contents of a resource file. For more information about resource files, see Resource files.

environments-resourcefiles-list$ clj

(environments-resourcefiles-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/resourcefiles/list

Required parameters: parent

Optional parameters: type

Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

environments-resourcefiles-listEnvironmentResources$ clj

(environments-resourcefiles-listEnvironmentResources$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/resourcefiles/listEnvironmentResources

Required parameters: parent, type

Optional parameters: none

Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

environments-resourcefiles-update$ clj

(environments-resourcefiles-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/resourcefiles/update

Required parameters: type, name, parent

Optional parameters: none

Body:

{:contentType string, :extensions [{}], :data string}

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.

environments-setIamPolicy$ clj

(environments-setIamPolicy$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:updateMask string, :policy {:etag string, :version integer, :auditConfigs [GoogleIamV1AuditConfig], :bindings [GoogleIamV1Binding]}}

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. You must have the apigee.environments.setIamPolicy permission to call this API.

environments-sharedflows-deployments-list$ clj

(environments-sharedflows-deployments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/sharedflows/deployments/list

Required parameters: parent

Optional parameters: none

Lists all deployments of a shared flow in an environment.

environments-sharedflows-revisions-deploy$ clj

(environments-sharedflows-revisions-deploy$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/sharedflows/revisions/deploy

Required parameters: name

Optional parameters: override

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}

environments-sharedflows-revisions-getDeployments$ clj

(environments-sharedflows-revisions-getDeployments$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/sharedflows/revisions/getDeployments

Required parameters: name

Optional parameters: none

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

environments-sharedflows-revisions-undeploy$ clj

(environments-sharedflows-revisions-undeploy$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/sharedflows/revisions/undeploy

Required parameters: name

Optional parameters: none

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}

environments-stats-get$ clj

(environments-stats-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/stats/get

Required parameters: name

Optional parameters: tzo, aggTable, limit, offset, timeRange, accuracy, realtime, sonar, topk, sortby, tsAscending, filter, timeUnit, sort, select

Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.

environments-subscribe$ clj

(environments-subscribe$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/subscribe

Required parameters: parent

Optional parameters: none

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.

environments-targetservers-create$ clj

(environments-targetservers-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/targetservers/create

Required parameters: parent

Optional parameters: name

Body:

{:host string, :protocol string, :port integer, :sSLInfo {:protocols [string], :keyStore string, :keyAlias string, :trustStore string, :clientAuthEnabled boolean, :commonName GoogleCloudApigeeV1TlsInfoCommonName, :ciphers [string], :enabled boolean, :ignoreValidationErrors boolean}, :name string, :isEnabled boolean, :description string}

Creates a TargetServer in the specified environment.

environments-targetservers-delete$ clj

(environments-targetservers-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/targetservers/delete

Required parameters: name

Optional parameters: none

Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.

environments-targetservers-get$ clj

(environments-targetservers-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/targetservers/get

Required parameters: name

Optional parameters: none

Gets a TargetServer resource.

environments-targetservers-update$ clj

(environments-targetservers-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/targetservers/update

Required parameters: name

Optional parameters: none

Body:

{:host string, :protocol string, :port integer, :sSLInfo {:protocols [string], :keyStore string, :keyAlias string, :trustStore string, :clientAuthEnabled boolean, :commonName GoogleCloudApigeeV1TlsInfoCommonName, :ciphers [string], :enabled boolean, :ignoreValidationErrors boolean}, :name string, :isEnabled boolean, :description string}

Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.

environments-testIamPermissions$ clj

(environments-testIamPermissions$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

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

environments-traceConfig-overrides-create$ clj

(environments-traceConfig-overrides-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/traceConfig/overrides/create

Required parameters: parent

Optional parameters: none

Body:

{:name string, :samplingConfig {:samplingRate number, :sampler string}, :apiProxy string}

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.

environments-traceConfig-overrides-delete$ clj

(environments-traceConfig-overrides-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/traceConfig/overrides/delete

Required parameters: name

Optional parameters: none

Deletes a distributed trace configuration override.

environments-traceConfig-overrides-get$ clj

(environments-traceConfig-overrides-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/traceConfig/overrides/get

Required parameters: name

Optional parameters: none

Gets a trace configuration override.

environments-traceConfig-overrides-list$ clj

(environments-traceConfig-overrides-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/traceConfig/overrides/list

Required parameters: parent

Optional parameters: pageSize, pageToken

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

environments-traceConfig-overrides-patch$ clj

(environments-traceConfig-overrides-patch$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/traceConfig/overrides/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :samplingConfig {:samplingRate number, :sampler string}, :apiProxy string}

Updates a distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.

environments-unsubscribe$ clj

(environments-unsubscribe$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/unsubscribe

Required parameters: parent

Optional parameters: none

Body:

{:name string}

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

environments-update$ clj

(environments-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/update

Required parameters: name

Optional parameters: none

Body:

{:description string, :state string, :properties {:property [GoogleCloudApigeeV1Property]}, :lastModifiedAt string, :name string, :displayName string, :createdAt string}

Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API.

environments-updateDebugmask$ clj

(environments-updateDebugmask$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/updateDebugmask

Required parameters: name

Optional parameters: replaceRepeatedFields, updateMask

Body:

{:namespaces {}, :responseXPaths [string], :name string, :variables [string], :requestJSONPaths [string], :requestXPaths [string], :faultJSONPaths [string], :faultXPaths [string], :responseJSONPaths [string]}

Updates the debug mask singleton resource for an environment.

environments-updateEnvironment$ clj

(environments-updateEnvironment$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/updateEnvironment

Required parameters: name

Optional parameters: none

Body:

{:description string, :state string, :properties {:property [GoogleCloudApigeeV1Property]}, :lastModifiedAt string, :name string, :displayName string, :createdAt string}

Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API.

environments-updateTraceConfig$ clj

(environments-updateTraceConfig$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/environments/updateTraceConfig

Required parameters: name

Optional parameters: updateMask

Body:

{:endpoint string, :samplingConfig {:samplingRate number, :sampler string}, :exporter string}

Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.

get$ clj

(get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/get

Required parameters: name

Optional parameters: none

Gets the profile for an Apigee organization. See Understanding organizations.

getDeployedIngressConfig$ clj

(getDeployedIngressConfig$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/getDeployedIngressConfig

Required parameters: name

Optional parameters: view

Gets the deployed ingress configuration for an organization.

getSyncAuthorization$ clj

(getSyncAuthorization$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/getSyncAuthorization

Required parameters: name

Optional parameters: none

Body:

{}

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 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. Note: Available to Apigee hybrid only.

hostQueries-create$ clj

(hostQueries-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/hostQueries/create

Required parameters: parent

Optional parameters: none

Body:

{:reportDefinitionId string, :limit integer, :timeRange any, :name string, :envgroupHostname string, :outputFormat string, :dimensions [string], :filter string, :csvDelimiter string, :groupByTimeUnit string, :metrics [{:alias string, :operator string, :value string, :name string, :function string}]}

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.

hostQueries-get$ clj

(hostQueries-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/hostQueries/get

Required parameters: name

Optional parameters: none

Get status of a query submitted at host level. If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"

hostQueries-getResult$ clj

(hostQueries-getResult$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/hostQueries/getResult

Required parameters: name

Optional parameters: none

After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip

hostQueries-getResultView$ clj

(hostQueries-getResultView$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/hostQueries/getResultView

Required parameters: name

Optional parameters: none

hostQueries-list$ clj

(hostQueries-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/hostQueries/list

Required parameters: parent

Optional parameters: envgroupHostname, inclQueriesWithoutReport, to, status, from, dataset, submittedBy

Return a list of Asynchronous Queries at host level.

hostStats-get$ clj

(hostStats-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/hostStats/get

Required parameters: name

Optional parameters: tzo, limit, offset, timeRange, accuracy, realtime, topk, envgroupHostname, sortby, tsAscending, filter, timeUnit, sort, select

Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.

instances-attachments-create$ clj

(instances-attachments-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/attachments/create

Required parameters: parent

Optional parameters: none

Body:

{:environment string, :name string, :createdAt string}

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

instances-attachments-delete$ clj

(instances-attachments-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/attachments/delete

Required parameters: name

Optional parameters: none

Deletes an attachment. Note: Not supported for Apigee hybrid.

instances-attachments-get$ clj

(instances-attachments-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/attachments/get

Required parameters: name

Optional parameters: none

Gets an attachment. Note: Not supported for Apigee hybrid.

instances-attachments-list$ clj

(instances-attachments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/attachments/list

Required parameters: parent

Optional parameters: pageSize, pageToken

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

instances-canaryevaluations-create$ clj

(instances-canaryevaluations-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/canaryevaluations/create

Required parameters: parent

Optional parameters: none

Body:

{:startTime string, :treatment string, :name string, :endTime string, :createTime string, :state string, :control string, :metricLabels {:env string, :instance_id string, :location string}, :verdict string}

Creates a new canary evaluation for an organization.

instances-canaryevaluations-get$ clj

(instances-canaryevaluations-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/canaryevaluations/get

Required parameters: name

Optional parameters: none

Gets a CanaryEvaluation for an organization.

instances-create$ clj

(instances-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/create

Required parameters: parent

Optional parameters: none

Body:

{:description string, :diskEncryptionKeyName string, :displayName string, :name string, :createdAt string, :peeringCidrRange string, :state string, :port string, :host string, :lastModifiedAt string, :location string}

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

instances-delete$ clj

(instances-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/delete

Required parameters: name

Optional parameters: none

Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.

instances-get$ clj

(instances-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/get

Required parameters: name

Optional parameters: none

Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.

instances-list$ clj

(instances-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/list

Required parameters: parent

Optional parameters: pageToken, pageSize

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

instances-natAddresses-activate$ clj

(instances-natAddresses-activate$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/natAddresses/activate

Required parameters: name

Optional parameters: none

Body:

{}

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

instances-natAddresses-create$ clj

(instances-natAddresses-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/natAddresses/create

Required parameters: parent

Optional parameters: none

Body:

{:state string, :name string, :ipAddress string}

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.

instances-natAddresses-delete$ clj

(instances-natAddresses-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/natAddresses/delete

Required parameters: name

Optional parameters: none

Deletes the NAT address. Connections that are actively using the address are drained before it is removed. Note: Not supported for Apigee hybrid.

instances-natAddresses-get$ clj

(instances-natAddresses-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/natAddresses/get

Required parameters: name

Optional parameters: none

Gets the details of a NAT address. Note: Not supported for Apigee hybrid.

instances-natAddresses-list$ clj

(instances-natAddresses-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/natAddresses/list

Required parameters: parent

Optional parameters: pageToken, pageSize

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

instances-reportStatus$ clj

(instances-reportStatus$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/instances/reportStatus

Required parameters: instance

Optional parameters: none

Body:

{:resources [{:revisions [GoogleCloudApigeeV1RevisionStatus], :totalReplicas integer, :resource string, :uid string}], :reportTime string, :instanceUid string}

Reports the latest status for a runtime instance.

keyvaluemaps-create$ clj

(keyvaluemaps-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/keyvaluemaps/create

Required parameters: parent

Optional parameters: none

Body:

{:encrypted boolean, :name string}

Creates a key value map in an organization.

keyvaluemaps-delete$ clj

(keyvaluemaps-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/keyvaluemaps/delete

Required parameters: name

Optional parameters: none

Delete a key value map in an organization.

list$ clj

(list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/list

Required parameters: parent

Optional parameters: none

Lists the Apigee organizations and associated GCP projects that you have permission to access. See Understanding organizations.

operations-get$ clj

(operations-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/operations/get

Required parameters: name

Optional parameters: none

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

operations-list$ clj

(operations-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/operations/list

Required parameters: name

Optional parameters: pageToken, filter, pageSize

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.

optimizedHostStats-get$ clj

(optimizedHostStats-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/optimizedHostStats/get

Required parameters: name

Optional parameters: tzo, limit, offset, timeRange, accuracy, realtime, topk, envgroupHostname, sortby, tsAscending, filter, timeUnit, sort, select

This api is similar to GetHostStats except that the response is less verbose.

reports-create$ clj

(reports-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/reports/create

Required parameters: parent

Optional parameters: none

Body:

{:properties [{:value [GoogleCloudApigeeV1Attribute], :property string}], :toTime string, :tags [string], :lastViewedAt string, :limit string, :chartType string, :offset string, :displayName string, :sortByCols [string], :fromTime string, :name string, :comments [string], :createdAt string, :topk string, :organization string, :dimensions [string], :filter string, :lastModifiedAt string, :sortOrder string, :timeUnit string, :environment string, :metrics [{:function string, :name string}]}

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.

reports-delete$ clj

(reports-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/reports/delete

Required parameters: name

Optional parameters: none

Deletes an existing custom report definition

reports-get$ clj

(reports-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/reports/get

Required parameters: name

Optional parameters: none

Retrieve a custom report definition.

reports-list$ clj

(reports-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/reports/list

Required parameters: parent

Optional parameters: expand

Return a list of Custom Reports

reports-update$ clj

(reports-update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/reports/update

Required parameters: name

Optional parameters: none

Body:

{:properties [{:value [GoogleCloudApigeeV1Attribute], :property string}], :toTime string, :tags [string], :lastViewedAt string, :limit string, :chartType string, :offset string, :displayName string, :sortByCols [string], :fromTime string, :name string, :comments [string], :createdAt string, :topk string, :organization string, :dimensions [string], :filter string, :lastModifiedAt string, :sortOrder string, :timeUnit string, :environment string, :metrics [{:function string, :name string}]}

Update an existing custom report definition

setAddons$ clj

(setAddons$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/setAddons

Required parameters: org

Optional parameters: none

Body:

{:addonsConfig {:monetizationConfig GoogleCloudApigeeV1MonetizationConfig, :integrationConfig GoogleCloudApigeeV1IntegrationConfig, :advancedApiOpsConfig GoogleCloudApigeeV1AdvancedApiOpsConfig}}

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

setSyncAuthorization$ clj

(setSyncAuthorization$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/setSyncAuthorization

Required parameters: name

Optional parameters: none

Body:

{:etag string, :identities [string]}

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. 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. Note: Available to Apigee hybrid only.

sharedflows-create$ clj

(sharedflows-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/create

Required parameters: parent

Optional parameters: action, name

Body:

{:contentType string, :extensions [{}], :data string}

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.

sharedflows-delete$ clj

(sharedflows-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/delete

Required parameters: name

Optional parameters: none

Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.

sharedflows-deployments-list$ clj

(sharedflows-deployments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/deployments/list

Required parameters: parent

Optional parameters: none

Lists all deployments of a shared flow.

sharedflows-get$ clj

(sharedflows-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/get

Required parameters: name

Optional parameters: none

Gets a shared flow by name, including a list of its revisions.

sharedflows-list$ clj

(sharedflows-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/list

Required parameters: parent

Optional parameters: includeRevisions, includeMetaData

Lists all shared flows in the organization.

sharedflows-revisions-delete$ clj

(sharedflows-revisions-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/revisions/delete

Required parameters: name

Optional parameters: none

Deletes a shared flow and all associated policies, resources, and revisions. You must undeploy the shared flow before deleting it.

sharedflows-revisions-deployments-list$ clj

(sharedflows-revisions-deployments-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/revisions/deployments/list

Required parameters: parent

Optional parameters: none

Lists all deployments of a shared flow revision.

sharedflows-revisions-get$ clj

(sharedflows-revisions-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/revisions/get

Required parameters: name

Optional parameters: format

Gets a revision of a shared flow. To download the shared flow configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the shared flow configuration locally and upload the updated sharedFlow configuration revision, as described in updateSharedFlowRevision.

sharedflows-revisions-updateSharedFlowRevision$ clj

(sharedflows-revisions-updateSharedFlowRevision$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sharedflows/revisions/updateSharedFlowRevision

Required parameters: name

Optional parameters: validate

Body:

{:contentType string, :extensions [{}], :data string}

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.

sites-apicategories-create$ clj

(sites-apicategories-create$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sites/apicategories/create

Required parameters: parent

Optional parameters: none

Body:

{:siteId string, :id string, :updateTime string, :name string}

Creates a new category on the portal.

sites-apicategories-delete$ clj

(sites-apicategories-delete$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sites/apicategories/delete

Required parameters: name

Optional parameters: none

Deletes a category from the portal.

sites-apicategories-get$ clj

(sites-apicategories-get$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sites/apicategories/get

Required parameters: name

Optional parameters: none

Gets a category on the portal.

sites-apicategories-list$ clj

(sites-apicategories-list$ auth parameters)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sites/apicategories/list

Required parameters: parent

Optional parameters: none

Lists the categories on the portal.

sites-apicategories-patch$ clj

(sites-apicategories-patch$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/sites/apicategories/patch

Required parameters: name

Optional parameters: none

Body:

{:siteId string, :id string, :updateTime string, :name string}

Updates a category on the portal.

update$ clj

(update$ auth parameters body)

https://cloud.google.com/apigee-api-management/api/reference/rest/v1/organizations/update

Required parameters: name

Optional parameters: none

Body:

{:description string, :properties {:property [GoogleCloudApigeeV1Property]}, :analyticsRegion string, :expiresAt string, :runtimeType string, :displayName string, :name string, :caCertificate string, :customerName string, :billingType string, :createdAt string, :type string, :state string, :environments [string], :runtimeDatabaseEncryptionKeyName string, :lastModifiedAt string, :projectId string, :addonsConfig {:monetizationConfig GoogleCloudApigeeV1MonetizationConfig, :integrationConfig GoogleCloudApigeeV1IntegrationConfig, :advancedApiOpsConfig GoogleCloudApigeeV1AdvancedApiOpsConfig}, :attributes [string], :subscriptionType string, :authorizedNetwork string}

Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.