3.0.0 • Published 5 years ago

@datafire/google_apigee v3.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/google_apigee

Client library for Apigee API

Installation and Usage

npm install --save @datafire/google_apigee
let google_apigee = require('@datafire/google_apigee').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Get started using the APIs. Note: This product is available as a free trial for a time period of 60 days.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_apigee.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_apigee.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

apigee.organizations.create

Creates an Apigee organization. See Create an Apigee organization.

google_apigee.apigee.organizations.create({}, context)

Input

  • input object
    • parent string: Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: projects/
    • body GoogleCloudApigeeV1Organization
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.instances.reportStatus

Reports the latest status for a runtime instance.

google_apigee.apigee.organizations.instances.reportStatus({
  "instance": ""
}, context)

Input

  • input object
    • instance required string: The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance}
    • body GoogleCloudApigeeV1ReportInstanceStatusRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.sites.apicategories.delete

Deletes a category from the portal.

google_apigee.apigee.organizations.sites.apicategories.delete({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the category. Use the following structure in your request: organizations/{org}/sites/{site}/apicategories/{apicategory}
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.sites.apicategories.get

Gets a category on the portal.

google_apigee.apigee.organizations.sites.apicategories.get({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the category. Use the following structure in your request: organizations/{org}/sites/{site}/apicategories/{apicategory}
    • format string (values: INGRESS_CONFIG_VIEW_UNSPECIFIED, BASIC, FULL): Specify bundle to export the contents of the shared flow bundle. Otherwise, the bundle metadata is returned.
    • envgroupHostname string: Required. The hostname for which the interactive query will be executed.
    • filter string: Enables drill-down on specific dimension values.
    • limit string: This parameter is used to limit the number of result items. Default and the max value is 14400.
    • offset string: Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.
    • realtime boolean: Legacy field: not used anymore.
    • select string: Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)
    • sort string: This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.
    • sortby string: Comma separated list of columns to sort the final result.
    • timeRange string: Required. Time interval for the interactive query. Time range is specified as start~end. E.g 04/15/2017 00:00~05/15/2017 23:59.
    • timeUnit string: A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.
    • topk string: Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.
    • tsAscending boolean: Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.
    • tzo string: This parameters contains the timezone offset value.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.sites.apicategories.patch

Updates a category on the portal.

google_apigee.apigee.organizations.sites.apicategories.patch({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the category. Use the following structure in your request: organizations/{org}/sites/{site}/apicategories/{apicategory}
    • replaceRepeatedFields boolean: Boolean flag that specifies whether to replace existing values in the debug mask when doing an update. Set to true to replace existing values. The default behavior is to append the values (false).
    • updateMask string: Field debug mask to support partial updates.
    • body GoogleCloudApigeeV1ApiCategoryData
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.sharedflows.revisions.updateSharedFlowRevision

Updates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable, even if it becomes undeployed. The payload is a ZIP-formatted shared flow. Content type must be either multipart/form-data or application/octet-stream.

google_apigee.apigee.organizations.sharedflows.revisions.updateSharedFlowRevision({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. The name of the shared flow revision to update. Must be of the form: organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}
    • validate boolean: Ignored. All uploads are validated regardless of the value of this field. It is kept for compatibility with existing APIs. Must be true or false if provided.
    • body GoogleApiHttpBody
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.reports.update

Update an existing custom report definition

google_apigee.apigee.organizations.reports.update({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Custom Report name of the form: organizations/{organization_id}/reports/{report_name}
    • ignoreExpiryValidation boolean: Required. If true, no expiry validation will be performed.
    • ignoreNewlineValidation boolean: If true, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.
    • body GoogleCloudApigeeV1CustomReport
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.developers.apps.attributes

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

google_apigee.apigee.organizations.developers.apps.attributes({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the developer app. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}
    • body GoogleCloudApigeeV1Attributes
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.keystores.aliases.getCertificate

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

google_apigee.apigee.organizations.environments.keystores.aliases.getCertificate({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. The name of the alias. Must be of the form organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.keystores.aliases.csr

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

google_apigee.apigee.organizations.environments.keystores.aliases.csr({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. The name of the alias. Must be of the form organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.apis.revisions.debugsessions.deleteData

Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods.

google_apigee.apigee.organizations.environments.apis.revisions.debugsessions.deleteData({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. The name of the debug session to delete. Must be of the form: organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.sharedflows.revisions.undeploy

Undeploys a shared flow revision from an environment. For a request path organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments, two permissions are required: apigee.deployments.delete on the resource organizations/{org}/environments/{env} apigee.sharedflowrevisions.undeploy on the resource organizations/{org}/sharedflows/{sf}/revisions/{rev}

google_apigee.apigee.organizations.environments.sharedflows.revisions.undeploy({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the shared flow revision to undeploy in the following format: organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}
    • sequencedRollout boolean: If true, a best-effort attempt will be made to remove the environment group routing rules corresponding to this deployment before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The GenerateUndeployChangeReport API may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.sharedflows.revisions.getDeployments

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

google_apigee.apigee.organizations.environments.sharedflows.revisions.getDeployments({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name representing a shared flow in an environment in the following format: organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.sharedflows.revisions.deploy

Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the override parameter to true to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments, two permissions are required: apigee.deployments.create on the resource organizations/{org}/environments/{env} apigee.sharedflowrevisions.deploy on the resource organizations/{org}/sharedflows/{sf}/revisions/{rev}

google_apigee.apigee.organizations.environments.sharedflows.revisions.deploy({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the shared flow revision to deploy in the following format: organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}
    • override boolean: Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks. If an existing shared flow revision is deployed, to ensure seamless deployment with no downtime, set this parameter to true. In this case, hybrid deploys the new revision fully before undeploying the existing revision. If set to false, you must undeploy the existing revision before deploying the new revision.
    • sequencedRollout boolean: If true, a best-effort attempt will be made to roll out the routing rules corresponding to this deployment and the environment changes to add this deployment in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a basepath removal. The GenerateDeployChangeReport API may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport

Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport, two permissions are required: apigee.deployments.create on the resource organizations/{org}/environments/{env} apigee.proxyrevisions.deploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

google_apigee.apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport({
  "name": ""
}, context)

Input

  • input object
    • name required string: Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
    • override boolean: Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport

Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport, two permissions are required: apigee.deployments.delete on the resource organizations/{org}/environments/{env} apigee.proxyrevisions.undeploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

google_apigee.apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport({
  "name": ""
}, context)

Input

  • input object
    • name required string: Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.operations.list

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

google_apigee.apigee.organizations.operations.list({
  "name": ""
}, context)

Input

  • input object
    • name required string: The name of the operation's parent resource.
    • filter string: The standard list filter.
    • pageSize integer: The standard list page size.
    • pageToken string: The standard list page token.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.instances.natAddresses.activate

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

google_apigee.apigee.organizations.instances.natAddresses.activate({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}
    • body GoogleCloudApigeeV1ActivateNatAddressRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.getSyncAuthorization

Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to getSyncAuthorization. Pass that ETag when calling setSyncAuthorization to ensure that you are updating the correct version. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

google_apigee.apigee.organizations.getSyncAuthorization({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}
    • body GoogleCloudApigeeV1GetSyncAuthorizationRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.setSyncAuthorization

Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling setSyncAuthorization to ensure that you are updating the correct version. To get an ETag, call getSyncAuthorization. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

google_apigee.apigee.organizations.setSyncAuthorization({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}
    • body GoogleCloudApigeeV1SyncAuthorization
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.list

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

google_apigee.apigee.organizations.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Use the following structure in your request: organizations
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.keystores.aliases.create

Creates an alias from a key, certificate pair. The structure of the request is controlled by the format query parameter: keycertfile - Separate PEM-encoded key and certificate files are uploaded. The request must have Content-Type: multipart/form-data and include fields keyFile and certFile. If uploading to a truststore, omit keyFile. A password field should be provided for encrypted keys. pkcs12 - A PKCS12 file is uploaded. The request must have Content-Type: multipart/form-data with the file provided in the file field and a password field if the file is encrypted. * selfsignedcert - A new private key and certificate are generated. The request must have Content-Type: application/json and a body of CertificateGenerationSpec.

google_apigee.apigee.organizations.environments.keystores.aliases.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. The name of the keystore. Must be of the form organizations/{organization}/environments/{environment}/keystores/{keystore}.
    • _password string: DEPRECATED: For improved security, send the password in the body instead of using this query param. To send it in the body, use a multipart/form-data part with name "password". The password for the private key file, if it exists.
    • alias string: The alias for the key, certificate pair. Values must match regular expression [\w\s-.]{1,255}. This must be provided for all formats except 'selfsignedcert'; self-signed certs may specify the alias in either this parameter or the JSON body.
    • format string: Required. The format of the data. Must be either selfsignedcert, keycertfile, or pkcs12.
    • ignoreExpiryValidation boolean: If true, no expiry validation will be performed.
    • ignoreNewlineValidation boolean: If true, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.
    • body GoogleApiHttpBody
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.analytics.datastores.list

List Datastores

google_apigee.apigee.organizations.analytics.datastores.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. The parent organization name. Must be of the form organizations/{org}.
    • targetType string: Optional. TargetType is used to fetch all Datastores that match the type
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.analytics.datastores.create

Create a Datastore for an org

google_apigee.apigee.organizations.analytics.datastores.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. The parent organization name. Must be of the form organizations/{org}.
    • body GoogleCloudApigeeV1Datastore
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.analytics.datastores.test

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

google_apigee.apigee.organizations.analytics.datastores.test({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. The parent organization name Must be of the form organizations/{org}
    • body GoogleCloudApigeeV1Datastore
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.analytics.exports.list

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

google_apigee.apigee.organizations.environments.analytics.exports.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Names of the parent organization and environment. Must be of the form organizations/{org}/environments/{env}.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.environments.analytics.exports.create

Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the state value of "enqueued".

google_apigee.apigee.organizations.environments.analytics.exports.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Names of the parent organization and environment. Must be of the form organizations/{org}/environments/{env}.
    • body GoogleCloudApigeeV1ExportRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.sites.apicategories.list

Lists the categories on the portal.

google_apigee.apigee.organizations.sites.apicategories.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the portal. Use the following structure in your request: organizations/{org}/sites/{site}
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.sites.apicategories.create

Creates a new category on the portal.

google_apigee.apigee.organizations.sites.apicategories.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the portal. Use the following structure in your request: organizations/{org}/sites/{site}
    • body GoogleCloudApigeeV1ApiCategoryData
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.apiproducts.list

Lists all API product names for an organization. Filter the list by passing an attributename and attibutevalue. The limit on the number of API products returned by the API is 1000. You can paginate the list of API products returned using the startKey and count query parameters.

google_apigee.apigee.organizations.apiproducts.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the organization. Use the following structure in your request: organizations/{org}
    • attributename string: Name of the attribute used to filter the search.
    • attributevalue string: Value of the attribute used to filter the search.
    • count string: Enter the number of API products you want returned in the API call. The limit is 1000.
    • expand boolean: Flag that specifies whether to expand the results. Set to true to get expanded details about each API.
    • startKey string: Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the count query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using startKey). Product name is case sensitive.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.apiproducts.create

Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on-the-fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer grained API products, defining different sets of API resources for each API product. WARNING: - If you don't specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?

google_apigee.apigee.organizations.apiproducts.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the organization in which the API product will be created. Use the following structure in your request: organizations/{org}
    • body GoogleCloudApigeeV1ApiProduct
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.apis.list

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.

google_apigee.apigee.organizations.apis.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the organization in the following format: organizations/{org}
    • 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.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

apigee.organizations.apis.create

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.

google_apigee.apigee.organizations.apis.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the organization in the following format: organizations/{org}
    • 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.
    • body GoogleApiHttpBody
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: 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.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uplo