App Engine Admin API (appengine:v1beta)

▼ ▲ appengine.projects.locations.applications.services.patch

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}

HTTP Method : PATCH

Parameters :

projectsId

Description : Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

servicesId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

updateMask

Description : Required. Standard field mask for the set of fields to be updated.

Location : query

Type : string

Format : google-fieldmask

migrateTraffic

Description : Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).

Location : query

Type : boolean

Parameter Order :

• projectsId
• locationsId
• applicationsId
• servicesId

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Updates the configuration of the specified service.

▼ ▲ appengine.projects.locations.applications.authorizedCertificates.list

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates

HTTP Method : GET

Parameters :

projectsId

Description : Part of `parent`. Name of the parent Application resource. Example: apps/myapp.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `parent`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `parent`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

view

Description : Controls the set of fields returned in the LIST response.

Location : query

Type : string

Enum Descriptions :

• Basic certificate information, including applicable domains and expiration date.
• The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.

Enum :

• BASIC_CERTIFICATE
• FULL_CERTIFICATE

pageSize

Description : Maximum results to return per page.

Location : query

Type : integer

Format : int32

pageToken

Description : Continuation token for fetching the next page of results.

Location : query

Type : string

Parameter Order :

• projectsId
• locationsId
• applicationsId

Scopes :

• https://www.googleapis.com/auth/appengine.admin
• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

Description : Lists all SSL certificates the user is authorized to administer.

▼ ▲ appengine.projects.locations.applications.authorizedCertificates.get

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}

HTTP Method : GET

Parameters :

projectsId

Description : Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

authorizedCertificatesId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

view

Description : Controls the set of fields returned in the GET response.

Location : query

Type : string

Enum Descriptions :

• Basic certificate information, including applicable domains and expiration date.
• The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.

Enum :

• BASIC_CERTIFICATE
• FULL_CERTIFICATE

Parameter Order :

• projectsId
• locationsId
• applicationsId
• authorizedCertificatesId

Scopes :

• https://www.googleapis.com/auth/appengine.admin
• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

Description : Gets the specified SSL certificate.

▼ ▲ appengine.projects.locations.applications.authorizedCertificates.create

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates

HTTP Method : POST

Parameters :

projectsId

Description : Part of `parent`. Name of the parent Application resource. Example: apps/myapp.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `parent`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `parent`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

Parameter Order :

• projectsId
• locationsId
• applicationsId

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Uploads the specified SSL certificate.

▼ ▲ appengine.projects.locations.applications.authorizedCertificates.patch

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}

HTTP Method : PATCH

Parameters :

projectsId

Description : Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

authorizedCertificatesId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

updateMask

Description : Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.

Location : query

Type : string

Format : google-fieldmask

Parameter Order :

• projectsId
• locationsId
• applicationsId
• authorizedCertificatesId

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

▼ ▲ appengine.projects.locations.applications.authorizedCertificates.delete

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}

HTTP Method : DELETE

Parameters :

projectsId

Description : Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

authorizedCertificatesId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

Parameter Order :

• projectsId
• locationsId
• applicationsId
• authorizedCertificatesId

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Deletes the specified SSL certificate.

▼ ▲ appengine.projects.locations.applications.domainMappings.get

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}

HTTP Method : GET

Parameters :

projectsId

Description : Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

domainMappingsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

Parameter Order :

• projectsId
• locationsId
• applicationsId
• domainMappingsId

Scopes :

• https://www.googleapis.com/auth/appengine.admin
• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

Description : Gets the specified domain mapping.

▼ ▲ appengine.projects.locations.applications.services.patch

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}

HTTP Method : PATCH

Parameters :

projectsId

Description : Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

servicesId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

updateMask

Description : Required. Standard field mask for the set of fields to be updated.

Location : query

Type : string

Format : google-fieldmask

migrateTraffic

Description : Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).

Location : query

Type : boolean

Parameter Order :

• projectsId
• locationsId
• applicationsId
• servicesId

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Updates the configuration of the specified service.

▼ ▲ appengine.projects.locations.applications.domainMappings.get

Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}

Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}

HTTP Method : GET

Parameters :

projectsId

Description : Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.

Location : path

Required : Yes

Type : string

locationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

applicationsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

domainMappingsId

Description : Part of `name`. See documentation of `projectsId`.

Location : path

Required : Yes

Type : string

Parameter Order :

• projectsId
• locationsId
• applicationsId
• domainMappingsId

Scopes :

• https://www.googleapis.com/auth/appengine.admin
• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

Description : Gets the specified domain mapping.