blob: 0a08929ef15b450ce4604a51f7c45fdc88d9d6fe [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"
]
}
}
},
"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. To avoid service\ndisruptions, a consumer key and secret should not exceed 2 KBs each.\n\n**Note**: When creating the consumer key and secret, an association to\nAPI products will not be made. Therefore, you should not specify the\nassociated API products in your request. Instead, use the\nUpdateDeveloperAppKey API to\nmake the association after the consumer key and secret are created.\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. To avoid service\ndisruptions, a consumer key and secret should not exceed 2 KBs each.\n\n**Note**: When creating the consumer key and secret, an association to\nAPI products will not be made. Therefore, you should not specify the\nassociated API products in your request. Instead, use the\nUpdateDeveloperAppKey API to\nmake the association after the consumer key and secret are created.\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\nname 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"
]
},
"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.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"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"
]
},
"get": {
"description": "Retrieves a debug session.",
"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}",
"httpMethod": "GET",
"id": "apigee.organizations.environments.apis.revisions.debugsessions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the debug session to retrieve.\nMust be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.",
"location": "path",
"pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudApigeeV1DebugSession"
},
"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": {
"pageSize": {
"description": "Maximum number of debug sessions to return. The page size defaults\nto 25.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token, returned from a previous ListDebugSessions call, that you\ncan use to retrieve the next page.",
"location": "query",
"type": "string"
},
"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 resource name for which the interactive query will be executed.\nMust 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 resource name.\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}",