v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13213566.0 KB
projects

Creates a new CustomRange in a given project and location.

post/v1alpha/{+parent}/customRanges

Path parameters

parentstring required

Required. The parent resource name where the CustomRange will be created.

Query parameters

customRangeIdstring

Required. The ID to use for the CustomRange, which will become the final segment of the resource name.

requestIdstring

Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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

descriptionstring

Optional. The description of the CustomRange.

ipv4CidrRangestring

Optional. The IPv4 CIDR range of the CustomRange.

ipv6CidrRangestring

Optional. The IPv6 CIDR range of the CustomRange.

parentRangestring

Optional. The resource name of the parent CustomRange, in the format projects/{project}/locations/{location}/customRanges/{custom_range}. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the realm field, as the Realm is inherited from the parent CustomRange.

registryBookstring

Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.

labelsobject

Optional. User-defined labels.

namestring

Required. Identifier. The resource name of the CustomRange, in the format projects/{project}/locations/{location}/customRanges/{custom_range}.

realmstring

Optional. The resource name of the Realm associated with the CustomRange, in the format projects/{project}/locations/{location}/realms/{realm}. The Realm must be in the same project as the CustomRange. This field must not be set if the parent_range field is set, as the Realm will be inherited from the parent CustomRange.

Response

Successful response