Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 43. Network Graph Service

43.1. Network Graph Service
Copy link

43.1.1. CreateExternalNetworkEntity
Copy link

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

43.1.1.1. Description
Copy link

43.1.1.2. Parameters
Copy link

43.1.1.2.1. Path Parameters
Copy link
Expand
NameDescriptionRequiredDefaultPattern

clusterId

 

X

null

 
43.1.1.2.2. Body Parameter
Copy link
Expand
NameDescriptionRequiredDefaultPattern

body

NetworkGraphServiceCreateExternalNetworkEntityBody

X

  

43.1.1.3. Return Type
Copy link

StorageNetworkEntity

43.1.1.4. Content Type
Copy link

  • application/json

43.1.1.5. Responses
Copy link

Expand
Table 43.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageNetworkEntity

0

An unexpected error response.

GooglerpcStatus

43.1.1.6. Samples
Copy link

43.1.2. DeleteExternalNetworkEntity
Copy link

DELETE /v1/networkgraph/externalentities/{id}

43.1.2.1. Description
Copy link

43.1.2.2. Parameters
Copy link

43.1.2.2.1. Path Parameters
Copy link
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

43.1.2.3. Return Type
Copy link

Object

43.1.2.4. Content Type
Copy link

  • application/json

43.1.2.5. Responses
Copy link

Expand
Table 43.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

43.1.2.6. Samples
Copy link

43.1.3. GetExternalNetworkEntities
Copy link

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

43.1.3.1. Description
Copy link

43.1.3.2. Parameters
Copy link

43.1.3.2.1. Path Parameters
Copy link
Expand
NameDescriptionRequiredDefaultPattern

clusterId

 

X

null

 
43.1.3.2.2. Query Parameters
Copy link
Expand
NameDescriptionRequiredDefaultPattern

query

 

-

null

 

43.1.3.3. Return Type
Copy link

V1GetExternalNetworkEntitiesResponse

43.1.3.4. Content Type
Copy link

  • application/json

43.1.3.5. Responses
Copy link

Expand
Table 43.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetExternalNetworkEntitiesResponse

0

An unexpected error response.

GooglerpcStatus

43.1.3.6. Samples
Copy link

43.1.4. GetExternalNetworkFlows
Copy link

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

43.1.4.1. Description
Copy link

43.1.4.2. Parameters
Copy link

43.1.4.2.1. Path Parameters
Copy link
Expand
NameDescriptionRequiredDefaultPattern

clusterId

 

X

null

 

deploymentId

 

X

null

 

43.1.4.3. Return Type
Copy link

V1GetExternalNetworkFlowsResponse

43.1.4.4. Content Type
Copy link

  • application/json

43.1.4.5. Responses
Copy link

Expand
Table 43.4. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetExternalNetworkFlowsResponse

0

An unexpected error response.

GooglerpcStatus

43.1.4.6. Samples
Copy link

43.1.5. GetNetworkGraph
Copy link

GET /v1/networkgraph/cluster/{clusterId}

43.1.5.1. Description
Copy link

43.1.5.2. Parameters
Copy link

43.1.5.2.1. Path Parameters
Copy link
Expand
NameDescriptionRequiredDefaultPattern

clusterId

 

X

null

 
43.1.5.2.2. Query Parameters
Copy link
Expand
NameDescriptionRequiredDefaultPattern

query

 

-

null

 

since

 

-

null

 

includePorts

 

-

null

 

scope.query

 

-

null

 

includePolicies

 

-

null

 

43.1.5.3. Return Type
Copy link

V1NetworkGraph

43.1.5.4. Content Type
Copy link

  • application/json

43.1.5.5. Responses
Copy link

Expand
Table 43.5. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1NetworkGraph

0

An unexpected error response.

GooglerpcStatus

43.1.5.6. Samples
Copy link

43.1.6. GetNetworkGraphConfig
Copy link

GET /v1/networkgraph/config

43.1.6.1. Description
Copy link

43.1.6.2. Parameters
Copy link

43.1.6.3. Return Type
Copy link

StorageNetworkGraphConfig

43.1.6.4. Content Type
Copy link

  • application/json

43.1.6.5. Responses
Copy link

Expand
Table 43.6. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageNetworkGraphConfig

0

An unexpected error response.

GooglerpcStatus

43.1.6.6. Samples
Copy link

43.1.7. PatchExternalNetworkEntity
Copy link

PATCH /v1/networkgraph/externalentities/{id}

43.1.7.1. Description
Copy link

43.1.7.2. Parameters
Copy link

43.1.7.2.1. Path Parameters
Copy link
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 
43.1.7.2.2. Body Parameter
Copy link
Expand
NameDescriptionRequiredDefaultPattern

body

NetworkGraphServicePatchExternalNetworkEntityBody

X

  

43.1.7.3. Return Type
Copy link

StorageNetworkEntity

43.1.7.4. Content Type
Copy link

  • application/json

43.1.7.5. Responses
Copy link

Expand
Table 43.7. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageNetworkEntity

0

An unexpected error response.

GooglerpcStatus

43.1.7.6. Samples
Copy link

43.1.8. PutNetworkGraphConfig
Copy link

PUT /v1/networkgraph/config

43.1.8.1. Description
Copy link

43.1.8.2. Parameters
Copy link

43.1.8.2.1. Body Parameter
Copy link
Expand
NameDescriptionRequiredDefaultPattern

body

V1PutNetworkGraphConfigRequest

X

  

43.1.8.3. Return Type
Copy link

StorageNetworkGraphConfig

43.1.8.4. Content Type
Copy link

  • application/json

43.1.8.5. Responses
Copy link

Expand
Table 43.8. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageNetworkGraphConfig

0

An unexpected error response.

GooglerpcStatus

43.1.8.6. Samples
Copy link

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat