Sign in

v1

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

Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. If the endpoint specifications in ConnectivityTest are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation.

post/v1/{+parent}/connectivityTests

Path parameters

parentstring required

Required. The parent resource of the Connectivity Test to create: projects/{project_id}/locations/global

Query parameters

testIdstring

Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project

Request body

namestring

Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

roundTripboolean

Whether run analysis for the return path from destination to source. Default value is false.

relatedProjectsstring[]

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

labelsobject

Resource labels to represent user-provided metadata.

updateTimestring google-datetime

Output only. The time the test's configuration was updated.

displayNamestring

Output only. The display name of a Connectivity Test.

bypassFirewallChecksboolean

Whether the analysis should skip firewall checking. Default value is false.

protocolstring

IP Protocol of the test. When not provided, "TCP" is assumed.

createTimestring google-datetime

Output only. The time the test was created.

descriptionstring

The user-supplied description of the Connectivity Test. Maximum of 512 characters.

Response

Successful response