1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.apis.html">apis</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apigee_v1.organizations.apis.debugsessions.html">debugsessions()</a></code>
</p>
<p class="firstline">Returns the debugsessions Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.apis.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.apis.keyvaluemaps.html">keyvaluemaps()</a></code>
</p>
<p class="firstline">Returns the keyvaluemaps Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.apis.revisions.html">revisions()</a></code>
</p>
<p class="firstline">Returns the revisions Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, action=None, body=None, name=None, space=None, validate=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an API proxy including a list of existing revisions.</p>
<p class="toc_element">
<code><a href="#list">list(parent, includeMetaData=None, includeRevisions=None, space=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).</p>
<p class="toc_element">
<code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves an API proxy to a different space.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing API proxy.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, action=None, body=None, name=None, space=None, validate=None, x__xgafv=None)</code>
<pre>Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.
Args:
parent: string, Required. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
body: object, The request body.
The object takes the form of:
{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}
action: string, Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * `import` to import the API proxy configuration bundle. * `validate` to validate the API proxy configuration bundle without importing it.
name: string, Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
space: string, Optional. The ID of the space associated with this proxy. Any IAM policies applied to the space will affect access to this proxy. Note that this field is only respected when creating a new proxy. It has no effect when creating a new revision for an existing proxy.
validate: boolean, Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # API proxy revision.
"archive": "A String", # Output only. The archive that generated this proxy revision. This field is only present on proxy revisions that were generated by an archive. Proxies generated by archives cannot be updated, deleted, or deployed to other environments. Format: `organizations/*/environments/*/archiveDeployments/*`
"basepaths": [ # Base URL of the API proxy.
"A String",
],
"configurationVersion": { # Version of the API proxy configuration schema. Currently, only 4.0 is supported. # Version of the API proxy configuration schema to which the API proxy conforms. Currently, the only supported value is 4.0 (`majorVersion.minorVersion`). This setting may be used in the future to track the evolution of the API proxy format.
"majorVersion": 42, # Major version of the API proxy configuration schema.
"minorVersion": 42, # Minor version of the API proxy configuration schema.
},
"contextInfo": "A String", # Revision number, app name, and organization for the API proxy.
"createdAt": "A String", # Time that the API proxy revision was created in milliseconds since epoch.
"description": "A String", # Description of the API proxy revision.
"displayName": "A String", # Human-readable name of the API proxy.
"entityMetaDataAsProperties": { # Metadata describing the API proxy revision as a key-value map.
"a_key": "A String",
},
"hasExtensiblePolicy": True or False, # Output only. This field will be marked as true if revision contains any policies marked as extensible.
"integrationEndpoints": [ # List of IntegrationEndpoints in the '/integration-endpoints' directory of the API proxy. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"lastModifiedAt": "A String", # Time that the API proxy revision was last modified in milliseconds since epoch.
"name": "A String", # Name of the API proxy.
"policies": [ # List of policy names included in the API proxy revision..
"A String",
],
"proxies": [ # List of proxy names included in the API proxy revision.
"A String",
],
"proxyEndpoints": [ # List of ProxyEndpoints in the `/proxies` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"resourceFiles": { # List of resource files. # List of resource files included in the API proxy revision.
"resourceFile": [ # List of resource files.
{ # Metadata about a resource file.
"name": "A String", # ID of the resource file.
"type": "A String", # Resource file type. {{ resource_file_type }}
},
],
},
"resources": [ # List of the resources included in the API proxy revision formatted as "{type}://{name}".
"A String",
],
"revision": "A String", # API proxy revision.
"sharedFlows": [ # List of the shared flows included in the API proxy revision.
"A String",
],
"spec": "A String", # OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store.
"targetEndpoints": [ # List of TargetEndpoints in the `/targets` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"targetServers": [ # List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.
"A String",
],
"targets": [ # List of the targets included in the API proxy revision.
"A String",
],
"teams": [ # List of the teams included in the API proxy revision.
"A String",
],
"type": "A String", # Type. Set to `Application`. Maintained for compatibility with the Apigee Edge API.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.
Args:
name: string, Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata describing the API proxy
"apiProxyType": "A String", # Output only. The type of the API proxy.
"labels": { # User labels applied to this API Proxy.
"a_key": "A String",
},
"latestRevisionId": "A String", # Output only. The id of the most recently created revision for this api proxy.
"metaData": { # Metadata common to many entities in this API. # Output only. Metadata describing the API proxy.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # Output only. Name of the API proxy.
"readOnly": True or False, # Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
"revision": [ # Output only. List of revisions defined for the API proxy.
"A String",
],
"space": "A String", # Optional. The id of the space this proxy is associated with. Any IAM policies applied to the space will control access to this proxy. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an API proxy including a list of existing revisions.
Args:
name: string, Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata describing the API proxy
"apiProxyType": "A String", # Output only. The type of the API proxy.
"labels": { # User labels applied to this API Proxy.
"a_key": "A String",
},
"latestRevisionId": "A String", # Output only. The id of the most recently created revision for this api proxy.
"metaData": { # Metadata common to many entities in this API. # Output only. Metadata describing the API proxy.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # Output only. Name of the API proxy.
"readOnly": True or False, # Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
"revision": [ # Output only. List of revisions defined for the API proxy.
"A String",
],
"space": "A String", # Optional. The id of the space this proxy is associated with. Any IAM policies applied to the space will control access to this proxy. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, includeMetaData=None, includeRevisions=None, space=None, x__xgafv=None)</code>
<pre>Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
Args:
parent: string, Required. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
includeMetaData: boolean, Flag that specifies whether to include API proxy metadata in the response.
includeRevisions: boolean, Flag that specifies whether to include a list of revisions in the response.
space: string, Optional. The space ID to filter the list of proxies (optional). If unspecified, all proxies in the organization will be listed.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"proxies": [
{ # Metadata describing the API proxy
"apiProxyType": "A String", # Output only. The type of the API proxy.
"labels": { # User labels applied to this API Proxy.
"a_key": "A String",
},
"latestRevisionId": "A String", # Output only. The id of the most recently created revision for this api proxy.
"metaData": { # Metadata common to many entities in this API. # Output only. Metadata describing the API proxy.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # Output only. Name of the API proxy.
"readOnly": True or False, # Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
"revision": [ # Output only. List of revisions defined for the API proxy.
"A String",
],
"space": "A String", # Optional. The id of the space this proxy is associated with. Any IAM policies applied to the space will control access to this proxy. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
<pre>Moves an API proxy to a different space.
Args:
name: string, Required. API proxy to move in the following format: `organizations/{org}/apis/{api}` (required)
body: object, The request body.
The object takes the form of:
{ # Moves an API Proxy to a different Space.
"space": "A String", # Optional. Resource ID of the space to move the proxy to. If unspecified, the proxy will be moved to the organization level.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata describing the API proxy
"apiProxyType": "A String", # Output only. The type of the API proxy.
"labels": { # User labels applied to this API Proxy.
"a_key": "A String",
},
"latestRevisionId": "A String", # Output only. The id of the most recently created revision for this api proxy.
"metaData": { # Metadata common to many entities in this API. # Output only. Metadata describing the API proxy.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # Output only. Name of the API proxy.
"readOnly": True or False, # Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
"revision": [ # Output only. List of revisions defined for the API proxy.
"A String",
],
"space": "A String", # Optional. The id of the space this proxy is associated with. Any IAM policies applied to the space will control access to this proxy. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing API proxy.
Args:
name: string, Required. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
body: object, The request body.
The object takes the form of:
{ # Metadata describing the API proxy
"apiProxyType": "A String", # Output only. The type of the API proxy.
"labels": { # User labels applied to this API Proxy.
"a_key": "A String",
},
"latestRevisionId": "A String", # Output only. The id of the most recently created revision for this api proxy.
"metaData": { # Metadata common to many entities in this API. # Output only. Metadata describing the API proxy.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # Output only. Name of the API proxy.
"readOnly": True or False, # Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
"revision": [ # Output only. List of revisions defined for the API proxy.
"A String",
],
"space": "A String", # Optional. The id of the space this proxy is associated with. Any IAM policies applied to the space will control access to this proxy. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}
updateMask: string, Required. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata describing the API proxy
"apiProxyType": "A String", # Output only. The type of the API proxy.
"labels": { # User labels applied to this API Proxy.
"a_key": "A String",
},
"latestRevisionId": "A String", # Output only. The id of the most recently created revision for this api proxy.
"metaData": { # Metadata common to many entities in this API. # Output only. Metadata describing the API proxy.
"createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
"lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
"subType": "A String", # The type of entity described
},
"name": "A String", # Output only. Name of the API proxy.
"readOnly": True or False, # Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
"revision": [ # Output only. List of revisions defined for the API proxy.
"A String",
],
"space": "A String", # Optional. The id of the space this proxy is associated with. Any IAM policies applied to the space will control access to this proxy. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
}</pre>
</div>
</body></html>
|
