Chapter 43. Network Graph Service

43.1.1. CreateExternalNetworkEntity

POST /v1/networkgraph/cluster/{clusterId}/externalentities

43.1.1.1. Description

43.1.1.2. Parameters

43.1.1.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null

43.1.1.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	NetworkGraphServiceCreateExternalNetworkEntityBody	X

43.1.1.3. Return Type

StorageNetworkEntity

43.1.1.4. Content Type

application/json

43.1.1.5. Responses

Table 43.1. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	StorageNetworkEntity
0	An unexpected error response.	GooglerpcStatus

43.1.1.6. Samples

43.1.2. DeleteExternalNetworkEntity

DELETE /v1/networkgraph/externalentities/{id}

43.1.2.1. Description

43.1.2.2. Parameters

43.1.2.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

43.1.2.3. Return Type

Object

43.1.2.4. Content Type

application/json

43.1.2.5. Responses

Table 43.2. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	GooglerpcStatus

43.1.2.6. Samples

43.1.3. GetExternalNetworkEntities

GET /v1/networkgraph/cluster/{clusterId}/externalentities

43.1.3.1. Description

43.1.3.2. Parameters

43.1.3.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null

43.1.3.2.2. Query Parameters

Name	Description	Required	Default	Pattern
query		-	null

43.1.3.3. Return Type

V1GetExternalNetworkEntitiesResponse

43.1.3.4. Content Type

application/json

43.1.3.5. Responses

Table 43.3. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetExternalNetworkEntitiesResponse
0	An unexpected error response.	GooglerpcStatus

43.1.3.6. Samples

43.1.4. GetExternalNetworkFlows

GET /v1/networkgraph/cluster/{clusterId}/externalentities/flows/{deploymentId}

43.1.4.1. Description

43.1.4.2. Parameters

43.1.4.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null
deploymentId		X	null

43.1.4.3. Return Type

V1GetExternalNetworkFlowsResponse

43.1.4.4. Content Type

application/json

43.1.4.5. Responses

Table 43.4. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetExternalNetworkFlowsResponse
0	An unexpected error response.	GooglerpcStatus

43.1.4.6. Samples

43.1.5. GetNetworkGraph

GET /v1/networkgraph/cluster/{clusterId}

43.1.5.1. Description

43.1.5.2. Parameters

43.1.5.2.1. Path Parameters

Name	Description	Required	Default	Pattern
clusterId		X	null

43.1.5.2.2. Query Parameters

Name	Required	Default
query	-	null
since	-	null
includePorts	-	null
scope.query	-	null
includePolicies	-	null

43.1.5.3. Return Type

V1NetworkGraph

43.1.5.4. Content Type

application/json

43.1.5.5. Responses

Table 43.5. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1NetworkGraph
0	An unexpected error response.	GooglerpcStatus

43.1.5.6. Samples

43.1.6. GetNetworkGraphConfig

GET /v1/networkgraph/config

43.1.6.1. Description

43.1.6.2. Parameters

43.1.6.3. Return Type

StorageNetworkGraphConfig

43.1.6.4. Content Type

application/json

43.1.6.5. Responses

Table 43.6. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	StorageNetworkGraphConfig
0	An unexpected error response.	GooglerpcStatus

43.1.6.6. Samples

43.1.7. PatchExternalNetworkEntity

PATCH /v1/networkgraph/externalentities/{id}

43.1.7.1. Description

43.1.7.2. Parameters

43.1.7.2.1. Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

43.1.7.2.2. Body Parameter

Name	Description	Required	Default	Pattern
body	NetworkGraphServicePatchExternalNetworkEntityBody	X

43.1.7.3. Return Type