Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
publicAdvertisedPrefixes

Patches the specified Router resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

patch/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}

Path parameters

projectstring required

Project ID for this request.

publicAdvertisedPrefixstring required

Name of the PublicAdvertisedPrefix resource to patch.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.

dnsVerificationIpstring

The address to be used for reverse DNS verification.

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

ipv6AccessType'EXTERNAL' | 'INTERNAL'

The internet access type for IPv6 Public Advertised Prefixes.

fingerprintstring byte

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update thePublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

pdpScope'GLOBAL' | 'GLOBAL_AND_REGIONAL' | 'REGIONAL'

Specifies how child public delegated prefix will be scoped. It could be one of following values:

 - `REGIONAL`: The public delegated prefix is regional only. The
 provisioning will take a few minutes.
 - `GLOBAL`: The public delegated prefix is global only. The
 provisioning will take ~4 weeks.
 - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is
  BYOIP V1 legacy prefix. This is output only value and no longer
  supported in BYOIP V2.
descriptionstring

An optional description of this resource. Provide this property when you create the resource.

sharedSecretstring

[Output Only] The shared secret to be used for reverse DNS verification.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

selfLinkstring

Output only. [Output Only] Server-defined URL for the resource.

status'ANNOUNCED_TO_INTERNET' | 'INITIAL' | 'PREFIX_CONFIGURATION_COMPLETE' | 'PREFIX_CONFIGURATION_IN_PROGRESS' | 'PREFIX_REMOVAL_IN_PROGRESS' | 'PTR_CONFIGURED' | 'READY_TO_ANNOUNCE' | 'REVERSE_DNS_LOOKUP_FAILED' | 'VALIDATED'

The status of the public advertised prefix. Possible values include:

 - `INITIAL`: RPKI validation is complete.
 - `PTR_CONFIGURED`: User has configured the PTR.
 - `VALIDATED`: Reverse DNS lookup is successful.
 - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed.
 - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being
 configured.
 - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured.
 - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.
idstring uint64

Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.

ipCidrRangestring

The address range, in CIDR format, represented by this public advertised prefix.

byoipApiVersion'V1' | 'V2'

Output only. [Output Only] The version of BYOIP API.

Response

Successful response