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.

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

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.

Method Details

close()

Close httplib2 connections.

create(parent, action=None, body=None, name=None, validate=None, x__xgafv=None)

Args:
parent: string, Required. Name of the organization in the following format: `organizations/{org}` (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._-
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.
}

delete(name, x__xgafv=None)

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}` (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",
  ],
}

get(name, x__xgafv=None)

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}` (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",
  ],
}

list(parent, includeMetaData=None, includeRevisions=None, x__xgafv=None)

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.

Args:
  parent: string, Required. Name of the organization in the following format: `organizations/{org}` (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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # To change this message, in the same CL add a change log in go/changing-api-proto-breaks-ui
  "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",
      ],
    },
  ],
}

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an existing API proxy.

Args:
  name: string, Required. API proxy to update in the following format: `organizations/{org}/apis/{api}` (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",
  ],
}

  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",
  ],
}

Apigee API . organizations . apis

Instance Methods

Method Details