Google Git
Sign in
code / google-api-go-client / refs/tags/v0.24.0 / . / apigee / v1 / apigee-api.json
blob: f8e68fe204fcd995fe08d72ee1082b211cccd86c [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://apigee.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Apigee",
"description": "The Apigee API lets you programmatically manage Apigee hybrid with a set of RESTful operations, including:\u003cul\u003e \u003cli\u003eCreate, edit, and delete API proxies\u003c/li\u003e \u003cli\u003eManage users\u003c/li\u003e \u003cli\u003eDeploy and undeploy proxy revisions\u003c/li\u003e \u003cli\u003eConfigure environments\u003c/li\u003e\u003c/ul\u003e\u003cp\u003eFor information on using the APIs described in this section, see \u003ca href=\"docs.apigee.com/hybrid/latest/api-get-started\"\u003eGet started using the APIs\u003c/a\u003e.\u003c/p\u003e\u003cp\u003e\u003cstrong\u003eNote:\u003c/strong\u003e This product is available as a free trial for a time period of 60 days.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/apigee-api-management/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "apigee:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://apigee.mtls.googleapis.com/",
"name": "apigee",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"hybrid": {
"resources": {
"issuers": {
"methods": {
"list": {
"description": "Lists hybrid services and its trusted issuers service account ids.\nThis api is authenticated and unauthorized(allow all the users) and used by\nruntime authn-authz service to query control plane's issuer service account\nids.",
"flatPath": "v1/hybrid/issuers",
"httpMethod": "GET",
"id": "apigee.hybrid.issuers.list",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Must be of the form `hybrid/issuers`.",
"location": "path",
"pattern": "^hybrid/issuers$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ListHybridIssuersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"organizations": {
"methods": {
"create": {
"description": "Creates an Apigee organization. See\n[Create an\norganization](https://docs.apigee.com/hybrid/latest/precog-provision).",
"flatPath": "v1/organizations",
"httpMethod": "POST",
"id": "apigee.organizations.create",
"parameterOrder": [],
"parameters": {
"parent": {
"description": "Required. Name of the GCP project in which to associate the Apigee organization.\nPass the information as a query parameter using the following structure\nin your request:\n `projects/\u003cproject\u003e`",
"location": "query",
"type": "string"
}
},
"path": "v1/organizations",
"request": {
"$ref": "GoogleCloudApigeeV1Organization"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the profile for an Apigee organization.\nSee\n[Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations).",
"flatPath": "v1/organizations/{organizationsId}",
"httpMethod": "GET",
"id": "apigee.organizations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Apigee organization name in the following format:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Organization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getSyncAuthorization": {
"description": "Lists the service accounts with the permissions required to allow\nthe Synchronizer to download environment data from the control plane.\n\nAn ETag is returned in the response to `getSyncAuthorization`.\nPass that ETag when calling [setSyncAuthorization](setSyncAuthorization)\nto ensure that you are updating the correct version. If you don't pass the\nETag in the call to `setSyncAuthorization`, then the existing authorization\nis overwritten indiscriminately.\n\nFor more information, see\n[Enable Synchronizer\naccess](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access).\n\n**Note**: Available to Apigee hybrid only.",
"flatPath": "v1/organizations/{organizationsId}:getSyncAuthorization",
"httpMethod": "POST",
"id": "apigee.organizations.getSyncAuthorization",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the Apigee organization. Use the following structure in your\nrequest:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:getSyncAuthorization",
"request": {
"$ref": "GoogleCloudApigeeV1GetSyncAuthorizationRequest"
},
"response": {
"$ref": "GoogleCloudApigeeV1SyncAuthorization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the Apigee organizations and associated GCP projects that you have\npermission to access. See\n[Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations).",
"flatPath": "v1/organizations",
"httpMethod": "GET",
"id": "apigee.organizations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Use the following structure in your request:\n `organizations`",
"location": "path",
"pattern": "^organizations$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}",
"response": {
"$ref": "GoogleCloudApigeeV1ListOrganizationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setSyncAuthorization": {
"description": "Sets the permissions required to allow the Synchronizer to download\nenvironment data from the control plane. You must call this API to enable\nproper functioning of hybrid.\n\nPass the ETag when calling `setSyncAuthorization` to ensure that\nyou are updating the correct version. To get an ETag,\ncall [getSyncAuthorization](getSyncAuthorization).\nIf you don't pass the ETag in the call to `setSyncAuthorization`, then the\nexisting authorization is overwritten indiscriminately.\n\nFor more information, see\n[Enable Synchronizer\naccess](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access).\n\n**Note**: Available to Apigee hybrid only.",
"flatPath": "v1/organizations/{organizationsId}:setSyncAuthorization",
"httpMethod": "POST",
"id": "apigee.organizations.setSyncAuthorization",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the Apigee organization. Use the following structure in your\nrequest:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:setSyncAuthorization",
"request": {
"$ref": "GoogleCloudApigeeV1SyncAuthorization"
},
"response": {
"$ref": "GoogleCloudApigeeV1SyncAuthorization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates the properties for an Apigee organization. No other fields in the\norganization profile will be updated.",
"flatPath": "v1/organizations/{organizationsId}",
"httpMethod": "PUT",
"id": "apigee.organizations.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Apigee organization name in the following format:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Organization"
},
"response": {
"$ref": "GoogleCloudApigeeV1Organization"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"apiproducts": {
"methods": {
"attributes": {
"description": "Updates or creates API product attributes. This API **replaces** the\ncurrent list of attributes with the attributes specified in the request\nbody. In this way, you can update existing attributes, add new attributes,\nor delete existing attributes by omitting them from the request body.\n\nOAuth access tokens and Key Management Service (KMS) entities (apps,\ndevelopers, and API products) are cached for 180 seconds (current default).\nAny custom attributes associated with entities also get cached for at least\n180 seconds after entity is accessed during runtime.\nIn this case, the `ExpiresIn` element on the OAuthV2 policy won't be able\nto expire an access token in less than 180 seconds.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes",
"httpMethod": "POST",
"id": "apigee.organizations.apiproducts.attributes",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "**Required.** API product name in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e/apiproducts/\u003cvar\u003eapi_product_name\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/attributes",
"request": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"response": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates an API product in an organization.\nYou create API products after\nyou have proxied backend services using API proxies.\nAn API product is a\ncollection of API resources combined with quota settings and metadata that\nyou can use to deliver customized and productized API bundles to your\ndeveloper community. This metadata can include:\n\n- Scope\n- Environments\n- API proxies\n- Extensible profile\n\nAPI products enable you repackage APIs\non-the-fly, without having to do any additional coding or configuration.\nApigee recommends that you start with a simple API product including only\nrequired elements. You then provision credentials to apps to enable them to\nstart testing your APIs.\n\nAfter you have authentication and authorization\nworking against a simple API product, you can iterate to create finer\ngrained API products, defining different sets of API resources for each API\nproduct.\n\n\u003caside class=\"warning\"\u003e\u003cstrong\u003eWARNING:\u003c/strong\u003e\n\n- If you don't specify an API proxy in the request body, \u003cem\u003eany\u003c/em\u003e app\nassociated with the product can make calls to \u003cem\u003eany\u003c/em\u003e API in your\nentire organization.\n- If you don't specify an environment in the request body, the product\nallows access to all environments.\n\n\u003c/aside\u003e\n\nFor more information, see {{what_api_product}}",
"flatPath": "v1/organizations/{organizationsId}/apiproducts",
"httpMethod": "POST",
"id": "apigee.organizations.apiproducts.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent organization name under which the API product will\nbe created. Must be in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/apiproducts",
"request": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"response": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an API product from an organization.\n\nDeleting an API product\ncauses app requests to the resource URIs defined in the API product to\nfail.\n\nEnsure that you create a new API product to serve existing apps, unless\nyour intention is to disable access to the resources defined in the API\nproduct.\n\nThe API product name required in the request URL is the internal name of\nthe product, not the display name. While they may be the same, it depends\non whether the API product was created via the UI or the API. View the list\nof API products to verify the internal name.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.apiproducts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API product name in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e/apiproducts/\u003cvar\u003eapi_product_name\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets configuration details for an API product.\n\nThe API product name required in the request URL is the internal name of\nthe product, not the display name. While they may be the same, it depends\non whether the API product was created via the UI or the API. View the list\nof API products to verify the internal name.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "**Required.** API product name in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e/apiproducts/\u003cvar\u003eapi_product_name\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all API product names for an organization.\nFilter the list by passing an `attributename` and `attibutevalue`.\n\nThe limit on the number of API products returned by the API is 1000. You\ncan paginate the list of API products returned using the `startKey` and\n`count` query parameters.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.list",
"parameterOrder": [
"parent"
],
"parameters": {
"attributename": {
"description": "The name of the attribute to search.",
"location": "query",
"type": "string"
},
"attributevalue": {
"description": "The value of the attribute.",
"location": "query",
"type": "string"
},
"count": {
"description": "Enter the number of API products you want returned in the API call. The\nlimit is 1000.",
"format": "int64",
"location": "query",
"type": "string"
},
"expand": {
"description": "Set to `true` to get expanded details about each API.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "**Required.** The parent organization name in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"startKey": {
"description": "Gets a list of API products starting with a specific API product in the\nlist. For example, if you're returning 50 API products at a time (using the\n`count` query parameter), you can view products 50-99 by entering the name\nof the 50th API product in the first API (without using `startKey`).\nProduct name is case sensitive.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/apiproducts",
"response": {
"$ref": "GoogleCloudApigeeV1ListApiProductsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates an existing API product. You must include all required values,\nwhether or not you are updating them, as well as any optional values that\nyou are updating.\n\nThe API product name required in the request URL is the\ninternal name of the product, not the Display Name. While they may be the\nsame, it depends on whether the API product was created via UI or API. View\nthe list of API products to identify their internal names.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}",
"httpMethod": "PUT",
"id": "apigee.organizations.apiproducts.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "**Required.** API product name in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e/apiproducts/\u003cvar\u003eapi_product_name\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"response": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"attributes": {
"methods": {
"delete": {
"description": "Deletes an API product attribute.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.apiproducts.attributes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "**Required.** API product name in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e/apiproducts/\u003cvar\u003eapi_product_name\u003c/var\u003e/attributes/\u003cvar\u003eattribute_name\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the value of an API product attribute.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.attributes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "**Required.** API product name in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e/apiproducts/\u003cvar\u003eapi_product_name\u003c/var\u003e/attributes/\u003cvar\u003eattribute_name\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Returns a list of all API product attributes.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes",
"httpMethod": "GET",
"id": "apigee.organizations.apiproducts.attributes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent organization name. Must be in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e/apiproducts/\u003cvar\u003eapi_product_name\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/attributes",
"response": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateApiProductAttribute": {
"description": "Updates the value of an API product attribute. Limitations are:\n\nOAuth access tokens and Key Management Service (KMS) entities (apps,\ndevelopers, and API products) are cached for 180 seconds (current default).\nAny custom attributes associated with entities also get cached for at least\n180 seconds after entity is accessed during runtime.\nIn this case, the `ExpiresIn` element on the OAuthV2 policy won't be able\nto expire an access token in less than 180 seconds.",
"flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}",
"httpMethod": "POST",
"id": "apigee.organizations.apiproducts.attributes.updateApiProductAttribute",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "**Required.** API product name in the following form:\n\u003cpre\u003eorganizations/\u003cvar\u003eorganization_ID\u003c/var\u003e/apiproducts/\u003cvar\u003eapi_product_name\u003c/var\u003e\u003c/pre\u003e",
"location": "path",
"pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"apis": {
"methods": {
"create": {
"description": "Creates an API proxy.\nThe API proxy created will not be accessible at runtime until it is\ndeployed to an environment.\n\nCreate a new API proxy by setting the `name` query parameter to the\nname of the API proxy.\n\nImport an API proxy configuration bundle stored in zip format\non your local machine to your organization by doing the following:\n\n* Set the `name` query parameter to the name of the API proxy.\n* Set the `action` query parameter to `import`.\n* Set the `Content-Type` header to `multipart/form-data`.\n* Pass as a file the name of API proxy\n configuration bundle stored in zip format on your local machine using\n the `file` form field.\n\n**Note**: To validate the API proxy configuration bundle only\n without importing it, set the `action` query\n parameter to `validate`.\n\nWhen importing an API proxy configuration bundle, if the API proxy\ndoes not exist, it will be created.\nIf the API proxy exists, then a new revision is created. Invalid API\nproxy configurations are rejected, and a list of validation errors is\nreturned to the client.",
"flatPath": "v1/organizations/{organizationsId}/apis",
"httpMethod": "POST",
"id": "apigee.organizations.apis.create",
"parameterOrder": [
"parent"
],
"parameters": {
"action": {
"description": "Action to perform when importing an API proxy configuration bundle. Set\nthis parameter to one of the following values:\n\n* `import` to import the API proxy configuration bundle.\n* `validate` to validate the API proxy configuration bundle without\n importing it.",
"location": "query",
"type": "string"
},
"name": {
"description": "Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Name of the organization in the following format:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"validate": {
"description": "Ignored. All uploads are validated regardless of the value of this\nfield. Maintained for compatibility with Apigee Edge API.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/apis",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleCloudApigeeV1ApiProxyRevision"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an API proxy and all associated endpoints, policies, resources, and\nrevisions. The API proxy must be undeployed before you can delete it.",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.apis.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API proxy in the following format:\n `organizations/{org}/apis/{api}`",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ApiProxy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an API proxy including a list of existing revisions.",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}",
"httpMethod": "GET",
"id": "apigee.organizations.apis.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API proxy in the following format:\n `organizations/{org}/apis/{api}`",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ApiProxy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the names of all API proxies in an organization. The names returned\ncorrespond to the names defined in the configuration files for each API\nproxy.",
"flatPath": "v1/organizations/{organizationsId}/apis",
"httpMethod": "GET",
"id": "apigee.organizations.apis.list",
"parameterOrder": [
"parent"
],
"parameters": {
"includeMetaData": {
"description": "Flag that specifies whether to include API proxy metadata in the response.",
"location": "query",
"type": "boolean"
},
"includeRevisions": {
"description": "Flag that specifies whether to include a list of revisions in the response.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. Name of the organization in the following format:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/apis",
"response": {
"$ref": "GoogleCloudApigeeV1ListApiProxiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"deployments": {
"methods": {
"list": {
"description": "Lists all deployments of an API proxy.",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.apis.deployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the API proxy for which to return deployment information in the\nfollowing format:\n `organizations/{org}/apis/{api}`",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"keyvaluemaps": {
"methods": {
"create": {
"description": "Creates a key value map in an api proxy.",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps",
"httpMethod": "POST",
"id": "apigee.organizations.apis.keyvaluemaps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the environment in which to create the key value map.\nMust be of the form\n`organizations/{organization}/apis/{api}`.",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/keyvaluemaps",
"request": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"response": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete a key value map in an api proxy.",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.apis.keyvaluemaps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the key value map.\nMust be of the form\n`organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`.",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"revisions": {
"methods": {
"delete": {
"description": "Deletes an API proxy revision and all policies, resources, endpoints,\nand revisions associated with it. The API proxy revision must be undeployed\nbefore you can delete it.",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.apis.revisions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API proxy revision in the following format:\n `organizations/{org}/apis/{api}/revisions/{rev}`",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1ApiProxyRevision"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an API proxy revision.\n\nTo download the API proxy configuration bundle for the specified revision\nas a zip file, do the following:\n\n * Set the `format` query parameter to `bundle`.\n * Set the `Accept` header to `application/zip`.\n\nIf you are using curl, specify `-o filename.zip` to save the output to a\nfile; otherwise, it displays to `stdout`. Then, develop the API proxy\nconfiguration locally and upload the updated API proxy configuration\nrevision, as described in\n[updateApiProxyRevision](updateApiProxyRevision).",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}",
"httpMethod": "GET",
"id": "apigee.organizations.apis.revisions.get",
"parameterOrder": [
"name"
],
"parameters": {
"format": {
"description": "Format used when downloading the API proxy configuration revision.\nSet to `bundle` to download the API proxy configuration revision as a zip\nfile.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. API proxy revision in the following format:\n `organizations/{org}/apis/{api}/revisions/{rev}`",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateApiProxyRevision": {
"description": "Updates an existing API proxy revision by uploading the API proxy\nconfiguration bundle as a zip file from your local machine.\n\nYou can update only API proxy revisions\nthat have never been deployed. After deployment, an API proxy revision\nbecomes immutable, even if it is undeployed.\n\nSet the `Content-Type` header to either\n`multipart/form-data` or `application/octet-stream`.",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}",
"httpMethod": "POST",
"id": "apigee.organizations.apis.revisions.updateApiProxyRevision",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API proxy revision to update in the following format:\n `organizations/{org}/apis/{api}/revisions/{rev}`",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
},
"validate": {
"description": "Ignored. All uploads are validated regardless of the value of this field.\nMaintained for compatibility with Apigee Edge API.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleCloudApigeeV1ApiProxyRevision"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"deployments": {
"methods": {
"list": {
"description": "Lists all deployments of an API proxy revision.",
"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.apis.revisions.deployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the API proxy revision for which to return deployment information\nin the following format:\n `organizations/{org}/apis/{api}/revisions/{rev}`.",
"location": "path",
"pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"apps": {
"methods": {
"get": {
"description": "Gets the app profile for the specified app ID.",
"flatPath": "v1/organizations/{organizationsId}/apps/{appsId}",
"httpMethod": "GET",
"id": "apigee.organizations.apps.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. App ID in the following format:\n `organizations/{org}/apps/{app}`",
"location": "path",
"pattern": "^organizations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1App"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists IDs of apps within an organization that have the specified app status\n(approved or revoked) or are of the specified app type\n(developer or company).",
"flatPath": "v1/organizations/{organizationsId}/apps",
"httpMethod": "GET",
"id": "apigee.organizations.apps.list",
"parameterOrder": [
"parent"
],
"parameters": {
"apiProduct": {
"description": "API product.",
"location": "query",
"type": "string"
},
"apptype": {
"description": "Optional. Filter by the type of the app. Valid values are `company` or\n`developer`. Defaults to `developer`.",
"location": "query",
"type": "string"
},
"expand": {
"description": "Optional. Flag that specifies whether to return an expanded list of\napps for the organization. Defaults to `false`.",
"location": "query",
"type": "boolean"
},
"ids": {
"description": "Optional. Comma-separated list of app IDs on which to filter.",
"location": "query",
"type": "string"
},
"includeCred": {
"description": "Optional. Flag that specifies whether to include credentials in the\nresponse.",
"location": "query",
"type": "boolean"
},
"keyStatus": {
"description": "Optional. Key status of the app. Valid values include `approved` or\n`revoked`. Defaults to `approved`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource path of the parent in the following format:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"rows": {
"description": "Optional. Maximum number of app IDs to return. Defaults to 10000.",
"format": "int64",
"location": "query",
"type": "string"
},
"startKey": {
"description": "Returns the list of apps starting from the specified app ID.",
"location": "query",
"type": "string"
},
"status": {
"description": "Optional. Filter by the status of the app. Valid values are `approved`\nor `revoked`. Defaults to `approved`.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/apps",
"response": {
"$ref": "GoogleCloudApigeeV1ListAppsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"companies": {
"methods": {
"create": {
"description": "Creates an app for a company. Note that you must first create a profile\nfor the company in your organization before you can register apps that\nare associated with the company.",
"flatPath": "v1/organizations/{organizationsId}/companies",
"httpMethod": "POST",
"id": "apigee.organizations.companies.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Name of org that the company will be created in\n`{parent=organizations/*}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/companies",
"request": {
"$ref": "GoogleCloudApigeeV1Company"
},
"response": {
"$ref": "GoogleCloudApigeeV1Company"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing company.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.companies.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The company resource name\n`organizations/{org}/companies/{company}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Company"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "List details for a company.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}",
"httpMethod": "GET",
"id": "apigee.organizations.companies.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The company resource name\n`organizations/{org}/companies/{company}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Company"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List all companies in an organization, and optionally returns an\nexpanded list of companies, displaying a full profile for each company in\nthe organization.",
"flatPath": "v1/organizations/{organizationsId}/companies",
"httpMethod": "GET",
"id": "apigee.organizations.companies.list",
"parameterOrder": [
"parent"
],
"parameters": {
"count": {
"description": "Limits the list to the number you specify. The limit is 100.",
"format": "int64",
"location": "query",
"type": "string"
},
"expand": {
"description": "Set expand to true to return a full profile for each company.",
"location": "query",
"type": "boolean"
},
"includeDevelopers": {
"description": "Optional. include developers in the response.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "The parent organization name\n`organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"startKey": {
"description": "To filter the keys that are returned, enter the email of a developer\nthat the list will start with.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/companies",
"response": {
"$ref": "GoogleCloudApigeeV1ListCompaniesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates an existing company.\nSend the complete company record as a payload with any changes you want to\nmake. Note that to change the status of the Company you use Set the Status\nof a Company. The attributes in the sample payload below apply to company\nconfiguration in monetization. For non-monetized companies, you need send\nonly displayName.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}",
"httpMethod": "PUT",
"id": "apigee.organizations.companies.update",
"parameterOrder": [
"name"
],
"parameters": {
"action": {
"description": "Specify the status as active or inactive.",
"location": "query",
"type": "string"
},
"name": {
"description": "Name of the company to be updated.\n`{name=organizations/*/companies/*}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Company"
},
"response": {
"$ref": "GoogleCloudApigeeV1Company"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"apps": {
"methods": {
"create": {
"description": "Creates an app for a company.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps",
"httpMethod": "POST",
"id": "apigee.organizations.companies.apps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Resource path of the parent: `organizations/{org}/companies/{company_name}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/apps",
"request": {
"$ref": "GoogleCloudApigeeV1CompanyApp"
},
"response": {
"$ref": "GoogleCloudApigeeV1CompanyApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a company app.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.companies.apps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "name of the app resource:\n`organizations/{org}/companies/{company_name}/apps/{app_name}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1CompanyApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the profile of a specific company app.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}",
"httpMethod": "GET",
"id": "apigee.organizations.companies.apps.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "name of the app resource:\n`organizations/{org}/companies/{company_name}/apps/{app_name}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1CompanyApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List company apps in an organization. You can optionally expand the\nresponse to include the profile for each app.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps",
"httpMethod": "GET",
"id": "apigee.organizations.companies.apps.list",
"parameterOrder": [
"parent"
],
"parameters": {
"count": {
"description": "Limits the list to the number you specify. The limit is 100.",
"format": "int64",
"location": "query",
"type": "string"
},
"expand": {
"description": "Set expand to true to return a full profile",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "The name of a company resource:\n`organizations/{org}/companies/{company_name}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+$",
"required": true,
"type": "string"
},
"startKey": {
"description": "Lets you return a list of app starting with a specific app name in the\nlist.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/apps",
"response": {
"$ref": "GoogleCloudApigeeV1ListCompanyAppsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates an existing company app.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}",
"httpMethod": "PUT",
"id": "apigee.organizations.companies.apps.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource path of the app:\n`organizations/{org}/companies/{company_name}/apps/{app_name}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1CompanyApp"
},
"response": {
"$ref": "GoogleCloudApigeeV1CompanyApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"keys": {
"methods": {
"delete": {
"description": "Deletes a key for a company app and removes all API products associated\nwith the app. The key can no longer be used to access any APIs.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}/keys/{keysId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.companies.apps.keys.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of a company app key\n`organizations/{org}/companies/{company}/apps/{app}/keys/{key}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1CompanyAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets information about the consumer key issued to a specific company app.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}/keys/{keysId}",
"httpMethod": "GET",
"id": "apigee.organizations.companies.apps.keys.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of a company app key\n`organizations/{org}/companies/{company}/apps/{app}/keys/{key}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1CompanyAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateCompanyAppKey": {
"description": "Updates an existing company app key to add additional API products or\nattributes. Note that only a single API product can be resolved per app\nkey at runtime. API products are resolved by name, in alphabetical order.\nThe first API product found in the list will be returned.",
"flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}/keys/{keysId}",
"httpMethod": "POST",
"id": "apigee.organizations.companies.apps.keys.updateCompanyAppKey",
"parameterOrder": [
"name"
],
"parameters": {
"action": {
"description": "Set action to approve or revoke.",
"location": "query",
"type": "string"
},
"name": {
"description": "Resource name of a company app key\n`organizations/{org}/companies/{company}/apps/{app}/keys/{key}`",
"location": "path",
"pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1CompanyAppKey"
},
"response": {
"$ref": "GoogleCloudApigeeV1CompanyAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"deployments": {
"methods": {
"list": {
"description": "Lists all deployments of API proxies or shared flows.",
"flatPath": "v1/organizations/{organizationsId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.deployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the organization for which to return deployment information in the\nfollowing format:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"sharedFlows": {
"description": "Optional. Flag that specifies whether to return shared flow or API proxy deployments.\nSet to `true` to return shared flow deployments; set to `false`\nto return API proxy deployments. Defaults to `false`.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"developers": {
"methods": {
"attributes": {
"description": "Updates developer attributes.\n\nThis API replaces the\nexisting attributes with those specified in the request.\nAdd new attributes, and include or exclude any existing\nattributes that you want to retain or\nremove, respectively.\n\nThe custom attribute limit is 18.\n\n**Note**: OAuth access tokens and Key Management Service (KMS) entities\n(apps, developers, and API products) are cached for 180 seconds\n(default). Any custom attributes associated with these entities\nare cached for at least 180 seconds after the entity is accessed at\nruntime. Therefore, an `ExpiresIn` element on the OAuthV2 policy\nwon't be able to expire an access token in less than 180 seconds.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes",
"httpMethod": "POST",
"id": "apigee.organizations.developers.attributes",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Email address of the developer for which attributes are being updated in\nthe following format:\n `organizations/{org}/developers/{developer_email}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/attributes",
"request": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"response": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a developer. Once created,\nthe developer can register an app and obtain an API key.\n\nAt creation time, a developer is set as `active`. To change the developer\nstatus, use the SetDeveloperStatus API.",
"flatPath": "v1/organizations/{organizationsId}/developers",
"httpMethod": "POST",
"id": "apigee.organizations.developers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the Apigee organization in which the developer is created.\nUse the following structure in your request:\n `organizations/{org}`.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/developers",
"request": {
"$ref": "GoogleCloudApigeeV1Developer"
},
"response": {
"$ref": "GoogleCloudApigeeV1Developer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a developer. All apps and API keys associated\nwith the developer are also removed.\n\n**Warning**: This API will permanently delete the developer\nand related artifacts.\n\nTo avoid permanently deleting developers and their artifacts,\nset the developer status to `inactive` using\nthe SetDeveloperStatus API.\n\n**Note**: The delete operation is asynchronous. The developer app is\ndeleted immediately,\nbut its associated resources, such as apps and API keys, may take anywhere\nfrom a few seconds to a few minutes to be deleted.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.developers.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Email address of the developer. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Developer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the developer details, including the\ndeveloper's name, email address, apps, and other information.\n\n**Note**: The response includes only the first 100 developer apps.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}",
"httpMethod": "GET",
"id": "apigee.organizations.developers.get",
"parameterOrder": [
"name"
],
"parameters": {
"action": {
"description": "Status of the developer. Valid values are `active` or `inactive`.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Email address of the developer. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Developer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all developers in an organization by email address.\n\nBy default,\nthe response does not include company developers. Set the `includeCompany`\nquery parameter to `true` to include company developers.\n\n**Note**: A maximum of 1000 developers are returned in the response. You\npaginate the list of developers returned using the `startKey` and `count`\nquery parameters.",
"flatPath": "v1/organizations/{organizationsId}/developers",
"httpMethod": "GET",
"id": "apigee.organizations.developers.list",
"parameterOrder": [
"parent"
],
"parameters": {
"count": {
"description": "Optional. Number of developers to return in the API call. Use with the `startKey`\nparameter to provide more targeted filtering.\nThe limit is 1000.",
"format": "int64",
"location": "query",
"type": "string"
},
"expand": {
"description": "Specifies whether to expand the results. Set to `true`\nto expand the results. This query parameter is not valid if you use\nthe `count` or `startKey` query parameters.",
"location": "query",
"type": "boolean"
},
"ids": {
"description": "Optional. List of IDs to include, separated by commas.",
"location": "query",
"type": "string"
},
"includeCompany": {
"description": "Flag that specifies whether to include company details in the response.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. Name of the Apigee organization. Use the following structure in your\nrequest:\n `organizations/{org}`.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"startKey": {
"description": "**Note**: Must be used in conjunction with the `count` parameter.\n\nEmail address of the developer from which to start displaying the list of\ndevelopers. For example, if the an unfiltered list returns:\n\n```\nwestley@example.com\nfezzik@example.com\nbuttercup@example.com\n```\n\nand your `startKey` is `fezzik@example.com`, the list returned will be\n\n```\nfezzik@example.com\nbuttercup@example.com\n```",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/developers",
"response": {
"$ref": "GoogleCloudApigeeV1ListOfDevelopersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setDeveloperStatus": {
"description": "Sets the status of a developer. Valid values are `active` or `inactive`.\n\nA developer is `active` by default. If you set a developer's status to\n`inactive`, the API keys assigned to the developer apps are no longer valid\neven though the API keys are set to `approved`. Inactive developers\ncan still sign in to the developer portal and create apps; however, any\nnew API keys generated during app creation won't work.\n\nIf successful, the API call returns the\nfollowing HTTP status code: `204 No Content`",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}",
"httpMethod": "POST",
"id": "apigee.organizations.developers.setDeveloperStatus",
"parameterOrder": [
"name"
],
"parameters": {
"action": {
"description": "Status of the developer. Valid values are `active` and `inactive`.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Email address of the developer. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates a developer.\n\nThis API replaces the existing developer details with those specified\nin the request. Include or exclude any existing details that\nyou want to retain or delete, respectively.\n\nThe custom attribute limit is 18.\n\n**Note**: OAuth access tokens and Key Management Service (KMS) entities\n(apps, developers, and API products) are cached for 180 seconds\n(current default). Any custom attributes associated with these entities\nare cached for at least 180 seconds after the entity is accessed at\nruntime. Therefore, an `ExpiresIn` element on the OAuthV2 policy\nwon't be able to expire an access token in less than 180 seconds.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}",
"httpMethod": "PUT",
"id": "apigee.organizations.developers.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Email address of the developer. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Developer"
},
"response": {
"$ref": "GoogleCloudApigeeV1Developer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"apps": {
"methods": {
"attributes": {
"description": "Updates attributes for a developer app. This API replaces the\ncurrent attributes with those specified in the request.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes",
"httpMethod": "POST",
"id": "apigee.organizations.developers.apps.attributes",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/attributes",
"request": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"response": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates an app associated with a developer. This API associates the\ndeveloper app with the specified API\nproduct and auto-generates an API key for the app to use in calls to API\nproxies inside that API product.\n\nThe `name` is the unique ID of the app\nthat you can use in API calls. The `DisplayName` (set as an\nattribute) appears in the UI. If you don't set the\n`DisplayName` attribute, the `name` appears in the UI.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps",
"httpMethod": "POST",
"id": "apigee.organizations.developers.apps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the developer. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/apps",
"request": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a developer app.\n\n**Note**: The delete operation is asynchronous. The developer app is\ndeleted immediately,\nbut its associated resources, such as app\nkeys or access tokens, may take anywhere from a few seconds to a\nfew minutes to be deleted.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.developers.apps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"generateKeyPairOrUpdateDeveloperAppStatus": {
"description": "Manages access to a developer app by enabling you to:\n\n* Approve or revoke a developer app\n* Generate a new consumer key and secret for a developer app\n\nTo approve or revoke a developer app, set the `action` query parameter to\n`approved` or `revoked`, respectively, and the\n`Content-Type` header to `application/octet-stream`. If a developer app is\nrevoked, none of its API keys are valid for API calls even though\nthe keys are still `approved`. If successful, the API call returns the\nfollowing HTTP status code: `204 No Content`\n\nTo generate a new consumer key and secret for a developer\napp, pass the new key/secret details. Rather than\nreplace an existing key, this API generates a new\nkey. In this case, multiple key\npairs may be associated with a single developer app. Each key pair has an\nindependent status (`approved` or `revoked`) and expiration time.\nAny approved, non-expired key can be used in an API call.\n\nFor example, if you're using API key rotation, you can generate new\nkeys with expiration times that overlap keys that are going to expire.\nYou might also generate a new consumer key/secret if the security of the\noriginal key/secret is compromised.\n\nThe `keyExpiresIn` property defines the\nexpiration time for the API key in milliseconds. If you don't set\nthis property or set it to `-1`, the API key never expires.\n\n**Notes**:\n\n* When generating a new key/secret, this API replaces the\nexisting attributes, notes, and callback URLs with those specified in the\nrequest. Include or exclude any existing information that you want to\nretain or delete, respectively.\n* To migrate existing consumer keys and secrets to hybrid from another\nsystem, see the\nCreateDeveloperAppKey API.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}",
"httpMethod": "POST",
"id": "apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus",
"parameterOrder": [
"name"
],
"parameters": {
"action": {
"description": "Action. Valid values are `approve` or `revoke`.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the details for a developer app.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}",
"httpMethod": "GET",
"id": "apigee.organizations.developers.apps.get",
"parameterOrder": [
"name"
],
"parameters": {
"entity": {
"description": "**Note**: Must be used in conjunction with the `query` parameter.\n\nSet to `apiresources`\nto return the number of API resources\nthat have been approved for access by a developer app in the\nspecified Apigee organization.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
},
"query": {
"description": "**Note**: Must be used in conjunction with the `entity` parameter.\n\nSet to `count` to return the number of API resources\nthat have been approved for access by a developer app in the\nspecified Apigee organization.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all apps created by a developer in an Apigee organization.\nOptionally, you can request an expanded view of the developer apps.\n\nA maximum of 100 developer apps are returned per API call. You can paginate\nthe list of deveoper apps returned using the `startKey` and `count` query\nparameters.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps",
"httpMethod": "GET",
"id": "apigee.organizations.developers.apps.list",
"parameterOrder": [
"parent"
],
"parameters": {
"count": {
"description": "Number of developer apps to return in the API call. Use with the `startKey`\nparameter to provide more targeted filtering.\nThe limit is 1000.",
"format": "int64",
"location": "query",
"type": "string"
},
"expand": {
"description": "Optional. Specifies whether to expand the results. Set to `true`\nto expand the results. This query parameter is not valid if you use\nthe `count` or `startKey` query parameters.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. Name of the developer. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+$",
"required": true,
"type": "string"
},
"shallowExpand": {
"description": "Optional. Specifies whether to expand the results in shallow mode.\nSet to `true` to expand the results in shallow mode.",
"location": "query",
"type": "boolean"
},
"startKey": {
"description": "**Note**: Must be used in conjunction with the `count` parameter.\n\nName of the developer app from which to start displaying the list of\ndeveloper apps. For example, if you're returning 50 developer apps at\na time (using the `count` query parameter), you can view developer apps\n50-99 by entering the name of the 50th developer app.\nThe developer app name is case sensitive.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/apps",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeveloperAppsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates the details for a developer app. In addition, you can\nadd an API product to a developer app and automatically generate\nan API key for the app to use when calling APIs in the API product.\n\nIf you want to use an existing API key for the API product,\nadd the API product to the API key using the\nUpdateDeveloperAppKey\nAPI.\n\nUsing this API, you cannot update the following:\n\n* App name as it is the primary key used to identify the app and cannot\n be changed.\n* Scopes associated with the app. Instead, use the\n ReplaceDeveloperAppKey API.\n\nThis API replaces the\nexisting attributes with those specified in the request.\nInclude or exclude any existing attributes that you want to retain or\ndelete, respectively.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}",
"httpMethod": "PUT",
"id": "apigee.organizations.developers.apps.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"attributes": {
"methods": {
"delete": {
"description": "Deletes a developer app attribute.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.developers.apps.attributes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer app attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns a developer app attribute.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}",
"httpMethod": "GET",
"id": "apigee.organizations.developers.apps.attributes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer app attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Returns a list of all developer app attributes.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes",
"httpMethod": "GET",
"id": "apigee.organizations.developers.apps.attributes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/attributes",
"response": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateDeveloperAppAttribute": {
"description": "Updates a developer app attribute.\n\n**Note**: OAuth access tokens and Key Management Service (KMS) entities\n(apps, developers, and API products) are cached for 180 seconds\n(current default). Any custom attributes associated with these entities\nare cached for at least 180 seconds after the entity is accessed at\nruntime. Therefore, an `ExpiresIn` element on the OAuthV2 policy\nwon't be able to expire an access token in less than 180 seconds.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}",
"httpMethod": "POST",
"id": "apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer app attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"keys": {
"methods": {
"create": {
"description": "Creates a custom consumer key and secret for a developer app. This is\nparticularly useful if you want to migrate existing consumer keys and\nsecrets to Apigee hybrid from another system.\n\nConsumer keys and secrets can contain letters, numbers, underscores, and\nhyphens. No other special characters are allowed.\n\n**Note**: To avoid service disruptions, a consumer key and secret\nshould not exceed 2 KBs each.\n\nAfter creating the consumer key and secret, associate the key with\nan API product using the\nUpdateDeveloperAppKey API.\n\nIf a consumer key and secret already exist, you can keep them or\ndelete them using the\nDeleteDeveloperAppKey API.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys",
"httpMethod": "POST",
"id": "apigee.organizations.developers.apps.keys.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent of the developer app key. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/keys",
"request": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an app's consumer key and removes all API products\nassociated with the app. After the consumer key is deleted,\nit cannot be used to access any APIs.\n\n**Note**: After you delete a consumer key, you may want to:\n1. Create a new consumer key and secret for the developer app using the\nCreateDeveloperAppKey API, and\nsubsequently add an API product to the key using the\nUpdateDeveloperAppKey API.\n2. Delete the developer app, if it is no longer required.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.developers.apps.keys.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the developer app key. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns details for a consumer key for a developer app, including the key\nand secret value, associated API products, and other information.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}",
"httpMethod": "GET",
"id": "apigee.organizations.developers.apps.keys.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the developer app key. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"replaceDeveloperAppKey": {
"description": "Updates the scope of an app.\n\nThis API replaces the\nexisting scopes with those specified in the request.\nInclude or exclude any existing scopes that you want to retain or\ndelete, respectively. The specified scopes must already\nbe defined for the API products associated with the app.\n\nThis API sets the `scopes` element\nunder the `apiProducts` element in the attributes of the app.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}",
"httpMethod": "PUT",
"id": "apigee.organizations.developers.apps.keys.replaceDeveloperAppKey",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the developer app key. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateDeveloperAppKey": {
"description": "Adds an API product to a developer app key, enabling the app that holds\nthe key to access the API resources bundled in the API product.\n\nIn addition, you can add\nattributes to a developer app key. This API replaces the\nexisting attributes with those specified in the request.\nInclude or exclude any existing attributes that you want to retain or\ndelete, respectively.\n\nYou can use the same key to access all API products\nassociated with the app.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}",
"httpMethod": "POST",
"id": "apigee.organizations.developers.apps.keys.updateDeveloperAppKey",
"parameterOrder": [
"name"
],
"parameters": {
"action": {
"description": "Approve or revoke the consumer key by setting this value to\n`approve` or `revoke`, respectively.",
"location": "query",
"type": "string"
},
"name": {
"description": "Name of the developer app key. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"apiproducts": {
"methods": {
"delete": {
"description": "Removes an API product from an app's consumer key. After the API product is\nremoved, the app cannot access the API resources defined in\nthat API product.\n\n**Note**: The consumer key is not removed, only its association with the\nAPI product.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.developers.apps.keys.apiproducts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the API product in the developer app key in the following\nformat:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateDeveloperAppKeyApiProduct": {
"description": "Approve or revoke an app's consumer key. After a consumer key is approved,\nthe app can use it to access APIs.\n\nA consumer key that is revoked or pending cannot be used to access an API.\nAny access tokens associated with a revoked consumer key will remain\nactive. However, Apigee hybrid checks the status of the consumer key and\nif set to `revoked` will not allow access to the API.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}",
"httpMethod": "POST",
"id": "apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct",
"parameterOrder": [
"name"
],
"parameters": {
"action": {
"description": "Approve or revoke the consumer key by setting this value to\n`approve` or `revoke`, respectively.",
"location": "query",
"type": "string"
},
"name": {
"description": "Name of the API product in the developer app key in the following\nformat:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+/apiproducts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"create": {
"methods": {
"create": {
"description": "Creates a custom consumer key and secret for a developer app. This is\nparticularly useful if you want to migrate existing consumer keys and\nsecrets to Apigee hybrid from another system.\n\nConsumer keys and secrets can contain letters, numbers, underscores, and\nhyphens. No other special characters are allowed.\n\n**Note**: To avoid service disruptions, a consumer key and secret\nshould not exceed 2 KBs each.\n\nAfter creating the consumer key and secret, associate the key with\nan API product using the\nUpdateDeveloperAppKey API.\n\nIf a consumer key and secret already exist, you can keep them or\ndelete them using the\nDeleteDeveloperAppKey API.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create",
"httpMethod": "POST",
"id": "apigee.organizations.developers.apps.keys.create.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent of the developer app key. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/keys/create",
"request": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"response": {
"$ref": "GoogleCloudApigeeV1DeveloperAppKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"attributes": {
"methods": {
"delete": {
"description": "Deletes a developer attribute.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.developers.attributes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/attributes/{attribute}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the value of the specified developer attribute.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}",
"httpMethod": "GET",
"id": "apigee.organizations.developers.attributes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/attributes/{attribute}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Returns a list of all developer attributes.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes",
"httpMethod": "GET",
"id": "apigee.organizations.developers.attributes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Email address of the developer for which attributes are being listed in the\nfollowing format:\n `organizations/{org}/developers/{developer_email}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/attributes",
"response": {
"$ref": "GoogleCloudApigeeV1Attributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateDeveloperAttribute": {
"description": "Updates a developer attribute.\n\n**Note**: OAuth access tokens and Key Management Service (KMS) entities\n(apps, developers, and API products) are cached for 180 seconds\n(default). Any custom attributes associated with these entities\nare cached for at least 180 seconds after the entity is accessed at\nruntime. Therefore, an `ExpiresIn` element on the OAuthV2 policy\nwon't be able to expire an access token in less than 180 seconds.",
"flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}",
"httpMethod": "POST",
"id": "apigee.organizations.developers.attributes.updateDeveloperAttribute",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the developer attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/attributes/{attribute}`",
"location": "path",
"pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"response": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"environments": {
"methods": {
"create": {
"description": "Creates an environment in an organization.",
"flatPath": "v1/organizations/{organizationsId}/environments",
"httpMethod": "POST",
"id": "apigee.organizations.environments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"name": {
"description": "Optional. Name of the environment. Alternatively, the name may\nbe specified in the request body in the\nenvironment_id field.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Name of the organization in which the environment will\nbe created. Use the following structure in your request:\n `organizations/{org}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/environments",
"request": {
"$ref": "GoogleCloudApigeeV1Environment"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an environment from an organization.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the environment. Use the following structure in your\nrequest:\n `organizations/{org}/environments/{env}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets environment details.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Environment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getDatalocation": {
"description": "Get Google Cloud Storage (GCS) signed url for specific organization and\nenvironment. Collection agent uses this signed url to upload data\nto GCS bucket.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/datalocation",
"httpMethod": "GET",
"id": "apigee.organizations.environments.getDatalocation",
"parameterOrder": [
"name"
],
"parameters": {
"contentType": {
"description": "Content-Type for uploaded file.",
"location": "query",
"type": "string"
},
"dataset": {
"description": "Required. Dataset could be one of `api`, `mint`, `trace` and `event`",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The parent organization and environment names. Must be of the\nform `organizations/{org}/environments/{env}/datalocation`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/datalocation$",
"required": true,
"type": "string"
},
"relativeFilePath": {
"description": "Required. Relative path to the GCS bucket",
"location": "query",
"type": "string"
},
"repo": {
"description": "Required. Repository name",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DataLocation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getDebugmask": {
"description": "Gets the debug mask singleton resource for an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask",
"httpMethod": "GET",
"id": "apigee.organizations.environments.getDebugmask",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the debug mask. Use the following structure in your request:\n `organizations/{org}/environments/{env}/debugmask`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/debugmask$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DebugMask"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getDeployedConfig": {
"description": "Gets the deployed configuration for an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig",
"httpMethod": "GET",
"id": "apigee.organizations.environments.getDeployedConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the environment deployed configuration resource. Use the following\nstructure in your request:\n `organizations/{org}/environments/{env}/deployedConfig`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/deployedConfig$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1EnvironmentConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the IAM policy on an environment. For more information, see\n[Manage users, roles, and permissions\nusing the API](https://docs.apigee.com/hybrid/latest/manage-users-roles).\n\nYou must have the `apigee.environments.getIamPolicy` permission to call\nthis API.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy",
"httpMethod": "GET",
"id": "apigee.organizations.environments.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the IAM policy on an environment, if the policy already\nexists it will be replaced. For more information, see\n[Manage users, roles, and permissions\nusing the API](https://docs.apigee.com/hybrid/latest/manage-users-roles).\n\nYou must have the `apigee.environments.setIamPolicy` permission to\ncall this API.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy",
"httpMethod": "POST",
"id": "apigee.organizations.environments.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1SetIamPolicyRequest"
},
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"subscribe": {
"description": "Creates a subscription for the environment's Pub/Sub topic.\nThe server will assign a random name for this subscription.\nThe \"name\" and \"push_config\" must *not* be specified.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe",
"httpMethod": "POST",
"id": "apigee.organizations.environments.subscribe",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:subscribe",
"response": {
"$ref": "GoogleCloudApigeeV1Subscription"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Tests the permissions of a user on an environment,\nand returns a subset of permissions that the user has on the environment.\nIf the environment does not exist, an empty permission set is returned\n(a NOT_FOUND error is not returned).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions",
"httpMethod": "POST",
"id": "apigee.organizations.environments.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "GoogleIamV1TestIamPermissionsRequest"
},
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"unsubscribe": {
"description": "Deletes a subscription for the environment's Pub/Sub topic.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe",
"httpMethod": "POST",
"id": "apigee.organizations.environments.unsubscribe",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:unsubscribe",
"request": {
"$ref": "GoogleCloudApigeeV1Subscription"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates an existing environment.\n\nWhen updating properties, you must pass all existing properties to the API,\neven if they are not being changed. If you omit properties from the\npayload, the properties are removed. To get the current list of\nproperties for the environment, use the [Get Environment API](get).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}",
"httpMethod": "PUT",
"id": "apigee.organizations.environments.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Environment"
},
"response": {
"$ref": "GoogleCloudApigeeV1Environment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateDebugmask": {
"description": "Updates the debug mask singleton resource for an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask",
"httpMethod": "PATCH",
"id": "apigee.organizations.environments.updateDebugmask",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the debug mask.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/debugmask$",
"required": true,
"type": "string"
},
"replaceRepeatedFields": {
"description": "Boolean flag that specifies whether to replace existing values in the debug\nmask when doing an update. Set to true to replace existing values.\nThe default behavior is to append the values (false).",
"location": "query",
"type": "boolean"
},
"updateMask": {
"description": "Field debug mask to support partial updates.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1DebugMask"
},
"response": {
"$ref": "GoogleCloudApigeeV1DebugMask"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateEnvironment": {
"description": "Updates an existing environment.\n\nWhen updating properties, you must pass all existing properties to the API,\neven if they are not being changed. If you omit properties from the\npayload, the properties are removed. To get the current list of\nproperties for the environment, use the [Get Environment API](get).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}",
"httpMethod": "POST",
"id": "apigee.organizations.environments.updateEnvironment",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Environment"
},
"response": {
"$ref": "GoogleCloudApigeeV1Environment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"analytics": {
"resources": {
"admin": {
"methods": {
"getSchemav2": {
"description": "Get a list of metrics and dimensions which can be used for creating\nanalytics queries and reports.\nEach schema element contains the name of the field with its associated type\nand if it is either custom field or standard field.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2",
"httpMethod": "GET",
"id": "apigee.organizations.environments.analytics.admin.getSchemav2",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The parent organization and environment names. Must be of the\nform `organizations/{org}/environments/{env}/analytics/admin/schemav2`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/analytics/admin/schemav2$",
"required": true,
"type": "string"
},
"type": {
"description": "Required. Type refers to the dataset name whose schema needs to be\nretrieved E.g. type=fact or type=agg_cus1",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Schema"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"apis": {
"resources": {
"deployments": {
"methods": {
"list": {
"description": "Lists all deployments of an API proxy in an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.environments.apis.deployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name representing an API proxy in an environment in the following\nformat:\n `organizations/{org}/environments/{env}/apis/{api}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"revisions": {
"methods": {
"deployments": {
"description": "Undeploys an API proxy revision from an environment.\n\nBecause multiple revisions of the same API proxy can be deployed in\nthe same environment if the base paths are different, you must specify the\nrevision number of the API proxy.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.apis.revisions.deployments",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the API proxy revision deployment in the following format:\n `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/deployments",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getDeployments": {
"description": "Gets the deployment of an API proxy revision and actual state reported by\nruntime pods.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.environments.apis.revisions.getDeployments",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name representing an API proxy revision in an\nenvironment in the following format:\n `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1Deployment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"debugsessions": {
"methods": {
"create": {
"description": "Creates a debug session for a deployed API Proxy revision.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions",
"httpMethod": "POST",
"id": "apigee.organizations.environments.apis.revisions.debugsessions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the API Proxy revision deployment for which\nto create the DebugSession. Must be of the form\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
},
"timeout": {
"description": "Optional. The time in seconds after which this DebugSession should end.\nA timeout specified in DebugSession will overwrite this value.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/debugsessions",
"request": {
"$ref": "GoogleCloudApigeeV1DebugSession"
},
"response": {
"$ref": "GoogleCloudApigeeV1DebugSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"deleteData": {
"description": "Deletes the data from a debug session. This does not cancel the debug\nsession or prevent further data from being collected if the session is\nstill active in runtime pods.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.apis.revisions.debugsessions.deleteData",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the debug session to delete.\nMust be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/data",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists debug sessions that are currently active in the given API Proxy\nrevision.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions",
"httpMethod": "GET",
"id": "apigee.organizations.environments.apis.revisions.debugsessions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the API Proxy revision deployment for which\nto list debug sessions. Must be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/debugsessions",
"response": {
"$ref": "GoogleCloudApigeeV1ListDebugSessionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"data": {
"methods": {
"get": {
"description": "Gets the debug data from a transaction.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.apis.revisions.debugsessions.data.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the debug session transaction. Must be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+/data/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DebugSessionTransaction"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
},
"caches": {
"methods": {
"delete": {
"description": "Deletes a cache.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.caches.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Cache resource name of the form:\n `organizations/{organization_id}/environments/{environment_id}/caches/{cache_id}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/caches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"deployments": {
"methods": {
"list": {
"description": "Lists all deployments of API proxies or shared flows in an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.environments.deployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the environment for which to return deployment information in the\nfollowing format:\n `organizations/{org}/environments/{env}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"sharedFlows": {
"description": "Optional. Flag that specifies whether to return shared flow or API proxy deployments.\nSet to `true` to return shared flow deployments; set to `false`\nto return API proxy deployments. Defaults to `false`.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"flowhooks": {
"methods": {
"attachSharedFlowToFlowHook": {
"description": "Attaches a shared flow to a flow hook.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}",
"httpMethod": "PUT",
"id": "apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the flow hook to which the shared flow should be\nattached in the following format:\n `organizations/{org}/environments/{env}/flowhooks/{flowhook}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1FlowHook"
},
"response": {
"$ref": "GoogleCloudApigeeV1FlowHook"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"detachSharedFlowFromFlowHook": {
"description": "Detaches a shared flow from a flow hook.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the flow hook to detach in the following format:\n `organizations/{org}/environments/{env}/flowhooks/{flowhook}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1FlowHook"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the name of the shared flow attached to the specified flow hook. If\nthere's no shared flow attached to the flow hook, the API does not return\nan error; it simply does not return a name in the response.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.flowhooks.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the flow hook in the following format:\n `organizations/{org}/environments/{env}/flowhooks/{flowhook}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1FlowHook"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"keystores": {
"methods": {
"create": {
"description": "Creates a keystore or truststore:\n * Keystore: Contains certificates and their associated keys.\n * Truststore: Contains trusted certificates used to validate a\n server's certificate. These certificates are typically self-signed\n certificates or certificates that are not signed by a trusted CA.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores",
"httpMethod": "POST",
"id": "apigee.organizations.environments.keystores.create",
"parameterOrder": [
"parent"
],
"parameters": {
"name": {
"description": "Optional. Overrides the value in Keystore.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the environment in which to create the keystore.\nMust be of the form\n`organizations/{organization}/environments/{environment}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/keystores",
"request": {
"$ref": "GoogleCloudApigeeV1Keystore"
},
"response": {
"$ref": "GoogleCloudApigeeV1Keystore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a keystore or truststore.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.keystores.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of keystore to delete. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Keystore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a keystore or truststore.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.keystores.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of keystore. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Keystore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"aliases": {
"methods": {
"create": {
"description": "Creates an alias from a key, certificate pair.\nThe structure of the request is controlled by the `format` query parameter:\n * `keycertfile` - Separate PEM-encoded key and certificate files are\n uploaded. The request must have `Content-Type: multipart/form-data` and\n include fields `keyFile` and `certFile`. If uploading to a truststore,\n omit `keyFile`.\n* `pkcs12` - A PKCS12 file is uploaded. The request must have\n`Content-Type: multipart/form-data` with the file provided in the only\nfield.\n* `selfsignedcert` - A new private key and certificate are generated. The\nrequest must have `Content-Type: application/json` and a body of\nCertificateGenerationSpec.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases",
"httpMethod": "POST",
"id": "apigee.organizations.environments.keystores.aliases.create",
"parameterOrder": [
"parent"
],
"parameters": {
"_password": {
"description": "The password for the private key file, if it exists.",
"location": "query",
"type": "string"
},
"alias": {
"description": "The alias for the key, certificate pair. Values must match\nregular expression `[\\w\\s-.]{1,255}`. This must be provided for all formats\nexcept 'selfsignedcert'; self-signed certs may specify the alias in either\nthis parameter or the JSON body.",
"location": "query",
"type": "string"
},
"format": {
"description": "Required. The format of the data. Must be either `selfsignedcert`,\n`keycertfile`, or `pkcs12`.",
"location": "query",
"type": "string"
},
"ignoreExpiryValidation": {
"description": "If `true`, no expiry validation will be performed.",
"location": "query",
"type": "boolean"
},
"ignoreNewlineValidation": {
"description": "If `true`, do not throw an error when the file contains a chain with no\nnewline between each certificate. By default, a newline is needed between\neach certificate in a chain.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. The name of the keystore. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/aliases",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleCloudApigeeV1Alias"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"csr": {
"description": "Generates a PKCS #10 Certificate Signing Request for the private key in\nan alias.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr",
"httpMethod": "GET",
"id": "apigee.organizations.environments.keystores.aliases.csr",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/csr",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an alias.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.keystores.aliases.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Alias"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an alias.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.keystores.aliases.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Alias"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getCertificate": {
"description": "Gets the certificate from an alias in PEM-encoded form.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate",
"httpMethod": "GET",
"id": "apigee.organizations.environments.keystores.aliases.getCertificate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/certificate",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates the certificate in an alias.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}",
"httpMethod": "PUT",
"id": "apigee.organizations.environments.keystores.aliases.update",
"parameterOrder": [
"name"
],
"parameters": {
"ignoreExpiryValidation": {
"description": "Required. If `true`, no expiry validation will be performed.",
"location": "query",
"type": "boolean"
},
"ignoreNewlineValidation": {
"description": "If `true`, do not throw an error when the file contains a chain with no\nnewline between each certificate. By default, a newline is needed between\neach certificate in a chain.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleCloudApigeeV1Alias"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"keyvaluemaps": {
"methods": {
"create": {
"description": "Creates a key value map in an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps",
"httpMethod": "POST",
"id": "apigee.organizations.environments.keyvaluemaps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the environment in which to create the key value map.\nMust be of the form\n`organizations/{organization}/environments/{environment}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/keyvaluemaps",
"request": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"response": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete a key value map in an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.keyvaluemaps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the key value map.\nMust be of the form\n`organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"optimizedStats": {
"methods": {
"get": {
"description": "This api is similar to GetStats\nexcept that the response is less verbose.\nIn the current scheme, a query parameter _optimized instructs\nEdge Analytics to change the response but since this behavior\nis not possible with protocol buffer and since this parameter is\npredominantly used by Edge UI, we are introducing a separate api.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.optimizedStats.get",
"parameterOrder": [
"name"
],
"parameters": {
"accuracy": {
"description": "Legacy field. not used anymore",
"location": "query",
"type": "string"
},
"aggTable": {
"description": "If customers want to query custom aggregate tables, then this parameter\ncan be used to specify the table name. If this parameter is skipped, then\nEdge Query will try to retrieve the data from fact tables which will be\nexpensive.",
"location": "query",
"type": "string"
},
"filter": {
"description": "Enables drill-down on specific dimension values",
"location": "query",
"type": "string"
},
"limit": {
"description": "This parameter is used to limit the number of result items.\nDefault and the max value is 14400",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The organization and environment name for which the interactive\nquery will be executed. Must be of the form\n `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}`\nDimensions let you view metrics in meaningful groupings. E.g. apiproxy,\ntarget_host. The value of dimensions should be comma separated list as\nshown below\n`organizations/{org}/environments/{env}/stats/apiproxy,request_verb`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/optimizedStats/.*$",
"required": true,
"type": "string"
},
"offset": {
"description": "Use offset with limit to enable pagination of results. For example,\nto display results 11-20, set limit to '10' and offset to '10'.",
"location": "query",
"type": "string"
},
"realtime": {
"description": "Legacy field: not used anymore",
"location": "query",
"type": "boolean"
},
"select": {
"description": "Required. The select parameter contains a comma separated list of metrics\nE.g. sum(message_count),sum(error_count)",
"location": "query",
"type": "string"
},
"sonar": {
"description": "This parameter routes the query to api monitoring service for last hour",
"location": "query",
"type": "boolean"
},
"sort": {
"description": "This parameter specifies if the sort order should be ascending or\ndescending Supported values are DESC and ASC.",
"location": "query",
"type": "string"
},
"sortby": {
"description": "Comma separated list of columns to sort the final result.",
"location": "query",
"type": "string"
},
"timeRange": {
"description": "Required. Time interval for the interactive query.\nTime range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59",
"location": "query",
"type": "string"
},
"timeUnit": {
"description": "A value of second, minute, hour, day, week, month.\nTime Unit specifies the granularity of metrics returned.",
"location": "query",
"type": "string"
},
"topk": {
"description": "Take 'top k' results from results, for example, to return the top 5\nresults 'topk=5'.",
"location": "query",
"type": "string"
},
"tsAscending": {
"description": "Lists timestamps in ascending order if set to true. Recommend setting\nthis value to true if you are using sortby with sort=DESC.",
"location": "query",
"type": "boolean"
},
"tzo": {
"description": "This parameters contains the timezone offset value",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1OptimizedStats"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"queries": {
"methods": {
"create": {
"description": "Submit a query to be processed in the background.\nIf the submission of the query succeeds, the API returns a 201 status and\nan ID that refer to the query. In addition to the HTTP status 201, the\n`state` of \"enqueued\" means that the request succeeded.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries",
"httpMethod": "POST",
"id": "apigee.organizations.environments.queries.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent organization and environment names.\nMust be of the form `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/queries",
"request": {
"$ref": "GoogleCloudApigeeV1Query"
},
"response": {
"$ref": "GoogleCloudApigeeV1AsyncQuery"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Get query status\nIf the query is still in progress, the `state` is set to \"running\"\nAfter the query has completed successfully, `state` is set to \"completed\"",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.queries.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the asynchronous query to get. Must be of the form\n`organizations/{org}/environments/{env}/queries/{queryId}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/queries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1AsyncQuery"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getResult": {
"description": "After the query is completed, use this API to retrieve the results.\nIf the request succeeds, and there is a non-zero result set, the result is\ndownloaded to the client as a zipped JSON file.\nThe name of the downloaded file will be:\n OfflineQueryResult-\u003cquery-id\u003e.zip\n\nExample: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip`",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result",
"httpMethod": "GET",
"id": "apigee.organizations.environments.queries.getResult",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the asynchronous query result to get. Must be of the\nform `organizations/{org}/environments/{env}/queries/{queryId}/result`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/queries/[^/]+/result$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getResultView": {
"description": "",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resultView",
"httpMethod": "GET",
"id": "apigee.organizations.environments.queries.getResultView",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the asynchronous query result view to get. Must be of the\nform `organizations/{org}/environments/{env}/queries/{queryId}/resultView`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/queries/[^/]+/resultView$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1AsyncQueryResultView"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Return a list of Asynchronous Queries",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries",
"httpMethod": "GET",
"id": "apigee.organizations.environments.queries.list",
"parameterOrder": [
"parent"
],
"parameters": {
"dataset": {
"description": "Filter response list by dataset.\n\nExample: `api`, `mint`",
"location": "query",
"type": "string"
},
"from": {
"description": "Filter response list by returning asynchronous queries that\ncreated after this date time.\nTime must be in ISO date-time format like '2011-12-03T10:15:30Z'.",
"location": "query",
"type": "string"
},
"inclQueriesWithoutReport": {
"description": "Flag to include asynchronous queries that don't have a report\ndenifition.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent organization and environment names.\nMust be of the form `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"status": {
"description": "Filter response list by asynchronous query status",
"location": "query",
"type": "string"
},
"submittedBy": {
"description": "Filter response list by user who submitted queries",
"location": "query",
"type": "string"
},
"to": {
"description": "Filter response list by returning asynchronous queries that\ncreated before this date time.\nTime must be in ISO date-time format like '2011-12-03T10:16:30Z'.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/queries",
"response": {
"$ref": "GoogleCloudApigeeV1ListAsyncQueriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"references": {
"methods": {
"create": {
"description": "Creates a Reference in the specified environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references",
"httpMethod": "POST",
"id": "apigee.organizations.environments.references.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent environment name under which the Reference will\nbe created. Must be of the form `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/references",
"request": {
"$ref": "GoogleCloudApigeeV1Reference"
},
"response": {
"$ref": "GoogleCloudApigeeV1Reference"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Reference from an environment. Returns the deleted\nReference resource.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.references.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Reference to delete. Must be\nof the form `organizations/{org}/environments/{env}/references/{ref}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Reference"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Reference resource.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.references.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Reference to get. Must be of the form\n`organizations/{org}/environments/{env}/references/{ref}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Reference"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates an existing Reference. Note that this operation has PUT\nsemantics; it will replace the entirety of the existing Reference with\nthe resource in the request body.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}",
"httpMethod": "PUT",
"id": "apigee.organizations.environments.references.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Reference to update. Must be of the form\n`organizations/{org}/environments/{env}/references/{ref}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1Reference"
},
"response": {
"$ref": "GoogleCloudApigeeV1Reference"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"resourcefiles": {
"methods": {
"create": {
"description": "Creates a resource file.\n\nSpecify the `Content-Type` as `application/octet-stream` or\n`multipart/form-data`.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles",
"httpMethod": "POST",
"id": "apigee.organizations.environments.resourcefiles.create",
"parameterOrder": [
"parent"
],
"parameters": {
"name": {
"description": "Required. Name of the resource file. Must match the regular expression:\n\u003cvar\u003e[a-zA-Z0-9:/\\\\!@#$%^\u0026{}\\[\\]()+\\-=,.~'` ]{1,255}\u003c/var\u003e",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Name of the environment in which to create the resource file in the\nfollowing format:\n `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "Required. Resource file type. {{ resource_file_type }}",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/resourcefiles",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleCloudApigeeV1ResourceFile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a resource file.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.resourcefiles.delete",
"parameterOrder": [
"parent",
"type",
"name"
],
"parameters": {
"name": {
"description": "Required. ID of the resource file to delete. Must match the regular\nexpression: \u003cvar\u003e[a-zA-Z0-9:/\\\\!@#$%^\u0026{}\\[\\]()+\\-=,.~'` ]{1,255}\u003c/var\u003e",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "Required. Name of the environment in the following format:\n `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "Required. Resource file type. {{ resource_file_type }}",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/resourcefiles/{type}/{name}",
"response": {
"$ref": "GoogleCloudApigeeV1ResourceFile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the contents of a resource file.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.resourcefiles.get",
"parameterOrder": [
"parent",
"type",
"name"
],
"parameters": {
"name": {
"description": "Required. ID of the resource file. Must match the regular\nexpression: \u003cvar\u003e[a-zA-Z0-9:/\\\\!@#$%^\u0026{}\\[\\]()+\\-=,.~'` ]{1,255}\u003c/var\u003e",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "Required. Name of the environment in the following format:\n `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "Required. Resource file type. {{ resource_file_type }}",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/resourcefiles/{type}/{name}",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all resource files.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles",
"httpMethod": "GET",
"id": "apigee.organizations.environments.resourcefiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the environment in which to list resource files in the following\nformat:\n `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "Optional. Type of resource files to list.\n{{ resource_file_type }}",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/resourcefiles",
"response": {
"$ref": "GoogleCloudApigeeV1ListEnvironmentResourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"listEnvironmentResources": {
"description": "Lists all resource files.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.resourcefiles.listEnvironmentResources",
"parameterOrder": [
"parent",
"type"
],
"parameters": {
"parent": {
"description": "Required. Name of the environment in which to list resource files in the following\nformat:\n `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "Optional. Type of resource files to list.\n{{ resource_file_type }}",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/resourcefiles/{type}",
"response": {
"$ref": "GoogleCloudApigeeV1ListEnvironmentResourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates a resource file.\n\nSpecify the `Content-Type` as `application/octet-stream` or\n`multipart/form-data`.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}",
"httpMethod": "PUT",
"id": "apigee.organizations.environments.resourcefiles.update",
"parameterOrder": [
"parent",
"type",
"name"
],
"parameters": {
"name": {
"description": "Required. ID of the resource file to update. Must match the regular\nexpression: \u003cvar\u003e[a-zA-Z0-9:/\\\\!@#$%^\u0026{}\\[\\]()+\\-=,.~'` ]{1,255}\u003c/var\u003e",
"location": "path",
"required": true,
"type": "string"
},
"parent": {
"description": "Required. Name of the environment in the following format:\n `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "Required. Resource file type. {{ resource_file_type }}",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/resourcefiles/{type}/{name}",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleCloudApigeeV1ResourceFile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sharedflows": {
"resources": {
"deployments": {
"methods": {
"list": {
"description": "Lists all deployments of a shared flow in an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.environments.sharedflows.deployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name representing a shared flow in an environment in the following\nformat:\n `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"revisions": {
"methods": {
"deployments": {
"description": "Undeploys a shared flow revision from an environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.sharedflows.revisions.deployments",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the shared flow revision to undeploy in the following format:\n `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/deployments",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getDeployments": {
"description": "Gets the deployment of a shared flow revision and actual state reported by\nruntime pods.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.environments.sharedflows.revisions.getDeployments",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name representing a shared flow in an environment in the following\nformat:\n `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1Deployment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"stats": {
"methods": {
"get": {
"description": "Retrieve metrics grouped by dimensions.\nThe types of metrics you can retrieve include traffic, message counts,\nAPI call latency, response size, and cache hits and counts.\nDimensions let you view metrics in meaningful groups.\nThe stats api does accept dimensions as path params. The dimensions are\noptional in which case the metrics are computed on the entire data\nfor the given timerange.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.stats.get",
"parameterOrder": [
"name"
],
"parameters": {
"accuracy": {
"description": "Legacy field. not used anymore\nThis field is present to support UI calls which still use this parameter",
"location": "query",
"type": "string"
},
"aggTable": {
"description": "If customers want to query custom aggregate tables, then this parameter\ncan be used to specify the table name. If this parameter is skipped, then\nEdge Query will try to retrieve the data from fact tables which will be\nexpensive.",
"location": "query",
"type": "string"
},
"filter": {
"description": "Enables drill-down on specific dimension values",
"location": "query",
"type": "string"
},
"limit": {
"description": "This parameter is used to limit the number of result items.\nDefault and the max value is 14400",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The organization and environment name for which the interactive\nquery will be executed. Must be of the form\n `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}`\nDimensions let you view metrics in meaningful groupings. E.g. apiproxy,\ntarget_host. The value of dimensions should be comma separated list as\nshown below\n`organizations/{org}/environments/{env}/stats/apiproxy,request_verb`",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/stats/.*$",
"required": true,
"type": "string"
},
"offset": {
"description": "Use offset with limit to enable pagination of results. For example,\nto display results 11-20, set limit to '10' and offset to '10'.",
"location": "query",
"type": "string"
},
"realtime": {
"description": "Legacy field: not used anymore",
"location": "query",
"type": "boolean"
},
"select": {
"description": "The select parameter contains a comma separated list of metrics\nE.g. sum(message_count),sum(error_count)",
"location": "query",
"type": "string"
},
"sonar": {
"description": "This parameter routes the query to api monitoring service for last hour",
"location": "query",
"type": "boolean"
},
"sort": {
"description": "This parameter specifies if the sort order should be ascending or\ndescending Supported values are DESC and ASC.",
"location": "query",
"type": "string"
},
"sortby": {
"description": "Comma separated list of columns to sort the final result.",
"location": "query",
"type": "string"
},
"timeRange": {
"description": "Time interval for the interactive query.\nTime range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59",
"location": "query",
"type": "string"
},
"timeUnit": {
"description": "A value of second, minute, hour, day, week, month.\nTime Unit specifies the granularity of metrics returned.",
"location": "query",
"type": "string"
},
"topk": {
"description": "Take 'top k' results from results, for example, to return the top 5\nresults 'topk=5'.",
"location": "query",
"type": "string"
},
"tsAscending": {
"description": "Lists timestamps in ascending order if set to true. Recommend setting\nthis value to true if you are using sortby with sort=DESC.",
"location": "query",
"type": "boolean"
},
"tzo": {
"description": "This parameters contains the timezone offset value",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1Stats"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"targetservers": {
"methods": {
"create": {
"description": "Creates a TargetServer in the specified environment.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers",
"httpMethod": "POST",
"id": "apigee.organizations.environments.targetservers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"name": {
"description": "Optional. The ID to give the TargetServer. This will overwrite the\nvalue in TargetServer.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent environment name under which the TargetServer will\nbe created. Must be of the form `organizations/{org}/environments/{env}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/targetservers",
"request": {
"$ref": "GoogleCloudApigeeV1TargetServer"
},
"response": {
"$ref": "GoogleCloudApigeeV1TargetServer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a TargetServer from an environment. Returns the deleted\nTargetServer resource.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.environments.targetservers.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the TargetServer to delete. Must be\nof the form\n`organizations/{org}/environments/{env}/targetservers/{target_server_id}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1TargetServer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a TargetServer resource.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.targetservers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the TargetServer to get. Must be of the form\n`organizations/{org}/environments/{env}/targetservers/{target_server_id}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1TargetServer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates an existing TargetServer. Note that this operation has PUT\nsemantics; it will replace the entirety of the existing TargetServer with\nthe resource in the request body.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}",
"httpMethod": "PUT",
"id": "apigee.organizations.environments.targetservers.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the TargetServer to replace. Must be of the form\n`organizations/{org}/environments/{env}/targetservers/{target_server_id}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1TargetServer"
},
"response": {
"$ref": "GoogleCloudApigeeV1TargetServer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"keyvaluemaps": {
"methods": {
"create": {
"description": "Creates a key value map in an organization.",
"flatPath": "v1/organizations/{organizationsId}/keyvaluemaps",
"httpMethod": "POST",
"id": "apigee.organizations.keyvaluemaps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the organization in which to create the key value map\nfile. Must be of the form `organizations/{organization}`.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/keyvaluemaps",
"request": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"response": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete a key value map in an organization.",
"flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.keyvaluemaps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the key value map.\nMust be of the form\n`organizations/{organization}/keyvaluemaps/{keyvaluemap}`.",
"location": "path",
"pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1KeyValueMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"flatPath": "v1/organizations/{organizationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "apigee.organizations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^organizations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"flatPath": "v1/organizations/{organizationsId}/operations",
"httpMethod": "GET",
"id": "apigee.organizations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"reports": {
"methods": {
"create": {
"description": "Creates a Custom Report for an Organization. A Custom Report\nprovides Apigee Customers to create custom dashboards in addition\nto the standard dashboards which are provided. The Custom Report in its\nsimplest form contains specifications about metrics, dimensions and\nfilters. It is important to note that the custom report by itself does not\nprovide an executable entity. The Edge UI converts the custom report\ndefinition into an analytics query and displays the result in a chart.",
"flatPath": "v1/organizations/{organizationsId}/reports",
"httpMethod": "POST",
"id": "apigee.organizations.reports.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent organization name under which the Custom Report will\nbe created. Must be of the form:\n `organizations/{organization_id}/reports`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/reports",
"request": {
"$ref": "GoogleCloudApigeeV1CustomReport"
},
"response": {
"$ref": "GoogleCloudApigeeV1CustomReport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing custom report definition",
"flatPath": "v1/organizations/{organizationsId}/reports/{reportsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.reports.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Custom Report name of the form:\n `organizations/{organization_id}/reports/{report_name}`",
"location": "path",
"pattern": "^organizations/[^/]+/reports/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DeleteCustomReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieve a custom report definition.",
"flatPath": "v1/organizations/{organizationsId}/reports/{reportsId}",
"httpMethod": "GET",
"id": "apigee.organizations.reports.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Custom Report name of the form:\n `organizations/{organization_id}/reports/{report_name}`",
"location": "path",
"pattern": "^organizations/[^/]+/reports/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1CustomReport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Return a list of Custom Reports",
"flatPath": "v1/organizations/{organizationsId}/reports",
"httpMethod": "GET",
"id": "apigee.organizations.reports.list",
"parameterOrder": [
"parent"
],
"parameters": {
"expand": {
"description": "Set to 'true' to get expanded details about each custom report.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. The parent organization name under which the API product will\nbe listed\n `organizations/{organization_id}/reports`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/reports",
"response": {
"$ref": "GoogleCloudApigeeV1ListCustomReportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Update an existing custom report definition",
"flatPath": "v1/organizations/{organizationsId}/reports/{reportsId}",
"httpMethod": "PUT",
"id": "apigee.organizations.reports.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Custom Report name of the form:\n `organizations/{organization_id}/reports/{report_name}`",
"location": "path",
"pattern": "^organizations/[^/]+/reports/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudApigeeV1CustomReport"
},
"response": {
"$ref": "GoogleCloudApigeeV1CustomReport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sharedflows": {
"methods": {
"create": {
"description": "Uploads a ZIP-formatted shared flow configuration bundle to an\norganization. If the shared flow already exists, this creates a new\nrevision of it. If the shared flow does not exist, this creates it.\n\nOnce imported, the shared flow revision must be deployed before it can be\naccessed at runtime.\n\nThe size limit of a shared flow bundle is 15 MB.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows",
"httpMethod": "POST",
"id": "apigee.organizations.sharedflows.create",
"parameterOrder": [
"parent"
],
"parameters": {
"action": {
"description": "Required. Must be set to either `import` or `validate`.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name to give the shared flow",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent organization under which to create the\nshared flow. Must be of the form:\n `organizations/{organization_id}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/sharedflows",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleCloudApigeeV1SharedFlowRevision"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a shared flow and all it's revisions. The shared flow must be\nundeployed before you can delete it.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.sharedflows.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. shared flow name of the form:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}`",
"location": "path",
"pattern": "^organizations/[^/]+/sharedflows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1SharedFlow"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a shared flow by name, including a list of its revisions.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}",
"httpMethod": "GET",
"id": "apigee.organizations.sharedflows.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the shared flow to get. Must be of the\nform:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}`",
"location": "path",
"pattern": "^organizations/[^/]+/sharedflows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1SharedFlow"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all shared flows in the organization.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows",
"httpMethod": "GET",
"id": "apigee.organizations.sharedflows.list",
"parameterOrder": [
"parent"
],
"parameters": {
"includeMetaData": {
"description": "Indicates whether to include shared flow metadata in the response.",
"location": "query",
"type": "boolean"
},
"includeRevisions": {
"description": "Indicates whether to include a list of revisions in the response.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. The name of the parent organization under which to get shared\nflows. Must be of the form:\n `organizations/{organization_id}`",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/sharedflows",
"response": {
"$ref": "GoogleCloudApigeeV1ListSharedFlowsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"deployments": {
"methods": {
"list": {
"description": "Lists all deployments of a shared flow.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.sharedflows.deployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the shared flow for which to return deployment information in the\nfollowing format:\n `organizations/{org}/sharedflows/{sharedflow}`",
"location": "path",
"pattern": "^organizations/[^/]+/sharedflows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"revisions": {
"methods": {
"delete": {
"description": "Deletes a shared flow and all associated policies, resources, and\nrevisions. You must undeploy the shared flow before deleting it.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}",
"httpMethod": "DELETE",
"id": "apigee.organizations.sharedflows.revisions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the shared flow revision to delete. Must be of the\nform:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`",
"location": "path",
"pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1SharedFlowRevision"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a revision of a shared flow.\n\nIf `format=bundle` is passed, it instead outputs a shared flow revision as\na ZIP-formatted bundle of code and config files.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}",
"httpMethod": "GET",
"id": "apigee.organizations.sharedflows.revisions.get",
"parameterOrder": [
"name"
],
"parameters": {
"format": {
"description": "Specify `bundle` to export the contents of the shared flow bundle.\nOtherwise, the bundle metadata is returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the shared flow revision to get. Must be of the\nform:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`",
"location": "path",
"pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateSharedFlowRevision": {
"description": "Updates a shared flow revision. This operation is only allowed on revisions\nwhich have never been deployed. After deployment a revision becomes\nimmutable, even if it becomes undeployed.\n\nThe payload is a ZIP-formatted shared flow. Content type must be either\nmultipart/form-data or application/octet-stream.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}",
"httpMethod": "POST",
"id": "apigee.organizations.sharedflows.revisions.updateSharedFlowRevision",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the shared flow revision to update.\nMust be of the form:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`",
"location": "path",
"pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
},
"validate": {
"description": "Ignored. All uploads are validated regardless of the value of this field.\nIt is kept for compatibility with existing APIs. Must be `true` or `false`\nif provided.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleCloudApigeeV1SharedFlowRevision"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"deployments": {
"methods": {
"list": {
"description": "Lists all deployments of a shared flow revision.",
"flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments",
"httpMethod": "GET",
"id": "apigee.organizations.sharedflows.revisions.deployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the API proxy revision for which to return deployment information\nin the following format:\n `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.",
"location": "path",
"pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deployments",
"response": {
"$ref": "GoogleCloudApigeeV1ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
}
},
"revision": "20200502",
"rootUrl": "https://apigee.googleapis.com/",
"schemas": {
"GoogleApiHttpBody": {
"description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns\n (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
"id": "GoogleApiHttpBody",
"properties": {
"contentType": {
"description": "The HTTP Content-Type header value specifying the content type of the body.",
"type": "string"
},
"data": {
"description": "The HTTP request/response body as raw binary.",
"format": "byte",
"type": "string"
},
"extensions": {
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Access": {
"id": "GoogleCloudApigeeV1Access",
"properties": {
"Get": {
"$ref": "GoogleCloudApigeeV1AccessGet"
},
"Remove": {
"$ref": "GoogleCloudApigeeV1AccessRemove"
},
"Set": {
"$ref": "GoogleCloudApigeeV1AccessSet"
}
},
"type": "object"
},
"GoogleCloudApigeeV1AccessGet": {
"description": "Get action. For example,\n\"Get\" : {\n \"name\" : \"target.name\",\n \"value\" : \"default\"\n}",
"id": "GoogleCloudApigeeV1AccessGet",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1AccessRemove": {
"description": "Remove action. For example,\n\"Remove\" : {\n \"name\" : \"target.name\",\n \"success\" : true\n}",
"id": "GoogleCloudApigeeV1AccessRemove",
"properties": {
"name": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudApigeeV1AccessSet": {
"description": "Set action. For example,\n\"Set\" : {\n \"name\" : \"target.name\",\n \"success\" : true,\n \"value\" : \"default\"\n}",
"id": "GoogleCloudApigeeV1AccessSet",
"properties": {
"name": {
"type": "string"
},
"success": {
"type": "boolean"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Alias": {
"description": "A reference to a certificate or key, certificate pair.",
"id": "GoogleCloudApigeeV1Alias",
"properties": {
"alias": {
"description": "The resource ID for this alias. Values must match regular expression\n`[^/]{1,255}`.",
"type": "string"
},
"certsInfo": {
"$ref": "GoogleCloudApigeeV1Certificate",
"description": "The chain of certificates under this alias."
},
"type": {
"description": "The type of alias.",
"enum": [
"ALIAS_TYPE_UNSPECIFIED",
"CERT",
"KEY_CERT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1AliasRevisionConfig": {
"id": "GoogleCloudApigeeV1AliasRevisionConfig",
"properties": {
"location": {
"description": "The location of the alias file, e.g. a GCS URI.",
"type": "string"
},
"name": {
"description": "The name of the alias revision included in the keystore. Must be of the\nform:\n'organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}'.",
"type": "string"
},
"type": {
"enum": [
"ALIAS_TYPE_UNSPECIFIED",
"CERT",
"KEY_CERT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ApiProduct": {
"id": "GoogleCloudApigeeV1ApiProduct",
"properties": {
"apiResources": {
"description": "Comma-separated list of API resources to be bundled in the API Product.\n\nBy default, the resource paths are mapped from the `proxy.pathsuffix`\nvariable.\n\nThe proxy path suffix is defined as the URI fragment following the\nProxyEndpoint base path.\nFor example, if the `apiResources` element is defined to be\n`/forecastrss` and the base path defined for the API proxy is\n`/weather`, then only requests to `/weather/forecastrss` are permitted by\nthe API product.\n\nYou can select a specific path, or you can select all subpaths with the\nfollowing wildcard:\n\n- /**: Indicates that all sub-URIs are included.\n- /* : Indicates that only URIs one level down are included.\n\nBy default, / supports the same resources as /** as well as the base path\ndefined by the API proxy.\n\nFor example, if the base path of the API proxy is `/v1/weatherapikey`,\nthen the API product supports requests to `/v1/weatherapikey` and to any\nsub-URIs, such as `/v1/weatherapikey/forecastrss`,\n`/v1/weatherapikey/region/CA`, and so on.\nFor more information, see:\n\n- \u003ca href=\"/api-platform/publish/create-api-products\"\u003eManage API\nproducts\u003c/a\u003e\n- \u003ca\nhref=\"/api-platform/monetization/create-transaction-recording-policy#spectrpcaapi\"\u003eManaging\na transaction recording policy using the API\u003c/a\u003e",
"items": {
"type": "string"
},
"type": "array"
},
"approvalType": {
"description": "Specifies how API keys are approved to access the APIs defined by the API\nproduct.\n\nIf set to `manual`, the consumer key is generated and returned in \"pending\"\nstate. In this case, the API keys won't work until they have been\nexplicitly approved.\n\nIf set to `auto`, the consumer key is generated and returned in \"approved\"\nstate and can be used immediately.\n\n\u003caside class=\"note\"\u003e\u003cstrong\u003eNOTE:\u003c/strong\u003e Typically, `auto` is used\nto provide access to free or trial API products that provide limited quota\nor capabilities.\u003c/aside\u003e",
"type": "string"
},
"attributes": {
"description": "Array of attributes that may be used to extend the default API product\nprofile with customer-specific metadata. You can specify a maximum of 18\nattributes.\n\nUse this property to specify the access level of the API product as either\n`public`, `private`, or `internal`.\n\nOnly products marked `public` are available to developers in the Apigee\ndeveloper portal. For example, you can set a product to `internal` while it\nis in development and then change access to `public` when it is ready to\nrelease on the portal.\n\nAPI products marked as `private` do not appear on the portal but\ncan be accessed by external developers.\n\nFor monetization, you can use the attributes field to:\n\n- \u003ca\nhref=\"/api-platform/monetization/create-transaction-recording-policy#spectrpsuccessapi\"\ntarget=\"_blank\"\u003eSpecify transaction success criteria\u003c/a\u003e\n- \u003ca\nhref=\"/api-platform/monetization/create-transaction-recording-policy#spectrpcaapi\"\ntarget=\"_blank\"\u003eSpecify custom attributes\u003c/a\u003e on which you base rate plan\ncharges\u003c/a\u003e.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"createdAt": {
"description": "Response only. Creation time of this environment as milliseconds since\nepoch.",
"format": "int64",
"type": "string"
},
"description": {
"description": "An overview of the API product. Include key information about the API\nproduct that is not captured by other fields.",
"type": "string"
},
"displayName": {
"description": "The name to be displayed in the UI or developer portal to developers\nregistering for API access.",
"type": "string"
},
"environments": {
"description": "A comma-separated list of environment names to which the API product is\nbound. Requests to environments that are not listed are rejected.\n\nBy specifying one or more environments, you can bind the resources listed\nin the API product to a specific environment, preventing developers from\naccessing those resources through API proxies deployed in another\nenvironment.\n\nThis setting is used, for example, to prevent resources associated with\nAPI proxies in 'prod' from being accessed by API proxies deployed in\n'test'.",
"items": {
"type": "string"
},
"type": "array"
},
"lastModifiedAt": {
"description": "Response only. Modified time of this environment as milliseconds since\nepoch.",
"format": "int64",
"type": "string"
},
"name": {
"description": "The internal name of the API Product. Characters you can use in the name\nare restricted to: A-Z0-9._\\-$ %.\n\n\u003caside class=\"note\"\u003e\u003cstrong\u003eNOTE:\u003c/strong\u003e The internal name cannot be\nedited when updating the API product.\u003c/aside\u003e",
"type": "string"
},
"proxies": {
"description": "A comma-separated list of API proxy names to which this API product is\nbound. By specifying API proxies, you can associate resources in the API\nproduct with specific API proxies, preventing developers from accessing\nthose resources through other API proxies.\n\nEdge rejects requests to API proxies that are not listed.\n\n\u003caside class=\"note\"\u003e\u003cstrong\u003eNOTE:\u003c/strong\u003e The API proxy names must already\nexist in the specified environment as they will be validated upon\ncreation.\u003c/aside\u003e",
"items": {
"type": "string"
},
"type": "array"
},
"quota": {
"description": "The number of request messages permitted per app by this API product for\nthe specified `quotaInterval` and `quotaTimeUnit`.\n\nFor example, a `quota` of 50, for a `quotaInterval` of 12 and a\n`quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.",
"type": "string"
},
"quotaInterval": {
"description": "The time interval over which the number of request messages is calculated.",
"type": "string"
},
"quotaTimeUnit": {
"description": "The time unit defined for the `quotaInterval`. Valid values include minute,\nhour, day, or month.",
"type": "string"
},
"scopes": {
"description": "A comma-separated list of OAuth scopes that are validated at runtime.\nEdge validates that the scopes in any access token presented match the\nscopes defined in the OAuth policy assoicated with the API product.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ApiProductRef": {
"id": "GoogleCloudApigeeV1ApiProductRef",
"properties": {
"apiproduct": {
"description": "Name of the API product.",
"type": "string"
},
"status": {
"description": "Status of the API product.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ApiProxy": {
"description": "Metadata describing the API proxy",
"id": "GoogleCloudApigeeV1ApiProxy",
"properties": {
"latestRevisionId": {
"description": "The id of the most recently created revision for this api proxy.",
"type": "string"
},
"metaData": {
"$ref": "GoogleCloudApigeeV1EntityMetadata",
"description": "Metadata describing the API proxy."
},
"name": {
"description": "Name of the API proxy.",
"type": "string"
},
"revision": {
"description": "List of revisons defined for the API proxy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ApiProxyRevision": {
"description": "API proxy revision.",
"id": "GoogleCloudApigeeV1ApiProxyRevision",
"properties": {
"basepaths": {
"description": "Base URL of the API proxy.",
"items": {
"type": "string"
},
"type": "array"
},
"configurationVersion": {
"$ref": "GoogleCloudApigeeV1ConfigVersion",
"description": "Version of the API proxy configuration schema to which the API proxy\nconforms. Currently, the only supported value is 4.0\n(`majorVersion.minorVersion`). This setting may be used in the future to\ntrack the evolution of the API proxy format."
},
"contextInfo": {
"description": "Revision number, app name, and organization for the API proxy.",
"type": "string"
},
"createdAt": {
"description": "Time that the API proxy revision was created in milliseconds since\nepoch.",
"format": "int64",
"type": "string"
},
"description": {
"description": "Description of the API proxy revision.",
"type": "string"
},
"displayName": {
"description": "Human-readable name of the API proxy.",
"type": "string"
},
"entityMetaDataAsProperties": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata describing the API proxy revision as a key-value map.",
"type": "object"
},
"lastModifiedAt": {
"description": "Time that the API proxy revision was last modified in\nmilliseconds since epoch.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Name of the API proxy.",
"type": "string"
},
"policies": {
"description": "List of policy names included in the API proxy revision..",
"items": {
"type": "string"
},
"type": "array"
},
"proxies": {
"description": "List of proxy names included in the API proxy revision.",
"items": {
"type": "string"
},
"type": "array"
},
"proxyEndpoints": {
"description": "List of ProxyEndpoints in the `/proxies` directory of the API proxy.\nTypically, this element is included only when the API proxy was created\nusing the Edge UI. This is a 'manifest' setting designed to\nprovide visibility into the contents of the API proxy.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceFiles": {
"$ref": "GoogleCloudApigeeV1ResourceFiles",
"description": "List of resource files included in the API proxy revision."
},
"resources": {
"description": "List of the resources included in the API proxy revision formatted as\n\"{type}://{name}\".",
"items": {
"type": "string"
},
"type": "array"
},
"revision": {
"description": "API proxy revision.",
"type": "string"
},
"sharedFlows": {
"description": "List of the shared flows included in the API proxy revision.",
"items": {
"type": "string"
},
"type": "array"
},
"spec": {
"description": "OpenAPI Specification that is associated with the API proxy.\nThe value is set to a URL or to a path in the specification store.",
"type": "string"
},
"targetEndpoints": {
"description": "List of TargetEndpoints in the `/targets` directory of the API proxy.\nTypically, this element is included only when the API proxy was created\nusing the Edge UI. This is a 'manifest' setting designed to\nprovide visibility into the contents of the API proxy.",
"items": {
"type": "string"
},
"type": "array"
},
"targetServers": {
"description": "List of TargetServers referenced in any TargetEndpoint in the API\nproxy. Typically, you will see this element only when the API proxy was\ncreated using the Edge UI. This is a 'manifest' setting\ndesigned to provide visibility into the contents of the API proxy.",
"items": {
"type": "string"
},
"type": "array"
},
"targets": {
"description": "List of the targets included in the API proxy revision.",
"items": {
"type": "string"
},
"type": "array"
},
"teams": {
"description": "List of the teams included in the API proxy revision.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type. Set to `Application`. Maintained for compatibility with\nthe Apigee Edge API.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1App": {
"id": "GoogleCloudApigeeV1App",
"properties": {
"apiProducts": {
"description": "List of API products associated with the app.",
"items": {
"$ref": "GoogleCloudApigeeV1ApiProductRef"
},
"type": "array"
},
"appId": {
"description": "ID of the app.",
"type": "string"
},
"attributes": {
"description": "List of attributes.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"callbackUrl": {
"description": "Callback URL used by OAuth 2.0 authorization servers to communicate\nauthorization codes back to apps.",
"type": "string"
},
"companyName": {
"description": "Name of the company that owns the app.",
"type": "string"
},
"createdAt": {
"description": "Output only. Unix time when the app was created.",
"format": "int64",
"type": "string"
},
"credentials": {
"description": "Output only. Set of credentials for the app. Credentials are API\nkey/secret pairs associated with API products.",
"items": {
"$ref": "GoogleCloudApigeeV1Credential"
},
"type": "array"
},
"developerId": {
"description": "ID of the developer.",
"type": "string"
},
"keyExpiresIn": {
"description": "Duration, in milliseconds, of the consumer key that will\nbe generated for the app. The default value, -1, indicates an\ninfinite validity period. Once set, the expiration can't be updated.\njson key: keyExpiresIn",
"format": "int64",
"type": "string"
},
"lastModifiedAt": {
"description": "Output only. Last modified time as milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Name of the app.",
"type": "string"
},
"scopes": {
"description": "Scopes to apply to the app. The specified scope names must already\nexist on the API product that you associate with the app.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Status of the credential.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1AsyncQuery": {
"id": "GoogleCloudApigeeV1AsyncQuery",
"properties": {
"created": {
"description": "Creation time of the query",
"type": "string"
},
"error": {
"description": "Error is set when query fails",
"type": "string"
},
"executionTime": {
"description": "ExecutionTime is available only after the query is completed",
"type": "string"
},
"name": {
"description": "Asynchronous Query Name.",
"type": "string"
},
"queryParams": {
"$ref": "GoogleCloudApigeeV1QueryMetadata",
"description": "Contains information like metrics, dimenstions etc\nof the AsyncQuery"
},
"reportDefinitionId": {
"description": "Asynchronous Report ID.",
"type": "string"
},
"result": {
"$ref": "GoogleCloudApigeeV1AsyncQueryResult",
"description": "Result is available only after the query is completed"
},
"resultFileSize": {
"description": "ResultFileSize is available only after the query is completed",
"type": "string"
},
"resultRows": {
"description": "ResultRows is available only after the query is completed",
"format": "int64",
"type": "string"
},
"self": {
"description": "Self link of the query\n\nExample:\n`/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`",
"type": "string"
},
"state": {
"description": "Query state could be \"enqueued\", \"running\", \"completed\",\n\"failed\"",
"type": "string"
},
"updated": {
"description": "Last updated timestamp for the query",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1AsyncQueryResult": {
"id": "GoogleCloudApigeeV1AsyncQueryResult",
"properties": {
"expires": {
"description": "Query result will be unaccessable after this time.",
"type": "string"
},
"self": {
"description": "Self link of the query results\n\nExample:\n`/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1AsyncQueryResultView": {
"id": "GoogleCloudApigeeV1AsyncQueryResultView",
"properties": {
"code": {
"description": "Error code when there is a failure.",
"format": "int32",
"type": "integer"
},
"error": {
"description": "Error message when there is a failure.",
"type": "string"
},
"metadata": {
"$ref": "GoogleCloudApigeeV1QueryMetadata",
"description": "Metadata contains information like metrics, dimenstions etc\nof the AsyncQuery"
},
"rows": {
"description": "Rows of query result. Each row is a JSON object.\n\nExample: {sum(message_count): 1, developer_app: \"(not set)\",…}",
"items": {
"type": "any"
},
"type": "array"
},
"state": {
"description": "State of retrieving ResultView.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Attribute": {
"description": "Key-value pair to store extra metadata.",
"id": "GoogleCloudApigeeV1Attribute",
"properties": {
"name": {
"description": "API key of the attribute.",
"type": "string"
},
"value": {
"description": "Value of the attribute.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Attributes": {
"id": "GoogleCloudApigeeV1Attributes",
"properties": {
"attribute": {
"description": "List of attributes.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1CertInfo": {
"description": "An X.509 certificate as defined in RFC 5280.",
"id": "GoogleCloudApigeeV1CertInfo",
"properties": {
"basicConstraints": {
"description": "The X.509 basic constraints extension.",
"type": "string"
},
"expiryDate": {
"description": "The X.509 validity / notAfter in milliseconds since the epoch.",
"format": "int64",
"type": "string"
},
"isValid": {
"description": "\"Yes\" if certificate is valid, \"No\" if expired and \"Not yet\"\nif not yet valid.",
"type": "string"
},
"issuer": {
"description": "The X.509 issuer.",
"type": "string"
},
"publicKey": {
"description": "The public key component of the X.509 subject public key info.",
"type": "string"
},
"serialNumber": {
"description": "The X.509 serial number.",
"type": "string"
},
"sigAlgName": {
"description": "The X.509 signatureAlgorithm.",
"type": "string"
},
"subject": {
"description": "The X.509 subject.",
"type": "string"
},
"subjectAlternativeNames": {
"description": "The X.509 subject alternative names (SANs) extension.",
"items": {
"type": "string"
},
"type": "array"
},
"validFrom": {
"description": "The X.509 validity / notBefore in milliseconds since the\nepoch.",
"format": "int64",
"type": "string"
},
"version": {
"description": "The X.509 version.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Certificate": {
"id": "GoogleCloudApigeeV1Certificate",
"properties": {
"certInfo": {
"description": "The chain of certificates under this name.",
"items": {
"$ref": "GoogleCloudApigeeV1CertInfo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1CommonNameConfig": {
"id": "GoogleCloudApigeeV1CommonNameConfig",
"properties": {
"matchWildCards": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Company": {
"id": "GoogleCloudApigeeV1Company",
"properties": {
"apps": {
"items": {
"type": "string"
},
"type": "array"
},
"attributes": {
"description": "A list of attributes",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"createdAt": {
"description": "Output only. Created time as milliseconds since epoch.\njson key: createdAt",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "company name displayed in the UI",
"type": "string"
},
"lastModifiedAt": {
"description": "Output only. Modified time as milliseconds since epoch.\njson key: lastModifiedAt",
"format": "int64",
"type": "string"
},
"name": {
"description": "Name of the company. Characters you can use in the name are restricted to:\nA-Z0-9._\\-$ %.",
"type": "string"
},
"organization": {
"description": "the org that the company is created",
"type": "string"
},
"status": {
"description": "The status of the company",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1CompanyApp": {
"id": "GoogleCloudApigeeV1CompanyApp",
"properties": {
"apiProducts": {
"description": "Any API Products the app consumes",
"items": {
"type": "string"
},
"type": "array"
},
"appFamily": {
"type": "string"
},
"appId": {
"description": "The id of the app.",
"type": "string"
},
"attributes": {
"description": "A list of attributes.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"callbackUrl": {
"description": "The callbackUrl is used by OAuth 2.0 authorization servers to communicate\nauthorization codes back to apps.",
"type": "string"
},
"companyName": {
"description": "The name of the company owns the app",
"type": "string"
},
"createdAt": {
"description": "Output only. created time of this environment as milliseconds since epoch.\nJSON key: createdAt",
"format": "int64",
"type": "string"
},
"credentials": {
"description": "Output only. A set of credentials for the app\ncredentials are key/secret pairs",
"items": {
"$ref": "GoogleCloudApigeeV1Credential"
},
"type": "array"
},
"keyExpiresIn": {
"description": "A setting, in milliseconds, for the lifetime of the consumer key that will\nbe generated for the developer app. The default value, -1, indicates an\ninfinite validity period. Once set, the expiration can't be updated.\njson key: keyExpiresIn",
"format": "int64",
"type": "string"
},
"lastModifiedAt": {
"description": "Output only. Modified time as milliseconds since epoch.\njson key: lastModifiedAt",
"format": "int64",
"type": "string"
},
"name": {
"description": "The resoure id of the app.\nJSON key: name",
"type": "string"
},
"scopes": {
"description": "The scopes to apply to the app. The specified scope names must already\nexist on the API product that you associate with the app.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "The status of the credential.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1CompanyAppKey": {
"id": "GoogleCloudApigeeV1CompanyAppKey",
"properties": {
"apiProducts": {
"description": "A list of api products this credential can be used for.",
"items": {
"type": "any"
},
"type": "array"
},
"attributes": {
"description": "A list of attributes tied to the credential.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"consumerKey": {
"description": "The consumer key.",
"type": "string"
},
"consumerSecret": {
"description": "The secret key.",
"type": "string"
},
"expiresAt": {
"description": "Unix time when the app was created\njson key: expiresAt",
"format": "int64",
"type": "string"
},
"issuedAt": {
"description": "Unix time when the app was issued\njson key: issuedAt",
"format": "int64",
"type": "string"
},
"scopes": {
"description": "The scopes to apply to the app. The specified scope names must already\nexist on the API product that you associate with the app.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "The status of the credential.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ConfigVersion": {
"description": "Version of the API proxy configuration schema. Currently, only 4.0 is\nsupported.",
"id": "GoogleCloudApigeeV1ConfigVersion",
"properties": {
"majorVersion": {
"description": "Major version of the API proxy configuration schema.",
"format": "int32",
"type": "integer"
},
"minorVersion": {
"description": "Minor version of the API proxy configuration schema.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Credential": {
"id": "GoogleCloudApigeeV1Credential",
"properties": {
"apiProducts": {
"description": "List of API products this credential can be used for.",
"items": {
"$ref": "GoogleCloudApigeeV1ApiProductRef"
},
"type": "array"
},
"attributes": {
"description": "List of attributes associated with this credential.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"consumerKey": {
"description": "Consumer key.",
"type": "string"
},
"consumerSecret": {
"description": "Secret key.",
"type": "string"
},
"expiresAt": {
"description": "Time the credential will expire in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"issuedAt": {
"description": "Time the credential was issued in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"scopes": {
"description": "List of scopes to apply to the app. Specified scopes must already\nexist on the API product that you associate with the app.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Status of the credential.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1CustomReport": {
"id": "GoogleCloudApigeeV1CustomReport",
"properties": {
"chartType": {
"description": "This field contains the chart type for the report",
"type": "string"
},
"comments": {
"description": "Legacy field: not used. This field contains a list of comments associated\nwith custom report",
"items": {
"type": "string"
},
"type": "array"
},
"createdAt": {
"description": "Output only. Unix time when the app was created\njson key: createdAt",
"format": "int64",
"type": "string"
},
"dimensions": {
"description": "This contains the list of dimensions for the report",
"items": {
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "This is the display name for the report",
"type": "string"
},
"environment": {
"description": "Output only. Environment name",
"type": "string"
},
"filter": {
"description": "This field contains the filter expression",
"type": "string"
},
"fromTime": {
"description": "Legacy field: not used. Contains the from time for the report",
"type": "string"
},
"lastModifiedAt": {
"description": "Output only. Modified time of this entity as milliseconds since epoch.\njson key: lastModifiedAt",
"format": "int64",
"type": "string"
},
"lastViewedAt": {
"description": "Output only. Last viewed time of this entity as milliseconds since epoch",
"format": "int64",
"type": "string"
},
"limit": {
"description": "Legacy field: not used This field contains the limit for the result\nretrieved",
"type": "string"
},
"metrics": {
"description": "Required. This contains the list of metrics",
"items": {
"$ref": "GoogleCloudApigeeV1CustomReportMetric"
},
"type": "array"
},
"name": {
"description": "Required. Unique identifier for the report\nT his is a legacy field used to encode custom report unique id",
"type": "string"
},
"offset": {
"description": "Legacy field: not used. This field contains the offset for the data",
"type": "string"
},
"organization": {
"description": "Output only. Organization name",
"type": "string"
},
"properties": {
"description": "This field contains report properties such as ui metadata etc.",
"items": {
"$ref": "GoogleCloudApigeeV1ReportProperty"
},
"type": "array"
},
"sortByCols": {
"description": "Legacy field: not used much. Contains the list of sort by columns",
"items": {
"type": "string"
},
"type": "array"
},
"sortOrder": {
"description": "Legacy field: not used much. Contains the sort order for the sort columns",
"type": "string"
},
"tags": {
"description": "Legacy field: not used. This field contains a list of tags associated with\ncustom report",
"items": {
"type": "string"
},
"type": "array"
},
"timeUnit": {
"description": "This field contains the time unit of aggregation for the report",
"type": "string"
},
"toTime": {
"description": "Legacy field: not used. Contains the end time for the report",
"type": "string"
},
"topk": {
"description": "Legacy field: not used. This field contains the top k parameter value\nfor restricting the result",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1CustomReportMetric": {
"description": "This encapsulates a metric property of the form sum(message_count)\nwhere name is message_count and function is sum",
"id": "GoogleCloudApigeeV1CustomReportMetric",
"properties": {
"function": {
"description": "aggregate function",
"type": "string"
},
"name": {
"description": "name of the metric",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DataLocation": {
"id": "GoogleCloudApigeeV1DataLocation",
"properties": {
"url": {
"description": "GCS signed url. Signed URLs provide a way to give time-limited\nread or write access to anyone in possession of the URL, regardless of\nwhether they have a Google account.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DebugMask": {
"id": "GoogleCloudApigeeV1DebugMask",
"properties": {
"faultJSONPaths": {
"description": "List of JSON paths that specify the JSON elements to be filtered from JSON\npayloads in error flows.",
"items": {
"type": "string"
},
"type": "array"
},
"faultXPaths": {
"description": "List of XPaths that specify the XML elements to be filtered from XML\npayloads in error flows.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the debug mask.",
"type": "string"
},
"namespaces": {
"additionalProperties": {
"type": "string"
},
"description": "Map of namespaces to URIs.",
"type": "object"
},
"requestJSONPaths": {
"description": "List of JSON paths that specify the JSON elements to be filtered from JSON\nrequest message payloads.",
"items": {
"type": "string"
},
"type": "array"
},
"requestXPaths": {
"description": "List of XPaths that specify the XML elements to be filtered from XML\nrequest message payloads.",
"items": {
"type": "string"
},
"type": "array"
},
"responseJSONPaths": {
"description": "List of JSON paths that specify the JSON elements to be filtered from JSON\nresponse message payloads.",
"items": {
"type": "string"
},
"type": "array"
},
"responseXPaths": {
"description": "List of XPaths that specify the XML elements to be filtered from XML\nresponse message payloads.",
"items": {
"type": "string"
},
"type": "array"
},
"variables": {
"description": "List of variables that should be masked from the debug output.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DebugSession": {
"id": "GoogleCloudApigeeV1DebugSession",
"properties": {
"count": {
"description": "Optional. The number of request to be traced. Min = 1, Max = 15, Default\n= 10.",
"format": "int32",
"type": "integer"
},
"filter": {
"description": "Optional. A conditional statement which is evaluated against the request\nmessage to determine if it should be traced. Syntax matches that of on\nAPI Proxy bundle flow Condition.",
"type": "string"
},
"name": {
"description": "A unique ID for this DebugSession.",
"type": "string"
},
"timeout": {
"description": "Optional. The time in seconds after which this DebugSession should end.\nThis value will override the value in query param, if both are provided.",
"format": "int64",
"type": "string"
},
"tracesize": {
"description": "Optional. The maximum number of bytes captured from the response payload.\nMin = 0, Max = 5120, Default = 5120.",
"format": "int32",
"type": "integer"
},
"validity": {
"description": "Optional. The length of time, in seconds, that this debug session is valid,\nstarting from when it's received in the control plane. Min = 1, Max = 15,\nDefault = 10.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DebugSessionTransaction": {
"description": "A transaction contains all of the debug information of the entire message\nflow of an API call processed by the runtime plane. The information is\ncollected and recorded at critical points of the message flow in the runtime\napiproxy.",
"id": "GoogleCloudApigeeV1DebugSessionTransaction",
"properties": {
"completed": {
"description": "Flag indicating whether a transaction is completed or not",
"type": "boolean"
},
"point": {
"description": "List of debug data collected by runtime plane at various defined points in\nthe flow.",
"items": {
"$ref": "GoogleCloudApigeeV1Point"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DeleteCustomReportResponse": {
"id": "GoogleCloudApigeeV1DeleteCustomReportResponse",
"properties": {
"message": {
"description": "The response contains only a message field.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Deployment": {
"id": "GoogleCloudApigeeV1Deployment",
"properties": {
"apiProxy": {
"description": "API proxy.",
"type": "string"
},
"basePath": {
"description": "Base path for the deployment.",
"type": "string"
},
"deployStartTime": {
"description": "Time the API proxy was marked `deployed` in the control plane in\nmillisconds since epoch.",
"format": "int64",
"type": "string"
},
"environment": {
"description": "Environment.",
"type": "string"
},
"pods": {
"description": "Status reported by runtime pods.",
"items": {
"$ref": "GoogleCloudApigeeV1PodStatus"
},
"type": "array"
},
"revision": {
"description": "API proxy revision.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DeploymentConfig": {
"id": "GoogleCloudApigeeV1DeploymentConfig",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Additional key-value metadata about the deployment.",
"type": "object"
},
"basePath": {
"description": "Base path where the application needs to be hosted. Default value is\nassumed to be \"/\".",
"type": "string"
},
"location": {
"description": "The location of the proxy bundle, as a uri.",
"type": "string"
},
"name": {
"description": "The name of the API or shared flow revision to be deployed. Must be of the\nform 'organizations/{org}/apis/{api}/revisions/{rev}' or\n'organizations/{org}/sharedflows/{sf}/revisions/{rev}'.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Developer": {
"id": "GoogleCloudApigeeV1Developer",
"properties": {
"accessType": {
"description": "Access type.",
"type": "string"
},
"appFamily": {
"description": "Developer app family.",
"type": "string"
},
"apps": {
"description": "List of apps associated with the developer.",
"items": {
"type": "string"
},
"type": "array"
},
"attributes": {
"description": "Optional. Developer attributes (name/value pairs). The custom attribute limit is 18.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"companies": {
"description": "List of companies associated with the developer.",
"items": {
"type": "string"
},
"type": "array"
},
"createdAt": {
"description": "Output only. Time at which the developer was created in milliseconds\nsince epoch.",
"format": "int64",
"type": "string"
},
"developerId": {
"description": "ID of the developer.\n\n**Note**: IDs are generated internally by Apigee and are not\nguaranteed to stay the same over time.",
"type": "string"
},
"email": {
"description": "Required. Email address of the developer. This value is used to uniquely identify\nthe developer in Apigee hybrid.",
"type": "string"
},
"firstName": {
"description": "Required. First name of the developer.",
"type": "string"
},
"lastModifiedAt": {
"description": "Output only. Time at which the developer was last modified in\nmilliseconds since epoch.",
"format": "int64",
"type": "string"
},
"lastName": {
"description": "Required. Last name of the developer.",
"type": "string"
},
"organizationName": {
"description": "Output only. Name of the Apigee organization in which the developer resides.",
"type": "string"
},
"status": {
"description": "Output only. Status of the developer. Valid values are `active` and `inactive`.",
"type": "string"
},
"userName": {
"description": "Required. User name of the developer. Not used by Apigee hybrid.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DeveloperApp": {
"id": "GoogleCloudApigeeV1DeveloperApp",
"properties": {
"apiProducts": {
"description": "List of API products associated with the developer app.",
"items": {
"type": "string"
},
"type": "array"
},
"appFamily": {
"description": "Developer app family.",
"type": "string"
},
"appId": {
"description": "ID of the developer app.",
"type": "string"
},
"attributes": {
"description": "List of attributes for the developer app.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"callbackUrl": {
"description": "Callback URL used by OAuth 2.0 authorization servers to communicate\nauthorization codes back to developer apps.",
"type": "string"
},
"createdAt": {
"description": "Output only. Time the developer app was created in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"credentials": {
"description": "Output only. Set of credentials for the developer app consisting of the\nconsumer key/secret pairs associated with the API products.",
"items": {
"$ref": "GoogleCloudApigeeV1Credential"
},
"type": "array"
},
"developerId": {
"description": "ID of the developer.",
"type": "string"
},
"keyExpiresIn": {
"description": "Expiration time, in milliseconds, for the consumer key that\nis generated for the developer app. If not set or left to the default\nvalue of `-1`, the API key never expires.\nThe expiration time can't be updated after it is set.",
"format": "int64",
"type": "string"
},
"lastModifiedAt": {
"description": "Output only. Time the developer app was modified in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Name of the developer app.",
"type": "string"
},
"scopes": {
"description": "Scopes to apply to the developer app. The specified scopes must\nalready exist for the API product that you associate with the developer\napp.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Status of the credential. Valid values include `approved` or `revoked`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DeveloperAppKey": {
"id": "GoogleCloudApigeeV1DeveloperAppKey",
"properties": {
"apiProducts": {
"description": "List of API products for which the credential can be used.",
"items": {
"type": "any"
},
"type": "array"
},
"attributes": {
"description": "List of attributes associated with the credential.",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
},
"consumerKey": {
"description": "Consumer key.",
"type": "string"
},
"consumerSecret": {
"description": "Secret key.",
"type": "string"
},
"expiresAt": {
"description": "Time the developer app expires in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"issuedAt": {
"description": "Time the developer app was created in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"scopes": {
"description": "Scopes to apply to the app. The specified scope names must already\nbe defined for the API product that you associate with the app.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Status of the credential. Valid values include `approved` or `revoked`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1DimensionMetric": {
"description": "This message type encapsulates a metric grouped by dimension",
"id": "GoogleCloudApigeeV1DimensionMetric",
"properties": {
"metrics": {
"description": "This field contains a list of metrics",
"items": {
"$ref": "GoogleCloudApigeeV1Metric"
},
"type": "array"
},
"name": {
"description": "This field contains the name of the dimension",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1EntityMetadata": {
"description": "Metadata common to many entities in this API.",
"id": "GoogleCloudApigeeV1EntityMetadata",
"properties": {
"createdAt": {
"description": "Time at which the API proxy was created, in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"lastModifiedAt": {
"description": "Time at which the API proxy was most recently modified, in milliseconds\nsince epoch.",
"format": "int64",
"type": "string"
},
"subType": {
"description": "The type of entity described",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Environment": {
"id": "GoogleCloudApigeeV1Environment",
"properties": {
"createdAt": {
"description": "Output only. Creation time of this environment as milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"description": {
"description": "Optional. Description of the environment.",
"type": "string"
},
"displayName": {
"description": "Optional. Display name for this environment.",
"type": "string"
},
"lastModifiedAt": {
"description": "Output only. Last modification time of this environment as milliseconds\nsince epoch.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Required. Name of the environment. Values must match the\nregular expression `^[.\\\\p{Alnum}-_]{1,255}$`",
"type": "string"
},
"properties": {
"$ref": "GoogleCloudApigeeV1Properties",
"description": "Optional. Key-value pairs that may be used for customizing the environment."
}
},
"type": "object"
},
"GoogleCloudApigeeV1EnvironmentConfig": {
"id": "GoogleCloudApigeeV1EnvironmentConfig",
"properties": {
"createTime": {
"description": "The time at which this environment config was created.",
"format": "google-datetime",
"type": "string"
},
"debugMask": {
"$ref": "GoogleCloudApigeeV1DebugMask",
"description": "Debug mask that applies to all deployments in the environment."
},
"deployments": {
"description": "A list of deployments in the environment",
"items": {
"$ref": "GoogleCloudApigeeV1DeploymentConfig"
},
"type": "array"
},
"featureFlags": {
"additionalProperties": {
"type": "string"
},
"description": "Feature flags inherited from the org and environment parents.",
"type": "object"
},
"flowhooks": {
"description": "A list of flow hooks in the environment.",
"items": {
"$ref": "GoogleCloudApigeeV1FlowHookConfig"
},
"type": "array"
},
"keystores": {
"description": "A list of keystores in the environment.",
"items": {
"$ref": "GoogleCloudApigeeV1KeystoreConfig"
},
"type": "array"
},
"name": {
"description": "The name of the environment config. Must be of the form\n'organizations/{org}/environments/{env}/configs/{config_id}",
"type": "string"
},
"provider": {
"description": "This field can be used by the control plane to add some context\ninformation about itself. This information could help detect the source of\nthe document during diagnostics and debugging.",
"type": "string"
},
"pubsubTopic": {
"description": "Name of the pubsub topic for this environment.",
"type": "string"
},
"resourceReferences": {
"description": "A list of resource references in the environment.",
"items": {
"$ref": "GoogleCloudApigeeV1ReferenceConfig"
},
"type": "array"
},
"resources": {
"description": "A list of resource versions in the environment.",
"items": {
"$ref": "GoogleCloudApigeeV1ResourceConfig"
},
"type": "array"
},
"sequenceNumber": {
"description": "A sequence number that defines an ordering on environment configs. No two\nconfigs under an environment will ever have the same sequence number.\nA higher sequence number means that the config was deployed more\nrecently than one with a lower sequence number.",
"format": "int64",
"type": "string"
},
"targets": {
"description": "A list of target servers in the environment. Disabled target servers are\nnot included.",
"items": {
"$ref": "GoogleCloudApigeeV1TargetServerConfig"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1FlowHook": {
"id": "GoogleCloudApigeeV1FlowHook",
"properties": {
"continueOnError": {
"description": "Optional. Flag that specifies whether execution should continue if the flow hook\nthrows an exception. Set to `true` to continue execution. Set to\n`false` to stop execution if the flow hook throws an exception.Defaults\nto `true`.",
"type": "boolean"
},
"description": {
"description": "Description of the flow hook.",
"type": "string"
},
"flowHookPoint": {
"description": "Output only. Where in the API call flow the flow hook is invoked. Must be one of\n`PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or\n`PostTargetFlowHook`.",
"type": "string"
},
"sharedFlow": {
"description": "Shared flow attached to this flow hook, or empty if there is none attached.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1FlowHookConfig": {
"id": "GoogleCloudApigeeV1FlowHookConfig",
"properties": {
"continueOnError": {
"description": "Should the flow abort after an error in the flow hook.\nShould default to true if unset.",
"type": "boolean"
},
"name": {
"description": "The name of the flow hook. Must be of the form\n'organizations/{org}/environments/{env}/flowhooks/{point}''.\nKnown points are PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook,\nand PostTargetFlowHook",
"type": "string"
},
"sharedFlowName": {
"description": "The name of the shared flow to invoke. Must be of the form\n'organizations/{org}/sharedflows/{sharedflow}'.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1GetSyncAuthorizationRequest": {
"description": "Request for\nGetSyncAuthorization.",
"id": "GoogleCloudApigeeV1GetSyncAuthorizationRequest",
"properties": {},
"type": "object"
},
"GoogleCloudApigeeV1KeyAliasReference": {
"id": "GoogleCloudApigeeV1KeyAliasReference",
"properties": {
"aliasId": {
"description": "The alias id. Must exist in the keystore referred to by reference.",
"type": "string"
},
"reference": {
"description": "The reference name. Must be of the form:\norganizations/{org}/environments/{env}/references/{ref}.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1KeyValueMap": {
"description": "A collection of key, value string pairs",
"id": "GoogleCloudApigeeV1KeyValueMap",
"properties": {
"encrypted": {
"description": "Optional. If `true` entry values will be encrypted.",
"type": "boolean"
},
"name": {
"description": "Required. The id of the key value map.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Keystore": {
"description": "A datastore for Certificates and Aliases",
"id": "GoogleCloudApigeeV1Keystore",
"properties": {
"aliases": {
"description": "Output only. The aliases in this keystore.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Required. The resource ID for this keystore. Values must match the\nregular expression `[\\w[:space:]-.]{1,255}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1KeystoreConfig": {
"id": "GoogleCloudApigeeV1KeystoreConfig",
"properties": {
"aliases": {
"description": "Aliases in the keystore.",
"items": {
"$ref": "GoogleCloudApigeeV1AliasRevisionConfig"
},
"type": "array"
},
"name": {
"description": "The resource name. Must be of the\nform:\n'organizations/{org}/environments/{env}/keystores/{keystore}'.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListApiProductsResponse": {
"id": "GoogleCloudApigeeV1ListApiProductsResponse",
"properties": {
"apiProduct": {
"description": "Lists all API product names defined for an organization.",
"items": {
"$ref": "GoogleCloudApigeeV1ApiProduct"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListApiProxiesResponse": {
"id": "GoogleCloudApigeeV1ListApiProxiesResponse",
"properties": {
"proxies": {
"items": {
"$ref": "GoogleCloudApigeeV1ApiProxy"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListAppsResponse": {
"id": "GoogleCloudApigeeV1ListAppsResponse",
"properties": {
"app": {
"items": {
"$ref": "GoogleCloudApigeeV1App"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListAsyncQueriesResponse": {
"description": "The response for ListAsyncQueries",
"id": "GoogleCloudApigeeV1ListAsyncQueriesResponse",
"properties": {
"queries": {
"description": "The asynchronous queries belong to requested organization and environment",
"items": {
"$ref": "GoogleCloudApigeeV1AsyncQuery"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListCompaniesResponse": {
"id": "GoogleCloudApigeeV1ListCompaniesResponse",
"properties": {
"company": {
"description": "A list of company.",
"items": {
"$ref": "GoogleCloudApigeeV1Company"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListCompanyAppsResponse": {
"id": "GoogleCloudApigeeV1ListCompanyAppsResponse",
"properties": {
"app": {
"description": "A list of apps for a company.",
"items": {
"$ref": "GoogleCloudApigeeV1CompanyApp"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListCustomReportsResponse": {
"description": "This message encapsulates a list of custom report definitions",
"id": "GoogleCloudApigeeV1ListCustomReportsResponse",
"properties": {
"qualifier": {
"items": {
"$ref": "GoogleCloudApigeeV1CustomReport"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListDebugSessionsResponse": {
"id": "GoogleCloudApigeeV1ListDebugSessionsResponse",
"properties": {
"sessions": {
"description": "Session info that includes debug session ID and the first transaction\ncreation timestamp.",
"items": {
"$ref": "GoogleCloudApigeeV1Session"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListDeploymentsResponse": {
"id": "GoogleCloudApigeeV1ListDeploymentsResponse",
"properties": {
"deployments": {
"description": "List of deployments.",
"items": {
"$ref": "GoogleCloudApigeeV1Deployment"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListDeveloperAppsResponse": {
"id": "GoogleCloudApigeeV1ListDeveloperAppsResponse",
"properties": {
"app": {
"description": "List of developer apps and their credentials.",
"items": {
"$ref": "GoogleCloudApigeeV1DeveloperApp"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListEnvironmentResourcesResponse": {
"description": "Response for\nListEnvironmentResources",
"id": "GoogleCloudApigeeV1ListEnvironmentResourcesResponse",
"properties": {
"resourceFile": {
"description": "List of resources files.",
"items": {
"$ref": "GoogleCloudApigeeV1ResourceFile"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListHybridIssuersResponse": {
"id": "GoogleCloudApigeeV1ListHybridIssuersResponse",
"properties": {
"issuers": {
"description": "Lists of hybrid services and its trusted issuer email ids.",
"items": {
"$ref": "GoogleCloudApigeeV1ServiceIssuersMapping"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListOfDevelopersResponse": {
"id": "GoogleCloudApigeeV1ListOfDevelopersResponse",
"properties": {
"developer": {
"description": "List of developers.",
"items": {
"$ref": "GoogleCloudApigeeV1Developer"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListOrganizationsResponse": {
"id": "GoogleCloudApigeeV1ListOrganizationsResponse",
"properties": {
"organizations": {
"description": "List of Apigee organizations and associated GCP projects.",
"items": {
"$ref": "GoogleCloudApigeeV1OrganizationProjectMapping"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ListSharedFlowsResponse": {
"id": "GoogleCloudApigeeV1ListSharedFlowsResponse",
"properties": {
"sharedFlows": {
"items": {
"$ref": "GoogleCloudApigeeV1SharedFlow"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Metadata": {
"description": "This message type encapsulates additional information about query execution",
"id": "GoogleCloudApigeeV1Metadata",
"properties": {
"errors": {
"description": "List of error messages as strings",
"items": {
"type": "string"
},
"type": "array"
},
"notices": {
"description": "List of additional information such as data source, if result was\ntruncated etc.\nE.g\n\"notices\": [\n \"Source:Postgres\",\n \"PG Host:uappg0rw.e2e.apigeeks.net\",\n \"query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed\",\n \"Table used: edge.api.uapgroup2.agg_api\"\n ]",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Metric": {
"description": "This message type encapsulates the metric data point\nExample\n{\n \"name\": \"sum(message_count)\",\n \"values\" : [ {\n \"timestamp\": 1549004400000,\n \"value\": \"39.0\"\n },\n {\n \"timestamp\" : 1548997200000,\n \"value\" : \"0.0\"\n } ]\n}\nor\n{\n \"name\": \"sum(message_count)\",\n \"values\" : [\"39.0\"]\n}",
"id": "GoogleCloudApigeeV1Metric",
"properties": {
"name": {
"description": "This field contains the metric name",
"type": "string"
},
"values": {
"description": "List of metric values\nPossible value format\n\"values\":[\"39.0\"] or\n\"values\":[ { \"value\": \"39.0\", \"timestamp\": 1232434354} ]",
"items": {
"type": "any"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1OperationMetadata": {
"description": "Metadata describing an Operation.",
"id": "GoogleCloudApigeeV1OperationMetadata",
"properties": {
"operationType": {
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"INSERT",
"DELETE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"NOT_STARTED",
"IN_PROGRESS",
"FINISHED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"targetResourceName": {
"description": "Name of the resource for which the operation is operating on.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1OptimizedStats": {
"id": "GoogleCloudApigeeV1OptimizedStats",
"properties": {
"Response": {
"$ref": "GoogleCloudApigeeV1OptimizedStatsResponse",
"description": "This field wraps the stats response for Js Optimized Scenario\nwith a Response key.\nE.g.\n{\n \"Response\": {\n \"TimeUnit\": [],\n \"metaData\": {\n \"errors\": [],\n \"notices\": [\n \"Source:Postgres\",\n \"Table used: edge.api.aaxgroup001.agg_api\",\n \"PG Host:ruappg08-ro.production.apigeeks.net\",\n \"query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca\"\n ]\n },\n \"resultTruncated\": false,\n \"stats\": {\n \"data\": [\n {\n \"identifier\": {\n \"names\": [\n \"apiproxy\"\n ],\n \"values\": [\n \"sirjee\"\n ]\n },\n \"metric\": [\n {\n \"env\": \"prod\",\n \"name\": \"sum(message_count)\",\n \"values\": [\n 36.0\n ]\n },\n {\n \"env\": \"prod\",\n \"name\": \"sum(is_error)\",\n \"values\": [\n 36.0\n ]\n }\n ]\n }\n ]\n }\n }\n}"
}
},
"type": "object"
},
"GoogleCloudApigeeV1OptimizedStatsNode": {
"id": "GoogleCloudApigeeV1OptimizedStatsNode",
"properties": {
"data": {
"items": {
"type": "any"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1OptimizedStatsResponse": {
"description": "This message type encapsulates a response format for Js Optimized Scenario",
"id": "GoogleCloudApigeeV1OptimizedStatsResponse",
"properties": {
"TimeUnit": {
"description": "This field contains a list of time unit values. Time unit refers to\nan epoch timestamp value.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"metaData": {
"$ref": "GoogleCloudApigeeV1Metadata",
"description": "This field contains metadata information about the query executed"
},
"resultTruncated": {
"description": "This ia a boolean field to indicate if the results were truncated\nbased on the limit parameter.",
"type": "boolean"
},
"stats": {
"$ref": "GoogleCloudApigeeV1OptimizedStatsNode",
"description": "This field contains a stats results"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Organization": {
"id": "GoogleCloudApigeeV1Organization",
"properties": {
"analyticsRegion": {
"description": "Required. Primary GCP region for analytics data storage. For valid values, see\n[Create an\norganization](https://docs.apigee.com/hybrid/latest/precog-provision).",
"type": "string"
},
"attributes": {
"description": "Not used by Apigee.",
"items": {
"type": "string"
},
"type": "array"
},
"createdAt": {
"description": "Output only. Time that the Apigee organization was created in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"customerName": {
"description": "Not used by Apigee.",
"type": "string"
},
"description": {
"description": "Description of the Apigee organization.",
"type": "string"
},
"displayName": {
"type": "string"
},
"environments": {
"description": "Output only. List of environments in the Apigee organization.",
"items": {
"type": "string"
},
"type": "array"
},
"lastModifiedAt": {
"description": "Output only. Time that the Apigee organization was last modified in milliseconds\nsince epoch.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Required. Name of the Apigee organization.",
"type": "string"
},
"properties": {
"$ref": "GoogleCloudApigeeV1Properties",
"description": "Properties defined in the Apigee organization profile."
},
"runtimeType": {
"description": "Output only. Runtime type of the Apigee organization based on the Apigee subscription\npurchased.",
"enum": [
"RUNTIME_TYPE_UNSPECIFIED",
"CLOUD",
"HYBRID"
],
"enumDescriptions": [
"",
"Google-managed Apigee runtime.",
"User-managed Apigee hybrid runtime."
],
"type": "string"
},
"subscriptionType": {
"description": "Output only. Subscription type of the Apigee organization. Valid values include trial\n(free, limited, and for evaluation purposes only) or paid (full\nsubscription has been purchased). See\n[Apigee pricing](https://cloud.google.com/apigee/pricing/).",
"enum": [
"SUBSCRIPTION_TYPE_UNSPECIFIED",
"PAID",
"TRIAL"
],
"enumDescriptions": [
"",
"Full subscription to Apigee has been purchased.",
"Subscription to Apigee is free, limited, and used for evaluation purposes\nonly."
],
"type": "string"
},
"type": {
"description": "Not used by Apigee.",
"enum": [
"TYPE_UNSPECIFIED",
"TYPE_TRIAL",
"TYPE_PAID",
"TYPE_INTERNAL"
],
"enumDescriptions": [
"Subscription type not specified.",
"Subscription to Apigee is free, limited, and used for evaluation purposes\nonly.",
"Full subscription to Apigee has been purchased. See\n[Apigee pricing](https://cloud.google.com/apigee/pricing/).",
"For internal users only."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1OrganizationProjectMapping": {
"id": "GoogleCloudApigeeV1OrganizationProjectMapping",
"properties": {
"organization": {
"description": "Name of the Apigee organization.",
"type": "string"
},
"projectIds": {
"description": "List of GCP projects associated with the Apigee organization.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1PodStatus": {
"id": "GoogleCloudApigeeV1PodStatus",
"properties": {
"appVersion": {
"description": "Version of the application running in the pod.",
"type": "string"
},
"deploymentStatus": {
"description": "Status of the deployment. Valid values\ninclude:\n- `deployed`: Successful.\n- `error` : Failed.\n- `pending` : Pod has not yet reported on the deployment.",
"type": "string"
},
"deploymentStatusTime": {
"description": "Time the deployment status was reported in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"deploymentTime": {
"description": "Time the proxy was deployed in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"podName": {
"description": "Name of the pod which is reporting the status.",
"type": "string"
},
"podStatus": {
"description": "Overall status of the pod (not this specific deployment). Valid values\ninclude:\n- `active`: Up to date.\n- `stale` : Recently out of date.\n\nPods that have not reported status in a\nlong time are excluded from the output.",
"type": "string"
},
"podStatusTime": {
"description": "Time the pod status was reported in milliseconds since epoch.",
"format": "int64",
"type": "string"
},
"statusCode": {
"description": "Code associated with the deployment status.",
"type": "string"
},
"statusCodeDetails": {
"description": "Human-readable message associated with the status code.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Point": {
"description": "Point is a group of information collected by runtime plane at critical points\nof the message flow of the processed API request.\nThis is a list of supported point IDs, categorized to three major buckets.\nFor each category, debug points that we are currently supporting are listed\nbelow:\n- Flow status debug points:\n StateChange\n FlowInfo\n Condition\n Execution\n DebugMask\n Error\n- Flow control debug points:\n FlowCallout\n Paused\n Resumed\n FlowReturn\n BreakFlow\n Error\n- Runtime debug points:\n ScriptExecutor\n FlowCalloutStepDefinition\n CustomTarget\n StepDefinition\n Oauth2ServicePoint\n RaiseFault\n NodeJS\n\nThe detail information of the given debug point is stored in a list of\nresults.",
"id": "GoogleCloudApigeeV1Point",
"properties": {
"id": {
"description": "Name of a step in the transaction.",
"type": "string"
},
"results": {
"description": "List of results extracted from a given debug point.",
"items": {
"$ref": "GoogleCloudApigeeV1Result"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Properties": {
"description": "Message for compatibility with legacy Edge specification for Java Properties\nobject in JSON.",
"id": "GoogleCloudApigeeV1Properties",
"properties": {
"property": {
"description": "List of all properties in the object",
"items": {
"$ref": "GoogleCloudApigeeV1Property"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Property": {
"description": "A single property entry in the Properties message.",
"id": "GoogleCloudApigeeV1Property",
"properties": {
"name": {
"description": "The property key",
"type": "string"
},
"value": {
"description": "The property value",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Query": {
"id": "GoogleCloudApigeeV1Query",
"properties": {
"csvDelimiter": {
"description": "Delimiter used in the CSV file, if `outputFormat` is set\nto `csv`. Defaults to the `,` (comma) character.\nSupported delimiter characters include comma (`,`), pipe (`|`),\nand tab (`\\t`).",
"type": "string"
},
"dimensions": {
"description": "A list of dimensions\nhttps://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions",
"items": {
"type": "string"
},
"type": "array"
},
"filter": {
"description": "Boolean expression that can be used to filter data.\nFilter expressions can be combined using AND/OR terms and should be fully\nparenthesized to avoid ambiguity. See Analytics metrics, dimensions, and\nfilters reference\nhttps://docs.apigee.com/api-platform/analytics/analytics-reference\nfor more information on the fields available to filter\non. For more information on the tokens that you use to build filter\nexpressions, see Filter expression syntax.\nhttps://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax",
"type": "string"
},
"groupByTimeUnit": {
"description": "Time unit used to group the result set.\nValid values include: second, minute, hour, day, week, or month.\nIf a query includes groupByTimeUnit, then the result is an aggregation\nbased on the specified time unit and the resultant timestamp does not\ninclude milliseconds precision.\nIf a query omits groupByTimeUnit, then the resultant timestamp includes\nmilliseconds precision.",
"type": "string"
},
"limit": {
"description": "Maximum number of rows that can be returned in the result.",
"format": "int32",
"type": "integer"
},
"metrics": {
"description": "A list of Metrics",
"items": {
"$ref": "GoogleCloudApigeeV1QueryMetric"
},
"type": "array"
},
"name": {
"description": "Asynchronous Query Name.",
"type": "string"
},
"outputFormat": {
"description": "Valid values include: `csv` or `json`. Defaults to `json`.\nNote: Configure the delimiter for CSV output using the csvDelimiter\nproperty.",
"type": "string"
},
"reportDefinitionId": {
"description": "Asynchronous Report ID.",
"type": "string"
},
"timeRange": {
"description": "Required. Time range for the query.\nCan use the following predefined strings to specify the time range:\n `last60minutes`\n `last24hours`\n `last7days`\nOr, specify the timeRange as a structure describing start and end\ntimestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ.\n\nExample:\n \"timeRange\": {\n \"start\": \"2018-07-29T00:13:00Z\",\n \"end\": \"2018-08-01T00:18:00Z\"\n }",
"type": "any"
}
},
"type": "object"
},
"GoogleCloudApigeeV1QueryMetadata": {
"id": "GoogleCloudApigeeV1QueryMetadata",
"properties": {
"dimensions": {
"description": "Dimensions of the AsyncQuery.",
"items": {
"type": "string"
},
"type": "array"
},
"endTimestamp": {
"description": "End timestamp of the query range.",
"type": "string"
},
"metrics": {
"description": "Metrics of the AsyncQuery.\n\nExample: [\"name:message_count,func:sum,alias:sum_message_count\"]",
"items": {
"type": "string"
},
"type": "array"
},
"outputFormat": {
"description": "Output format.",
"type": "string"
},
"startTimestamp": {
"description": "Start timestamp of the query range.",
"type": "string"
},
"timeUnit": {
"description": "Query GroupBy time unit.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1QueryMetric": {
"description": "More info about Metric:\nhttps://docs.apigee.com/api-platform/analytics/analytics-reference#metrics",
"id": "GoogleCloudApigeeV1QueryMetric",
"properties": {
"alias": {
"description": "Alias for the metric. Alias will be used to replace metric name\nin query results.",
"type": "string"
},
"function": {
"description": "Aggregation function: avg, min, max, or sum",
"type": "string"
},
"name": {
"description": "Required. Metric name",
"type": "string"
},
"operator": {
"description": "One of `+`, `-`, `/`, `%`, `*`",
"type": "string"
},
"value": {
"description": "Operand value should be provided when operator is set.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Reference": {
"description": "A Reference configuration. References must refer to a keystore\nthat also exists in the parent environment.",
"id": "GoogleCloudApigeeV1Reference",
"properties": {
"description": {
"description": "Optional. A human-readable description of this reference.",
"type": "string"
},
"name": {
"description": "Required. The resource id of this reference. Values must match the\nregular expression [\\w\\s\\-.]+.",
"type": "string"
},
"refers": {
"description": "Required. The id of the resource to which this reference refers.\nMust be the id of a resource that exists in the parent environment and is\nof the given resource_type.",
"type": "string"
},
"resourceType": {
"description": "The type of resource referred to by this reference. Valid values\nare 'KeyStore' or 'TrustStore'.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ReferenceConfig": {
"id": "GoogleCloudApigeeV1ReferenceConfig",
"properties": {
"name": {
"description": "The name of the reference. Must be of the form\n'organizations/{org}/environments/{env}/references/{ref}'.",
"type": "string"
},
"resourceName": {
"description": "The name of the referred resource. Only references to keystore resources\nare supported. Must be of the form\n'organizations/{org}/environments/{env}/keystores/{ks}'.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ReportProperty": {
"id": "GoogleCloudApigeeV1ReportProperty",
"properties": {
"property": {
"description": "name of the property",
"type": "string"
},
"value": {
"description": "property values",
"items": {
"$ref": "GoogleCloudApigeeV1Attribute"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ResourceConfig": {
"id": "GoogleCloudApigeeV1ResourceConfig",
"properties": {
"location": {
"description": "The location of the resource as a URI.",
"type": "string"
},
"name": {
"description": "The resource name. Only environment-scoped resource files are supported.\nMust be of the form\n'organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}'.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ResourceFile": {
"description": "Metadata about a resource file.",
"id": "GoogleCloudApigeeV1ResourceFile",
"properties": {
"name": {
"description": "ID of the resource file.",
"type": "string"
},
"type": {
"description": "Resource file type. {{ resource_file_type }}",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ResourceFiles": {
"description": "List of resource files.",
"id": "GoogleCloudApigeeV1ResourceFiles",
"properties": {
"resourceFile": {
"description": "List of resource files.",
"items": {
"$ref": "GoogleCloudApigeeV1ResourceFile"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Result": {
"description": "Result is short for \"action result\", could be different types identified by\n\"action_result\" field. Supported types:\n1. DebugInfo : generic debug info collected by runtime recorded as a list of\nproperties. For example, the contents could be virtual host info, state\nchange result, or execution metadata. Required fields : properties, timestamp\n\n2. RequestMessage: information of a http request. Contains headers, request\nURI and http methods type.Required fields : headers, uri, verb\n\n3. ResponseMessage: information of a http response. Contains headers, reason\nphrase and http status code. Required fields : headers, reasonPhrase,\nstatusCode\n\n4. ErrorMessage: information of a http error message. Contains detail error\nmessage, reason phrase and status code. Required fields : content, headers,\nreasonPhrase, statusCode\n\n5. VariableAccess: a list of variable access actions, can be Get, Set and\nRemove. Required fields : accessList",
"id": "GoogleCloudApigeeV1Result",
"properties": {
"ActionResult": {
"description": "Type of the action result. Can be one of the five: DebugInfo,\nRequestMessage, ResponseMessage, ErrorMessage, VariableAccess",
"type": "string"
},
"accessList": {
"description": "A list of variable access actions agaist the api proxy.\nSupported values: Get, Set, Remove.",
"items": {
"$ref": "GoogleCloudApigeeV1Access"
},
"type": "array"
},
"content": {
"description": "Error message content. for example,\n\"content\" : \"{\\\"fault\\\":{\\\"faultstring\\\":\\\"API timed\nout\\\",\\\"detail\\\":{\\\"errorcode\\\":\\\"flow.APITimedOut\\\"}}}\"",
"type": "string"
},
"headers": {
"description": "A list of HTTP headers.\nfor example,\n'\"headers\" : [ {\n \"name\" : \"Content-Length\",\n \"value\" : \"83\"\n}, {\n \"name\" : \"Content-Type\",\n \"value\" : \"application/json\"\n} ]'",
"items": {
"$ref": "GoogleCloudApigeeV1Property"
},
"type": "array"
},
"properties": {
"$ref": "GoogleCloudApigeeV1Properties",
"description": "Name value pairs used for DebugInfo ActionResult."
},
"reasonPhrase": {
"description": "HTTP response phrase",
"type": "string"
},
"statusCode": {
"description": "HTTP response code",
"type": "string"
},
"timestamp": {
"description": "Timestamp of when the result is recorded. Its format is dd-mm-yy\nhh:mm:ss:xxx. For example, `\"timestamp\" : \"12-08-19 00:31:59:960\"`",
"type": "string"
},
"uRI": {
"description": "The relative path of the api proxy.\nfor example, `\"uRI\" : \"/iloveapis\"`",
"type": "string"
},
"verb": {
"description": "HTTP method verb",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Schema": {
"description": "Response for Schema call",
"id": "GoogleCloudApigeeV1Schema",
"properties": {
"dimensions": {
"description": "List of schema fiels grouped as dimensions.",
"items": {
"$ref": "GoogleCloudApigeeV1SchemaSchemaElement"
},
"type": "array"
},
"meta": {
"description": "Additional metadata associated with schema. This is\na legacy field and usually consists of an empty array of strings.",
"items": {
"type": "string"
},
"type": "array"
},
"metrics": {
"description": "List of schema fields grouped as dimensions. These are fields\nthat can be used with an aggregate function such as sum, avg, min, max.",
"items": {
"$ref": "GoogleCloudApigeeV1SchemaSchemaElement"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1SchemaSchemaElement": {
"description": "Message type for the schema element",
"id": "GoogleCloudApigeeV1SchemaSchemaElement",
"properties": {
"name": {
"description": "Name of the field",
"type": "string"
},
"properties": {
"$ref": "GoogleCloudApigeeV1SchemaSchemaProperty",
"description": "Property of the schema field\nE.g.\n{\n \"createTime\": \"2016-02-26T10:23:09.592Z\",\n \"custom\": \"false\",\n \"type\": \"string\"\n}"
}
},
"type": "object"
},
"GoogleCloudApigeeV1SchemaSchemaProperty": {
"description": "Message type for schema property",
"id": "GoogleCloudApigeeV1SchemaSchemaProperty",
"properties": {
"createTime": {
"description": "Creation time of the field",
"type": "string"
},
"custom": {
"description": "Custom is a flag signifying if the field was provided as\npart of the standard dataset or a custom field created by the customer",
"type": "string"
},
"type": {
"description": "Data type of the field.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1ServiceIssuersMapping": {
"id": "GoogleCloudApigeeV1ServiceIssuersMapping",
"properties": {
"emailIds": {
"description": "List of trusted issuer email ids.",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "String indicating the Apigee service name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Session": {
"description": "Session carries the debug session id and its creation time.",
"id": "GoogleCloudApigeeV1Session",
"properties": {
"id": {
"description": "The debug session ID.",
"type": "string"
},
"timestampMs": {
"description": "The first transaction creation timestamp in millisecond, recoreded by UAP.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1SharedFlow": {
"description": "The metadata describing a shared flow",
"id": "GoogleCloudApigeeV1SharedFlow",
"properties": {
"latestRevisionId": {
"description": "The id of the most recently created revision for this shared flow.",
"type": "string"
},
"metaData": {
"$ref": "GoogleCloudApigeeV1EntityMetadata",
"description": "Metadata describing the shared flow."
},
"name": {
"description": "The ID of the shared flow.",
"type": "string"
},
"revision": {
"description": "A list of revisions of this shared flow.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1SharedFlowRevision": {
"description": "The metadata describing a shared flow revision.",
"id": "GoogleCloudApigeeV1SharedFlowRevision",
"properties": {
"configurationVersion": {
"$ref": "GoogleCloudApigeeV1ConfigVersion",
"description": "The version of the configuration schema to which this shared flow conforms.\nThe only supported value currently is majorVersion 4 and minorVersion 0.\nThis setting may be used in the future to enable evolution of the shared\nflow format."
},
"contextInfo": {
"description": "A textual description of the shared flow revision.",
"type": "string"
},
"createdAt": {
"description": "Time at which this shared flow revision was created, in milliseconds since\nepoch.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "The human readable name of this shared flow.",
"type": "string"
},
"entityMetaDataAsProperties": {
"additionalProperties": {
"type": "string"
},
"description": "A Key-Value map of metadata about this shared flow revision.",
"type": "object"
},
"lastModifiedAt": {
"description": "Time at which this shared flow revision was most recently modified, in\nmilliseconds since epoch.",
"format": "int64",
"type": "string"
},
"name": {
"description": "The resource ID of the parent shared flow.",
"type": "string"
},
"policies": {
"description": "A list of policy names included in this shared flow revision.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceFiles": {
"$ref": "GoogleCloudApigeeV1ResourceFiles",
"description": "The resource files included in this shared flow revision."
},
"resources": {
"description": "A list of the resources included in this shared flow revision formatted as\n\"{type}://{name}\".",
"items": {
"type": "string"
},
"type": "array"
},
"revision": {
"description": "The resource ID of this revision.",
"type": "string"
},
"sharedFlows": {
"description": "A list of the shared flow names included in this shared flow revision.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "The string \"Application\"",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Stats": {
"description": "This message type encapsulates a stats response",
"id": "GoogleCloudApigeeV1Stats",
"properties": {
"environments": {
"items": {
"$ref": "GoogleCloudApigeeV1StatsEnvironmentStats"
},
"type": "array"
},
"metaData": {
"$ref": "GoogleCloudApigeeV1Metadata",
"description": "This field contains the metadata information"
}
},
"type": "object"
},
"GoogleCloudApigeeV1StatsEnvironmentStats": {
"description": "This message type encapsulates the environment wrapper\n \"environments\": [\n {\n \"metrics\": [\n {\n \"name\": \"sum(message_count)\",\n \"values\": [\n \"2.52056245E8\"\n ]\n }\n ],\n \"name\": \"prod\"\n }\n ]",
"id": "GoogleCloudApigeeV1StatsEnvironmentStats",
"properties": {
"dimensions": {
"description": "This field contains the list of metrics grouped under dimensions",
"items": {
"$ref": "GoogleCloudApigeeV1DimensionMetric"
},
"type": "array"
},
"metrics": {
"description": "In the final response, only one of the following fields will be present\nbased on the dimensions provided. If no dimensions are provided, then\nonly a top level metrics is provided. If dimensions are included, then\nthere will be a top level dimensions field under environments which will\ncontain metrics values and the dimension name.\nExample:\n \"environments\": [\n {\n \"dimensions\": [\n {\n \"metrics\": [\n {\n \"name\": \"sum(message_count)\",\n \"values\": [\n \"2.14049521E8\"\n ]\n }\n ],\n \"name\": \"nit_proxy\"\n }\n ],\n \"name\": \"prod\"\n }\n ]\n\n OR\n \"environments\": [\n {\n \"metrics\": [\n {\n \"name\": \"sum(message_count)\",\n \"values\": [\n \"2.19026331E8\"\n ]\n }\n ],\n \"name\": \"prod\"\n }\n ]\nThis field contains the list of metric values",
"items": {
"$ref": "GoogleCloudApigeeV1Metric"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1Subscription": {
"description": "Pub/Sub subscription of an environment.",
"id": "GoogleCloudApigeeV1Subscription",
"properties": {
"name": {
"description": "Full name of the Pub/Sub subcription. Use the following structure in your\nrequest:\n `subscription \"projects/foo/subscription/bar\"`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1SyncAuthorization": {
"id": "GoogleCloudApigeeV1SyncAuthorization",
"properties": {
"etag": {
"description": "Entity tag (ETag) used for optimistic concurrency control as a way to help\nprevent simultaneous updates from overwriting each other.\n\nFor example, when you call [getSyncAuthorization](getSyncAuthorization)\nan ETag is returned in the response. Pass that ETag when calling\nthe [setSyncAuthorization](setSyncAuthorization) to ensure\nthat you are updating the correct version. If you don't pass the\nETag in the call to `setSyncAuthorization`, then the\nexisting authorization is overwritten indiscriminately.\n\n**Note**: We strongly recommend that you use the ETag in the\nread-modify-write cycle to avoid race conditions.",
"format": "byte",
"type": "string"
},
"identities": {
"description": "Required. Array of service accounts to grant access to control plane\nresources, each specified using the following\nformat: `serviceAccount:`\u003cvar\u003eservice-account-name\u003c/var\u003e.\n\nThe \u003cvar\u003eservice-account-name\u003c/var\u003e is formatted like an email address. For\nexample:\n`my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com`\n\nYou might specify multiple service accounts, for example, if you have\nmultiple environments and wish to assign a unique service account to each\none.\n\nThe service accounts must have **Apigee Synchronizer Manager** role.\nSee also [Create service\naccounts](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service-accounts).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudApigeeV1TargetServer": {
"description": "TargetServer configuration. TargetServers are used to decouple a proxy's\nTargetEndpoint HTTPTargetConnections from concrete URLs for backend services.",
"id": "GoogleCloudApigeeV1TargetServer",
"properties": {
"description": {
"description": "Optional. A human-readable description of this TargetServer.",
"type": "string"
},
"host": {
"description": "Required. The host name this target connects to. Value must be a valid\nhostname as described by RFC-1123.",
"type": "string"
},
"isEnabled": {
"description": "Optional. Enabling/disabling a TargetServer is useful when TargetServers\nare used in load balancing configurations, and one or more TargetServers\nneed to taken out of rotation periodically. Defaults to true.",
"type": "boolean"
},
"name": {
"description": "Required. The resource id of this target server. Values must match the\nregular expression ",
"type": "string"
},
"port": {
"description": "Required. The port number this target connects to on the given host. Value\nmust be between 1 and 65535, inclusive.",
"format": "int32",
"type": "integer"
},
"sSLInfo": {
"$ref": "GoogleCloudApigeeV1TlsInfo",
"description": "Optional. Specifies TLS configuration info for this TargetServer. The JSON\nname is `sSLInfo` for legacy/backwards compatibility reasons -- Edge\noriginally supported SSL, and the name is still used for TLS configuration."
}
},
"type": "object"
},
"GoogleCloudApigeeV1TargetServerConfig": {
"id": "GoogleCloudApigeeV1TargetServerConfig",
"properties": {
"host": {
"description": "Target host name.",
"type": "string"
},
"name": {
"description": "The target server revision name. Must be of the form\n'organizations/{org}/environments/{env}/targetservers/{ts_id}/revisions/{rev}'.",
"type": "string"
},
"port": {
"description": "Target port.",
"format": "int32",
"type": "integer"
},
"tlsInfo": {
"$ref": "GoogleCloudApigeeV1TlsInfoConfig",
"description": "TLS settings for the target."
}
},
"type": "object"
},
"GoogleCloudApigeeV1TlsInfo": {
"description": "TLS configuration information for\nVirtualHosts and\nTargetServers.",
"id": "GoogleCloudApigeeV1TlsInfo",
"properties": {
"ciphers": {
"description": "The SSL/TLS cipher suites to be used. Must be one of the cipher suite names\nlisted in:\nhttp://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites",
"items": {
"type": "string"
},
"type": "array"
},
"clientAuthEnabled": {
"description": "Optional. Enables two-way TLS.",
"type": "boolean"
},
"commonName": {
"$ref": "GoogleCloudApigeeV1TlsInfoCommonName",
"description": "The TLS Common Name of the certificate."
},
"enabled": {
"description": "Required. Enables one-way TLS.",
"type": "boolean"
},
"ignoreValidationErrors": {
"description": "If true, Edge ignores TLS certificate errors. Valid when configuring TLS\nfor target servers and target endpoints, and when configuring virtual hosts\nthat use 2-way TLS.\n\nWhen used with a target endpoint/target server, if the backend system uses\nSNI and returns a cert with a subject Distinguished Name (DN) that does not\nmatch the hostname, there is no way to ignore the error and the connection\nfails.",
"type": "boolean"
},
"keyAlias": {
"description": "Required if `client_auth_enabled` is true. The resource ID for the\nalias containing the private key and cert.",
"type": "string"
},
"keyStore": {
"description": "Required if `client_auth_enabled` is true. The resource ID of the\nkeystore. References not yet supported.",
"type": "string"
},
"protocols": {
"description": "The TLS versioins to be used.",
"items": {
"type": "string"
},
"type": "array"
},
"trustStore": {
"description": "The resource ID of the truststore.\nReferences not yet supported.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudApigeeV1TlsInfoCommonName": {
"id": "GoogleCloudApigeeV1TlsInfoCommonName",
"properties": {
"value": {
"description": "The TLS Common Name string of the certificate.",
"type": "string"
},
"wildcardMatch": {
"description": "Indicates whether the cert should be matched against as a wildcard cert.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudApigeeV1TlsInfoConfig": {
"id": "GoogleCloudApigeeV1TlsInfoConfig",
"properties": {
"ciphers": {
"description": "Whitelist of supported ciphers.",
"items": {
"type": "string"
},
"type": "array"
},
"clientAuthEnabled": {
"description": "Indicates if client auth is enabled for the target. Enables two-way TLS.",
"type": "boolean"
},
"commonName": {
"$ref": "GoogleCloudApigeeV1CommonNameConfig",
"description": "Common name to validate the target against."
},
"enabled": {
"description": "Enables one-way TLS.",
"type": "boolean"
},
"ignoreValidationErrors": {
"description": "If true, ignore TLS certificate validation errors.",
"type": "boolean"
},
"keyAlias": {
"description": "The name of the Alias used for client side auth. It must be of the form:\norganizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}",
"type": "string"
},
"keyAliasReference": {
"$ref": "GoogleCloudApigeeV1KeyAliasReference",
"description": "A pair of reference name and alias to use for client side auth."
},
"protocols": {
"description": "Whitelist of supported TLS protocols.",
"items": {
"type": "string"
},
"type": "array"
},
"trustStore": {
"description": "The name of the Keystore or keystore reference containing trusted\ncertificates for the server. It must be of either the form\norganizations/{org}/environments/{env}/keystores/{keystore} or\norganizations/{org}/environments/{env}/references/{reference}.",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1AuditConfig": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
"id": "GoogleIamV1AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "GoogleIamV1AuditLogConfig"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
"id": "GoogleIamV1AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1Binding": {
"description": "Associates `members` with a `role`.",
"id": "GoogleIamV1Binding",
"properties": {
"condition": {
"$ref": "GoogleTypeExpr",
"description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "GoogleIamV1Policy",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "GoogleIamV1AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
"items": {
"$ref": "GoogleIamV1Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleIamV1SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "GoogleIamV1SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "GoogleIamV1Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
},
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "GoogleIamV1TestIamPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleIamV1TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"id": "GoogleIamV1TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleLongrunningListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "GoogleLongrunningListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleLongrunningOperation"
},
"type": "array"
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleRpcStatus": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeExpr": {
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() \u003c 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' \u0026\u0026 document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
"id": "GoogleTypeExpr",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
"type": "string"
},
"location": {
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Apigee API",
"version": "v1",
"version_module": true
}